io.rsocket.framing

Class MetadataPushFrame

java.lang.Object

io.rsocket.framing.MetadataPushFrame

All Implemented Interfaces:

Frame, MetadataFrame, Disposable

public final class MetadataPushFrame
extends Object

An RSocket METADATA_PUSH frame.

See Also:

Metadata Push 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
static MetadataPushFrame	createMetadataPushFrame(ByteBuf byteBuf) Creates the METADATA_PUSH frame.
static MetadataPushFrame	createMetadataPushFrame(ByteBufAllocator byteBufAllocator, ByteBuf metadata) Creates the METADATA_PUSH frame.
static MetadataPushFrame	createMetadataPushFrame(ByteBufAllocator byteBufAllocator, String metadata) Creates the METADATA_PUSH frame.
void	dispose()
boolean	equals(Object o)
FrameType	getFrameType() Returns the FrameType.
ByteBuf	getUnsafeFrame() Returns the frame directly.
ByteBuf	getUnsafeMetadata() Returns the metadata directly.
int	hashCode()
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.Frame

consumeFrame, getFrameType, getUnsafeFrame, mapFrame

Methods inherited from interface reactor.core.Disposable

dispose, isDisposed

Method Detail

createMetadataPushFrame

public static MetadataPushFrame createMetadataPushFrame(ByteBuf byteBuf)

Creates the METADATA_PUSH frame.

Parameters:

byteBuf - the ByteBuf representing the frame

Returns:

the METADATA_PUSH frame.

Throws:

NullPointerException - if byteBuf is null

createMetadataPushFrame

public static MetadataPushFrame createMetadataPushFrame(ByteBufAllocator byteBufAllocator,
                                                        String metadata)

Creates the METADATA_PUSH frame.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

metadata - the metadata

Returns:

the METADATA_PUSH frame

Throws:

NullPointerException - if byteBufAllocator or metadata is null

createMetadataPushFrame

public static MetadataPushFrame createMetadataPushFrame(ByteBufAllocator byteBufAllocator,
                                                        ByteBuf metadata)

Creates the METADATA_PUSH frame.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

metadata - the metadata

Returns:

the METADATA_PUSH frame

Throws:

NullPointerException - if byteBufAllocator or metadata is null

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)

toString

public String toString()

Overrides:

toString in class Object

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