io.rsocket.framing

Class ResumeFrame

java.lang.Object

io.rsocket.framing.ResumeFrame

All Implemented Interfaces:

Frame, Disposable

public final class ResumeFrame
extends Object

An RSocket RESUME frame.

See Also:

Resume 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 ResumeFrame	createResumeFrame(ByteBuf byteBuf) Creates the RESUME frame.
static ResumeFrame	createResumeFrame(ByteBufAllocator byteBufAllocator, ByteBuf resumeIdentificationToken, long lastReceivedServerPosition, long firstAvailableClientPosition) Creates the RESUME frame.
static ResumeFrame	createResumeFrame(ByteBufAllocator byteBufAllocator, int majorVersion, int minorVersion, ByteBuf resumeIdentificationToken, long lastReceivedServerPosition, long firstAvailableClientPosition) Creates the RESUME frame.
static ResumeFrame	createResumeFrame(ByteBufAllocator byteBufAllocator, String resumeIdentificationToken, long lastReceivedServerPosition, long firstAvailableClientPosition) Creates the RESUME frame.
void	dispose()
boolean	equals(Object o)
long	getFirstAvailableClientPosition() Returns the first available client position.
FrameType	getFrameType() Returns the FrameType.
long	getLastReceivedServerPosition() Returns the last received server position.
int	getMajorVersion() Returns the major version of the protocol.
int	getMinorVersion() Returns the minor version of the protocol.
String	getResumeIdentificationTokenAsUtf8() Returns the resume identification token as a UTF-8 String.
ByteBuf	getUnsafeFrame() Returns the frame directly.
ByteBuf	getUnsafeResumeIdentificationToken() Returns the resume identification token directly.
int	hashCode()
<T> 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.Frame

consumeFrame, mapFrame

Methods inherited from interface reactor.core.Disposable

isDisposed

Method Detail

createResumeFrame

public static ResumeFrame createResumeFrame(ByteBufAllocator byteBufAllocator,
                                            String resumeIdentificationToken,
                                            long lastReceivedServerPosition,
                                            long firstAvailableClientPosition)

Creates the RESUME frame.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

resumeIdentificationToken - the resume identification token

lastReceivedServerPosition - the last received server position

firstAvailableClientPosition - the first available client position

Returns:

the RESUME frame

Throws:

NullPointerException - if byteBufAllocator or resumeIdentificationToken is null

createResumeFrame

public static ResumeFrame createResumeFrame(ByteBufAllocator byteBufAllocator,
                                            ByteBuf resumeIdentificationToken,
                                            long lastReceivedServerPosition,
                                            long firstAvailableClientPosition)

Creates the RESUME frame.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

resumeIdentificationToken - the resume identification token

lastReceivedServerPosition - the last received server position

firstAvailableClientPosition - the first available client position

Returns:

the RESUME frame

Throws:

NullPointerException - if byteBufAllocator or resumeIdentificationToken is null

createResumeFrame

public static ResumeFrame createResumeFrame(ByteBuf byteBuf)

Creates the RESUME frame.

Parameters:

byteBuf - the ByteBuf representing the frame

Returns:

the RESUME frame.

Throws:

NullPointerException - if byteBuf is null

createResumeFrame

public static ResumeFrame createResumeFrame(ByteBufAllocator byteBufAllocator,
                                            int majorVersion,
                                            int minorVersion,
                                            ByteBuf resumeIdentificationToken,
                                            long lastReceivedServerPosition,
                                            long firstAvailableClientPosition)

Creates the RESUME frame.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

majorVersion - the major version of the protocol

minorVersion - the minor version of the protocol

resumeIdentificationToken - the resume identification token

lastReceivedServerPosition - the last received server position

firstAvailableClientPosition - the first available client position

Returns:

the RESUME frame

Throws:

NullPointerException - if byteBufAllocator or resumeIdentificationToken is null

getFirstAvailableClientPosition

public long getFirstAvailableClientPosition()

Returns the first available client position.

Returns:

the first available client position

getLastReceivedServerPosition

public long getLastReceivedServerPosition()

Returns the last received server position.

Returns:

the last received server position

getMajorVersion

public int getMajorVersion()

Returns the major version of the protocol.

Returns:

the major version of the protocol

getMinorVersion

public int getMinorVersion()

Returns the minor version of the protocol.

Returns:

the minor version of the protocol

getResumeIdentificationTokenAsUtf8

public String getResumeIdentificationTokenAsUtf8()

Returns the resume identification token as a UTF-8 String.

Returns:

the resume identification token as a UTF-8 String

getUnsafeResumeIdentificationToken

public ByteBuf getUnsafeResumeIdentificationToken()

Returns the resume identification token directly.

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

See Also:

mapResumeIdentificationToken(Function)

mapResumeIdentificationToken

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

Exposes the resume identification token for mapping to a different type.

Type Parameters:

T - the different type

Parameters:

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

Returns:

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