io.rsocket.framing

Interface DataFrame

All Superinterfaces:

Disposable, Frame

All Known Subinterfaces:

FragmentableFrame, MetadataAndDataFrame

All Known Implementing Classes:

ErrorFrame, ExtensionFrame, KeepaliveFrame, PayloadFrame, RequestChannelFrame, RequestFireAndForgetFrame, RequestResponseFrame, RequestStreamFrame, SetupFrame

public interface DataFrame
extends Frame

An RSocket frame that only contains data.

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
default String	getDataAsUtf8() Returns the data as a UTF-8 String.
default int	getDataLength() Returns the length of the data in the frame.
ByteBuf	getUnsafeData() Returns the data directly.
default <T> T	mapData(Function<ByteBuf,T> function) Exposes the data for mapping to a different type.

Methods inherited from interface io.rsocket.framing.Frame

consumeFrame, getFrameType, getUnsafeFrame, mapFrame

Methods inherited from interface reactor.core.Disposable

dispose, isDisposed

Method Detail

getDataAsUtf8

default String getDataAsUtf8()

Returns the data as a UTF-8 String.

Returns:

the data as a UTF-8 String

getDataLength

default int getDataLength()

Returns the length of the data in the frame.

Returns:

the length of the data in the frame

getUnsafeData

ByteBuf getUnsafeData()

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:

getDataAsUtf8(), mapData(Function)

mapData

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

Exposes the data for mapping to a different type.

Type Parameters:

T - the different type

Parameters:

function - the function to transform the data to a different type

Returns:

the data mapped to a different type

Throws:

NullPointerException - if function is null