io.rsocket.frame

Class FrameHeaderCodec

java.lang.Object

io.rsocket.frame.FrameHeaderCodec

public final class FrameHeaderCodec
extends Object

Per connection frame flyweight.

Not the latest frame layout, but close. Does not include - fragmentation / reassembly - encode should remove Type param and have it as part of method name (1 encode per type?)

Not thread-safe. Assumed to be used single-threaded

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISABLE_FRAME_TYPE_CHECK
static int	FLAGS_C (C)omplete: bit to indicate stream completion (Subscriber.onComplete())
static int	FLAGS_F (F)ollows: More fragments follow this fragment (in case of fragmented REQUEST_x or PAYLOAD frames)
static int	FLAGS_I (I)gnore flag: a value of 0 indicates the protocol can't ignore this frame
static int	FLAGS_M (M)etadata flag: a value of 1 indicates the frame contains metadata
static int	FLAGS_N (N)ext: bit to indicate payload or metadata present (Subscriber.onNext(Object))

Method Summary

Modifier and Type	Method and Description
static ByteBuf	encode(ByteBufAllocator allocator, int streamId, FrameType frameType, int flags)
static void	ensureFrameType(FrameType frameType, ByteBuf byteBuf)
static int	flags(ByteBuf byteBuf)
static FrameType	frameType(ByteBuf byteBuf)
static boolean	hasComplete(ByteBuf byteBuf)
static boolean	hasFollows(ByteBuf byteBuf)
static boolean	hasMetadata(ByteBuf byteBuf)
static FrameType	nativeFrameType(ByteBuf byteBuf) faster version of frameType(ByteBuf) which does not replace PAYLOAD with synthetic type
static int	size()
static int	streamId(ByteBuf byteBuf)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FLAGS_I

public static final int FLAGS_I

(I)gnore flag: a value of 0 indicates the protocol can't ignore this frame

See Also:

Constant Field Values

FLAGS_M

public static final int FLAGS_M

(M)etadata flag: a value of 1 indicates the frame contains metadata

See Also:

Constant Field Values

FLAGS_F

public static final int FLAGS_F

(F)ollows: More fragments follow this fragment (in case of fragmented REQUEST_x or PAYLOAD frames)

See Also:

Constant Field Values

FLAGS_C

public static final int FLAGS_C

(C)omplete: bit to indicate stream completion (Subscriber.onComplete())

See Also:

Constant Field Values

FLAGS_N

public static final int FLAGS_N

(N)ext: bit to indicate payload or metadata present (Subscriber.onNext(Object))

See Also:

Constant Field Values

DISABLE_FRAME_TYPE_CHECK

public static final String DISABLE_FRAME_TYPE_CHECK

See Also:

Constant Field Values

Method Detail

encode

public static ByteBuf encode(ByteBufAllocator allocator,
                             int streamId,
                             FrameType frameType,
                             int flags)

hasFollows

public static boolean hasFollows(ByteBuf byteBuf)

hasComplete

public static boolean hasComplete(ByteBuf byteBuf)

streamId

public static int streamId(ByteBuf byteBuf)

flags

public static int flags(ByteBuf byteBuf)

hasMetadata

public static boolean hasMetadata(ByteBuf byteBuf)

nativeFrameType

public static FrameType nativeFrameType(ByteBuf byteBuf)

faster version of frameType(ByteBuf) which does not replace PAYLOAD with synthetic type

frameType

public static FrameType frameType(ByteBuf byteBuf)

ensureFrameType

public static void ensureFrameType(FrameType frameType,
                                   ByteBuf byteBuf)

size

public static int size()