io.rsocket.framing

Class KeepaliveFrame

java.lang.Object

io.rsocket.framing.KeepaliveFrame

All Implemented Interfaces:

DataFrame, Frame, Disposable

public final class KeepaliveFrame
extends Object

An RSocket KEEPALIVE frame.

See Also:

Keeplive 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 KeepaliveFrame	createKeepaliveFrame(ByteBuf byteBuf) Creates the KEEPALIVE frame.
static KeepaliveFrame	createKeepaliveFrame(ByteBufAllocator byteBufAllocator, boolean respond, long lastReceivedPosition, ByteBuf data) Creates the KEEPALIVE frame.
void	dispose()
boolean	equals(Object o)
FrameType	getFrameType() Returns the FrameType.
long	getLastReceivedPosition() Returns the last received position.
ByteBuf	getUnsafeData() Returns the data directly.
ByteBuf	getUnsafeFrame() Returns the frame directly.
int	hashCode()
boolean	isRespondFlagSet() Returns whether the respond 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.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

createKeepaliveFrame

public static KeepaliveFrame createKeepaliveFrame(ByteBuf byteBuf)

Creates the KEEPALIVE frame.

Parameters:

byteBuf - the ByteBuf representing the frame

Returns:

the KEEPALIVE frame.

Throws:

NullPointerException - if byteBuf is null

createKeepaliveFrame

public static KeepaliveFrame createKeepaliveFrame(ByteBufAllocator byteBufAllocator,
                                                  boolean respond,
                                                  long lastReceivedPosition,
                                                  @Nullable
                                                  ByteBuf data)

Creates the KEEPALIVE frame.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

respond - whether to set the Respond flag

lastReceivedPosition - the last received position

data - the frame data

Returns:

the KEEPALIVE frame

Throws:

NullPointerException - if byteBufAllocator is null

getLastReceivedPosition

public long getLastReceivedPosition()

Returns the last received position.

Returns:

the last received position

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)

isRespondFlagSet

public boolean isRespondFlagSet()

Returns whether the respond flag is set.

Returns:

whether the respond 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