io.rsocket.framing

Class ExtensionFrame

java.lang.Object

io.rsocket.framing.ExtensionFrame

All Implemented Interfaces:

DataFrame, Frame, MetadataAndDataFrame, MetadataFrame, Disposable

public final class ExtensionFrame
extends Object

An RSocket EXT frame.

See Also:

Extension 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 ExtensionFrame	createExtensionFrame(ByteBuf byteBuf) Creates the EXT frame.
static ExtensionFrame	createExtensionFrame(ByteBufAllocator byteBufAllocator, boolean ignore, int extendedType, ByteBuf metadata, ByteBuf data) Creates the EXT frame.
static ExtensionFrame	createExtensionFrame(ByteBufAllocator byteBufAllocator, boolean ignore, int extendedType, String metadata, String data) Creates the EXT frame.
void	dispose()
boolean	equals(Object o)
int	getExtendedType() Returns the extended type.
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	isIgnoreFlagSet() Returns whether the Ignore 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

createExtensionFrame

public static ExtensionFrame createExtensionFrame(ByteBuf byteBuf)

Creates the EXT frame.

Parameters:

byteBuf - the ByteBuf representing the frame

Returns:

the EXT frame.

Throws:

NullPointerException - if byteBuf is null

createExtensionFrame

public static ExtensionFrame createExtensionFrame(ByteBufAllocator byteBufAllocator,
                                                  boolean ignore,
                                                  int extendedType,
                                                  @Nullable
                                                  String metadata,
                                                  @Nullable
                                                  String data)

Creates the EXT frame.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

ignore - whether to set the Ignore flag

extendedType - the type of the extended frame

metadata - the metadata

data - the data

Returns:

the EXT frame

Throws:

NullPointerException - if byteBufAllocator is null

createExtensionFrame

public static ExtensionFrame createExtensionFrame(ByteBufAllocator byteBufAllocator,
                                                  boolean ignore,
                                                  int extendedType,
                                                  @Nullable
                                                  ByteBuf metadata,
                                                  @Nullable
                                                  ByteBuf data)

Creates the EXT frame.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

ignore - whether to set the Ignore flag

extendedType - the type of the extended frame

metadata - the metadata

data - the data

Returns:

the EXT frame

Throws:

NullPointerException - if byteBufAllocator is null

getExtendedType

public int getExtendedType()

Returns the extended type.

Returns:

the extended type

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)

isIgnoreFlagSet

public boolean isIgnoreFlagSet()

Returns whether the Ignore flag is set.

Returns:

whether the Ignore flag is set

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