public class Framing$
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static Framing$ |
MODULE$
Static reference to the singleton instance of this Scala object.
|
Constructor and Description |
---|
Framing$() |
Modifier and Type | Method and Description |
---|---|
Flow<ByteString,ByteString,NotUsed> |
delimiter(ByteString delimiter,
int maximumFrameLength,
boolean allowTruncation)
Creates a Flow that handles decoding a stream of unstructured byte chunks into a stream of frames where the
incoming chunk stream uses a specific byte-sequence to mark frame boundaries.
|
Flow<ByteString,ByteString,NotUsed> |
lengthField(int fieldLength,
int fieldOffset,
int maximumFrameLength,
java.nio.ByteOrder byteOrder)
Creates a Flow that decodes an incoming stream of unstructured byte chunks into a stream of frames, assuming that
incoming frames have a field that encodes their length.
|
Flow<ByteString,ByteString,NotUsed> |
lengthField(int fieldLength,
int fieldOffset,
int maximumFrameLength,
java.nio.ByteOrder byteOrder,
scala.Function2<byte[],java.lang.Object,java.lang.Object> computeFrameSize)
Creates a Flow that decodes an incoming stream of unstructured byte chunks into a stream of frames, assuming that
incoming frames have a field that encodes their length.
|
BidiFlow<ByteString,ByteString,ByteString,ByteString,NotUsed> |
simpleFramingProtocol(int maximumMessageLength)
Returns a BidiFlow that implements a simple framing protocol.
|
Flow<ByteString,ByteString,NotUsed> |
simpleFramingProtocolDecoder(int maximumMessageLength)
Protocol decoder that is used by
Framing.simpleFramingProtocol(int) |
Flow<ByteString,ByteString,NotUsed> |
simpleFramingProtocolEncoder(int maximumMessageLength)
Protocol encoder that is used by
Framing.simpleFramingProtocol(int) |
public static final Framing$ MODULE$
public Flow<ByteString,ByteString,NotUsed> delimiter(ByteString delimiter, int maximumFrameLength, boolean allowTruncation)
The decoded frames will not include the separator sequence.
If there are buffered bytes (an incomplete frame) when the input stream finishes and ''allowTruncation'' is set to false then this Flow will fail the stream reporting a truncated frame.
delimiter
- The byte sequence to be treated as the end of the frame.allowTruncation
- If false
, then when the last frame being decoded contains no valid delimiter this Flow
fails the stream instead of returning a truncated frame.maximumFrameLength
- The maximum length of allowed frames while decoding. If the maximum length is
exceeded this Flow will fail the stream.public Flow<ByteString,ByteString,NotUsed> lengthField(int fieldLength, int fieldOffset, int maximumFrameLength, java.nio.ByteOrder byteOrder)
If the input stream finishes before the last frame has been fully decoded, this Flow will fail the stream reporting a truncated frame.
fieldLength
- The length of the "size" field in bytesfieldOffset
- The offset of the field from the beginning of the frame in bytesmaximumFrameLength
- The maximum length of allowed frames while decoding. If the maximum length is exceeded
this Flow will fail the stream. This length *includes* the header (i.e the offset and
the length of the size field)byteOrder
- The ''ByteOrder'' to be used when decoding the fieldpublic Flow<ByteString,ByteString,NotUsed> lengthField(int fieldLength, int fieldOffset, int maximumFrameLength, java.nio.ByteOrder byteOrder, scala.Function2<byte[],java.lang.Object,java.lang.Object> computeFrameSize)
If the input stream finishes before the last frame has been fully decoded, this Flow will fail the stream reporting a truncated frame.
fieldLength
- The length of the "size" field in bytesfieldOffset
- The offset of the field from the beginning of the frame in bytesmaximumFrameLength
- The maximum length of allowed frames while decoding. If the maximum length is exceeded
this Flow will fail the stream. This length *includes* the header (i.e the offset and
the length of the size field)byteOrder
- The ''ByteOrder'' to be used when decoding the fieldcomputeFrameSize
- This function can be supplied if frame size is varied or needs to be computed in a special fashion.
For example, frame can have a shape like this: [offset bytes][body size bytes][body bytes][footer bytes]
.
Then computeFrameSize can be used to compute the frame size: (offset bytes, computed size) => (actual frame size)
.
''Actual frame size'' must be equal or bigger than sum of fieldOffset
and fieldLength
, the stage fails otherwise.
public BidiFlow<ByteString,ByteString,ByteString,ByteString,NotUsed> simpleFramingProtocol(int maximumMessageLength)
Framing.lengthField(int, int, int, java.nio.ByteOrder)
and simply attaches a length field header of four bytes (using big endian encoding) to outgoing messages, and decodes
such messages in the inbound direction. The decoded messages do not contain the header.
This BidiFlow is useful if a simple message framing protocol is needed (for example when TCP is used to send individual messages) but no compatibility with existing protocols is necessary.
The encoded frames have the layout
[4 bytes length field, Big Endian][User Payload]
The length field encodes the length of the user payload excluding the header itself.
maximumMessageLength
- Maximum length of allowed messages. If sent or received messages exceed the configured
limit this BidiFlow will fail the stream. The header attached by this BidiFlow are not
included in this limit.public Flow<ByteString,ByteString,NotUsed> simpleFramingProtocolDecoder(int maximumMessageLength)
Framing.simpleFramingProtocol(int)
maximumMessageLength
- (undocumented)public Flow<ByteString,ByteString,NotUsed> simpleFramingProtocolEncoder(int maximumMessageLength)
Framing.simpleFramingProtocol(int)
maximumMessageLength
- (undocumented)