io.rsocket.framing

Class PayloadFrame

java.lang.Object

io.rsocket.framing.PayloadFrame

All Implemented Interfaces:

DataFrame, FragmentableFrame, Frame, MetadataAndDataFrame, MetadataFrame, Disposable

public final class PayloadFrame
extends Object

An RSocket PAYLOAD frame.

See Also:

Payload Frame

Nested Class Summary

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

Disposable.Composite, Disposable.Swap

Field Summary

Fields inherited from interface io.rsocket.framing.Frame

FRAME_TYPE_SHIFT

Method Summary

Modifier and Type	Method and Description
PayloadFrame	createFragment(ByteBufAllocator byteBufAllocator, ByteBuf metadata, ByteBuf data) Generates the fragment for this frame.
PayloadFrame	createNonFragment(ByteBufAllocator byteBufAllocator, ByteBuf metadata, ByteBuf data) Generates the non-fragment for this frame.
static PayloadFrame	createPayloadFrame(ByteBuf byteBuf) Creates the PAYLOAD frame.
static PayloadFrame	createPayloadFrame(ByteBufAllocator byteBufAllocator, boolean follows, boolean complete, ByteBuf metadata, ByteBuf data) Creates the PAYLOAD frame.
static PayloadFrame	createPayloadFrame(ByteBufAllocator byteBufAllocator, boolean follows, boolean complete, String metadata, String data) Creates the PAYLOAD frame.
void	dispose()
boolean	equals(Object o)
FrameType	getFrameType() Returns the FrameType.
ByteBuf	getUnsafeData() Returns the data directly.
ByteBuf	getUnsafeFrame() Returns the frame directly.
ByteBuf	getUnsafeMetadata() Returns the metadata directly.
int	hashCode()
boolean	isCompleteFlagSet() Returns whether the Complete flag is set.
boolean	isFollowsFlagSet() Returns whether the Follows flag is set.
boolean	isNextFlagSet() Returns whether the Next flag is set.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.rsocket.framing.MetadataFrame

getMetadataAsUtf8, getMetadataLength, getUnsafeMetadataAsUtf8, getUnsafeMetadataLength, mapMetadata

Methods inherited from interface io.rsocket.framing.DataFrame

getDataAsUtf8, getDataLength, mapData

Methods inherited from interface io.rsocket.framing.Frame

consumeFrame, getFrameType, getUnsafeFrame, mapFrame

Methods inherited from interface reactor.core.Disposable

dispose, isDisposed

Method Detail

createPayloadFrame

public static PayloadFrame createPayloadFrame(ByteBuf byteBuf)

Creates the PAYLOAD frame.

Parameters:

byteBuf - the ByteBuf representing the frame

Returns:

the PAYLOAD frame.

Throws:

NullPointerException - if byteBuf is null

createPayloadFrame

public static PayloadFrame createPayloadFrame(ByteBufAllocator byteBufAllocator,
                                              boolean follows,
                                              boolean complete,
                                              @Nullable
                                              String metadata,
                                              @Nullable
                                              String data)

Creates the PAYLOAD frame.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

follows - whether to set the Follows flag

complete - respond whether to set the Complete flag

metadata - the metadata

data - the data

Returns:

the PAYLOAD frame

Throws:

NullPointerException - if byteBufAllocator is null

createPayloadFrame

public static PayloadFrame createPayloadFrame(ByteBufAllocator byteBufAllocator,
                                              boolean follows,
                                              boolean complete,
                                              @Nullable
                                              ByteBuf metadata,
                                              @Nullable
                                              ByteBuf data)

Creates the PAYLOAD frame.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

follows - respond whether to set the Follows flag

complete - respond whether to set the Complete flag

metadata - the metadata

data - the data

Returns:

the PAYLOAD frame

Throws:

NullPointerException - if byteBufAllocator is null

createFragment

public PayloadFrame createFragment(ByteBufAllocator byteBufAllocator,
                                   @Nullable
                                   ByteBuf metadata,
                                   @Nullable
                                   ByteBuf data)

Description copied from interface: FragmentableFrame

Generates the fragment for this frame.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

metadata - the metadata

data - the data

Returns:

the fragment for this frame

createNonFragment

public PayloadFrame createNonFragment(ByteBufAllocator byteBufAllocator,
                                      @Nullable
                                      ByteBuf metadata,
                                      @Nullable
                                      ByteBuf data)

Description copied from interface: FragmentableFrame

Generates the non-fragment for this frame.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

metadata - the metadata

data - the data

Returns:

the non-fragment for this frame

getUnsafeData

public ByteBuf getUnsafeData()

Description copied from interface: DataFrame

Returns the data directly.

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

Returns:

the data directly

See Also:

DataFrame.getDataAsUtf8(), DataFrame.mapData(Function)

getUnsafeMetadata

@Nullable
public ByteBuf getUnsafeMetadata()

Description copied from interface: MetadataFrame

Returns the metadata directly. If the Metadata flag is not set, returns null.

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

Returns:

the metadata directly, or null if the Metadata flag is not set

See Also:

MetadataFrame.getMetadataAsUtf8(), MetadataFrame.mapMetadata(Function)

isCompleteFlagSet

public boolean isCompleteFlagSet()

Returns whether the Complete flag is set.

Returns:

whether the Complete flag is set

isNextFlagSet

public boolean isNextFlagSet()

Returns whether the Next flag is set.

Returns:

whether the Next flag is set

toString

public String toString()

Overrides:

toString in class Object

isFollowsFlagSet

public final boolean isFollowsFlagSet()

Description copied from interface: FragmentableFrame

Returns whether the Follows flag is set.

Specified by:

isFollowsFlagSet in interface FragmentableFrame

Returns:

whether the Follows flag is set

dispose

public final void dispose()

Specified by:

dispose in interface Disposable

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getFrameType

public FrameType getFrameType()

Description copied from interface: Frame

Returns the FrameType.

Specified by:

getFrameType in interface Frame

Returns:

the FrameType

getUnsafeFrame

public final ByteBuf getUnsafeFrame()

Description copied from interface: Frame

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.

Specified by:

getUnsafeFrame in interface Frame

Returns:

the frame directly

See Also:

Frame.consumeFrame(Consumer), Frame.mapFrame(Function)

hashCode

public int hashCode()

Overrides:

hashCode in class Object