io.rsocket.framing

Class SetupFrame

java.lang.Object

io.rsocket.framing.SetupFrame

All Implemented Interfaces:

DataFrame, Frame, MetadataAndDataFrame, MetadataFrame, Disposable

public final class SetupFrame
extends Object

An RSocket SETUP frame.

See Also:

Setup 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 SetupFrame	createSetupFrame(ByteBuf byteBuf) Creates the SETUP frame.
static SetupFrame	createSetupFrame(ByteBufAllocator byteBufAllocator, boolean lease, Duration keepAliveInterval, Duration maxLifetime, ByteBuf resumeIdentificationToken, String metadataMimeType, String dataMimeType, ByteBuf metadata, ByteBuf data) Creates the SETUP frame.
static SetupFrame	createSetupFrame(ByteBufAllocator byteBufAllocator, boolean lease, Duration keepAliveInterval, Duration maxLifetime, String resumeIdentificationToken, String metadataMimeType, String dataMimeType, String metadata, String data) Creates the SETUP frame.
static SetupFrame	createSetupFrame(ByteBufAllocator byteBufAllocator, boolean lease, int majorVersion, int minorVersion, Duration keepAliveInterval, Duration maxLifetime, ByteBuf resumeIdentificationToken, String metadataMimeType, String dataMimeType, ByteBuf metadata, ByteBuf data) Creates the SETUP frame.
void	dispose()
boolean	equals(Object o)
String	getDataMimeType() Returns the data MIME-type, decoded at StandardCharsets.UTF_8.
String	getDataMimeType(Charset charset) Returns the data MIME-type.
FrameType	getFrameType() Returns the FrameType.
Duration	getKeepAliveInterval() Returns the keep alive interval.
int	getMajorVersion() Returns the major version of the protocol.
Duration	getMaxLifetime() Returns the max lifetime.
String	getMetadataMimeType() Returns the metadata MIME-type, decoded at StandardCharsets.UTF_8.
String	getMetadataMimeType(Charset charset) Returns the metadata MIME-type.
int	getMinorVersion() Returns the minor version of the protocol.
Optional<String>	getResumeIdentificationTokenAsUtf8() Returns the resume identification token as a UTF-8 String.
ByteBuf	getUnsafeData() Returns the data directly.
ByteBuf	getUnsafeFrame() Returns the frame directly.
ByteBuf	getUnsafeMetadata() Returns the metadata directly.
ByteBuf	getUnsafeResumeIdentificationToken() Returns the resume identification token directly.
String	getUnsafeResumeIdentificationTokenAsUtf8() Returns the resume identification token as a UTF-8 String.
int	hashCode()
boolean	isLeaseFlagSet() Returns whether the lease flag is set.
<T> Optional<T>	mapResumeIdentificationToken(Function<ByteBuf,T> function) Exposes the resume identification token for mapping to a different type.
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

createSetupFrame

public static SetupFrame createSetupFrame(ByteBuf byteBuf)

Creates the SETUP frame.

Parameters:

byteBuf - the ByteBuf representing the frame

Returns:

the SETUP frame.

Throws:

NullPointerException - if byteBuf is null

createSetupFrame

public static SetupFrame createSetupFrame(ByteBufAllocator byteBufAllocator,
                                          boolean lease,
                                          Duration keepAliveInterval,
                                          Duration maxLifetime,
                                          @Nullable
                                          String resumeIdentificationToken,
                                          String metadataMimeType,
                                          String dataMimeType,
                                          @Nullable
                                          String metadata,
                                          @Nullable
                                          String data)

Creates the SETUP frame.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

lease - whether to set the Lease flag

keepAliveInterval - the time between KEEPALIVE frames

maxLifetime - the time between KEEPALIVE frames before the server is assumed to be dead

resumeIdentificationToken - the resume identification token

metadataMimeType - metadata MIME-type encoding

dataMimeType - data MIME-type encoding

metadata - the metadata

data - the data

Returns:

the SETUP frame

Throws:

NullPointerException - if byteBufAllocator, keepAliveInterval, maxLifetime, metadataMimeType, or dataMimeType is null

IllegalArgumentException - if keepAliveInterval or maxLifetime is not a positive duration

createSetupFrame

public static SetupFrame createSetupFrame(ByteBufAllocator byteBufAllocator,
                                          boolean lease,
                                          Duration keepAliveInterval,
                                          Duration maxLifetime,
                                          @Nullable
                                          ByteBuf resumeIdentificationToken,
                                          String metadataMimeType,
                                          String dataMimeType,
                                          @Nullable
                                          ByteBuf metadata,
                                          @Nullable
                                          ByteBuf data)

Creates the SETUP frame.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

lease - whether to set the Lease flag

keepAliveInterval - the time between KEEPALIVE frames

maxLifetime - the time between KEEPALIVE frames before the server is assumed to be dead

resumeIdentificationToken - the resume identification token

metadataMimeType - metadata MIME-type encoding

dataMimeType - data MIME-type encoding

metadata - the metadata

data - the data

Returns:

the SETUP frame

Throws:

NullPointerException - if byteBufAllocator, keepAliveInterval, maxLifetime, metadataMimeType, or dataMimeType is null

IllegalArgumentException - if keepAliveInterval or maxLifetime is not a positive duration

createSetupFrame

public static SetupFrame createSetupFrame(ByteBufAllocator byteBufAllocator,
                                          boolean lease,
                                          int majorVersion,
                                          int minorVersion,
                                          Duration keepAliveInterval,
                                          Duration maxLifetime,
                                          @Nullable
                                          ByteBuf resumeIdentificationToken,
                                          String metadataMimeType,
                                          String dataMimeType,
                                          @Nullable
                                          ByteBuf metadata,
                                          @Nullable
                                          ByteBuf data)

Creates the SETUP frame.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

lease - whether to set the Lease flag

majorVersion - the major version of the protocol

minorVersion - the minor version of the protocol

keepAliveInterval - the time between KEEPALIVE frames

maxLifetime - the time between KEEPALIVE frames before the server is assumed to be dead

resumeIdentificationToken - the resume identification token

metadataMimeType - metadata MIME-type encoding

dataMimeType - data MIME-type encoding

metadata - the metadata

data - the data

Returns:

the SETUP frame

Throws:

NullPointerException - if byteBufAllocator, keepAliveInterval, maxLifetime, metadataMimeType, or dataMimeType is null

IllegalArgumentException - if keepAliveInterval or maxLifetime is not a positive duration

getDataMimeType

public String getDataMimeType()

Returns the data MIME-type, decoded at StandardCharsets.UTF_8.

Returns:

the data MIME-type, decoded as StandardCharsets.UTF_8

getDataMimeType

public String getDataMimeType(Charset charset)

Returns the data MIME-type.

Parameters:

charset - the Charset to decode the data MIME-type with

Returns:

the data MIME-type

getKeepAliveInterval

public Duration getKeepAliveInterval()

Returns the keep alive interval.

Returns:

the keep alive interval

getMajorVersion

public int getMajorVersion()

Returns the major version of the protocol.

Returns:

the major version of the protocol

getMaxLifetime

public Duration getMaxLifetime()

Returns the max lifetime.

Returns:

the max lifetime

getMetadataMimeType

public String getMetadataMimeType()

Returns the metadata MIME-type, decoded at StandardCharsets.UTF_8.

Returns:

the metadata MIME-type, decoded as StandardCharsets.UTF_8

getMetadataMimeType

public String getMetadataMimeType(Charset charset)

Returns the metadata MIME-type.

Parameters:

charset - the Charset to decode the metadata MIME-type with

Returns:

the metadata MIME-type

getMinorVersion

public int getMinorVersion()

Returns the minor version of the protocol.

Returns:

the minor version of the protocol

getResumeIdentificationTokenAsUtf8

public Optional<String> getResumeIdentificationTokenAsUtf8()

Returns the resume identification token as a UTF-8 String. If the Resume Enabled flag is not set, returns Optional.empty().

Returns:

optionally, the resume identification token as a UTF-8 String

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)

getUnsafeResumeIdentificationToken

@Nullable
public ByteBuf getUnsafeResumeIdentificationToken()

Returns the resume identification token directly. If the Resume Enabled flag is not set, returns null.

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

Returns:

the resume identification token directly, or null if the Resume Enabled flag is not set

See Also:

mapResumeIdentificationToken(Function)

getUnsafeResumeIdentificationTokenAsUtf8

@Nullable
public String getUnsafeResumeIdentificationTokenAsUtf8()

Returns the resume identification token as a UTF-8 String. If the Resume Enabled flag is not set, returns null.

Returns:

the resume identification token as a UTF-8 String or null if the Resume Enabled flag is not set.

See Also:

getResumeIdentificationTokenAsUtf8()

isLeaseFlagSet

public boolean isLeaseFlagSet()

Returns whether the lease flag is set.

Returns:

whether the lease flag is set

mapResumeIdentificationToken

public <T> Optional<T> mapResumeIdentificationToken(Function<ByteBuf,T> function)

Exposes the resume identification token for mapping to a different type. If the Resume Enabled flag is not set, returns Optional.empty().

Type Parameters:

T - the different type

Parameters:

function - the function to transform the resume identification token to a different type

Returns:

optionally, the resume identification token mapped to a different type

Throws:

NullPointerException - if function is null

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