io.rsocket.framing

Interface MetadataFrame

All Superinterfaces:

Disposable, Frame

All Known Subinterfaces:

FragmentableFrame, MetadataAndDataFrame

All Known Implementing Classes:

ExtensionFrame, LeaseFrame, MetadataPushFrame, PayloadFrame, RequestChannelFrame, RequestFireAndForgetFrame, RequestResponseFrame, RequestStreamFrame, SetupFrame

public interface MetadataFrame
extends Frame

An RSocket frame that only contains metadata.

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 Optional<String>	getMetadataAsUtf8() Returns the metadata as a UTF-8 String.
default Optional<Integer>	getMetadataLength() Returns the length of the metadata in the frame.
ByteBuf	getUnsafeMetadata() Returns the metadata directly.
default String	getUnsafeMetadataAsUtf8() Returns the metadata as a UTF-8 String.
default Integer	getUnsafeMetadataLength() Returns the length of the metadata in the frame directly.
default <T> Optional<T>	mapMetadata(Function<ByteBuf,T> function) Exposes the metadata 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

getMetadataAsUtf8

default Optional<String> getMetadataAsUtf8()

Returns the metadata as a UTF-8 String. If the Metadata flag is not set, returns Optional.empty().

Returns:

optionally, the metadata as a UTF-8 String

getMetadataLength

default Optional<Integer> getMetadataLength()

Returns the length of the metadata in the frame. If the Metadata flag is not set, returns Optional.empty().

Returns:

optionally, the length of the metadata in the frame

getUnsafeMetadata

@Nullable
ByteBuf getUnsafeMetadata()

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:

getMetadataAsUtf8(), mapMetadata(Function)

getUnsafeMetadataAsUtf8

@Nullable
default String getUnsafeMetadataAsUtf8()

Returns the metadata as a UTF-8 String. If the Metadata flag is not set, returns null.

Returns:

the metadata as a UTF-8 String or null if the Metadata flag is not set.

See Also:

getMetadataAsUtf8()

getUnsafeMetadataLength

@Nullable
default Integer getUnsafeMetadataLength()

Returns the length of the metadata in the frame directly. If the Metadata flag is not set, returns null.

Returns:

the length of the metadata in frame directly, or null if the Metadata flag is not set

See Also:

getMetadataLength()

mapMetadata

default <T> Optional<T> mapMetadata(Function<ByteBuf,T> function)

Exposes the metadata for mapping to a different type. If the Metadata flag is not set, returns Optional.empty().

Type Parameters:

T - the different type

Parameters:

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

Returns:

optionally, the metadata mapped to a different type

Throws:

NullPointerException - if function is null