io.rsocket.framing

Interface Frame

All Superinterfaces:

Disposable

All Known Subinterfaces:

DataFrame, FragmentableFrame, MetadataAndDataFrame, MetadataFrame

All Known Implementing Classes:

CancelFrame, ErrorFrame, ExtensionFrame, FrameLengthFrame, KeepaliveFrame, LeaseFrame, MetadataPushFrame, PayloadFrame, RequestChannelFrame, RequestFireAndForgetFrame, RequestNFrame, RequestResponseFrame, RequestStreamFrame, ResumeFrame, ResumeOkFrame, SetupFrame, StreamIdFrame

public interface Frame
extends Disposable

An RSocket frame.

See Also:

Framing

Nested Class Summary

Nested classes/interfaces inherited from interface reactor.core.Disposable

Disposable.Composite, Disposable.Swap

Field Summary

Fields

Modifier and Type	Field and Description
static int	FRAME_TYPE_SHIFT The shift length for the frame type.

Method Summary

Modifier and Type	Method and Description
default void	consumeFrame(Consumer<ByteBuf> consumer) Exposes the Frame as a ByteBuf for consumption.
FrameType	getFrameType() Returns the FrameType.
ByteBuf	getUnsafeFrame() Returns the frame directly.
default <T> T	mapFrame(Function<ByteBuf,T> function) Exposes the Frame as a ByteBuf for mapping to a different type.

Methods inherited from interface reactor.core.Disposable

dispose, isDisposed

Field Detail

FRAME_TYPE_SHIFT

static final int FRAME_TYPE_SHIFT

The shift length for the frame type.

See Also:

Constant Field Values

Method Detail

consumeFrame

default void consumeFrame(Consumer<ByteBuf> consumer)

Exposes the Frame as a ByteBuf for consumption.

Parameters:

consumer - the Consumer to consume the Frame as a ByteBuf

Throws:

NullPointerException - if consumer is null

getFrameType

FrameType getFrameType()

Returns the FrameType.

Returns:

the FrameType

getUnsafeFrame

ByteBuf getUnsafeFrame()

Returns the frame directly.

Note: this frame will be outside of the Frame's lifecycle and may be released at any time. It is highly recommended that you ByteBuf.retain() the frame if you store it.

Returns:

the frame directly

See Also:

consumeFrame(Consumer), mapFrame(Function)

mapFrame

default <T> T mapFrame(Function<ByteBuf,T> function)

Exposes the Frame as a ByteBuf for mapping to a different type.

Type Parameters:

T - the different type

Parameters:

function - the Function to transform the Frame as a ByteBuf to a different type

Returns:

the Frame as a ByteBuf mapped to a different type

Throws:

NullPointerException - if function is null