io.rsocket.framing

Class FrameLengthFrame

java.lang.Object

io.rsocket.framing.FrameLengthFrame

All Implemented Interfaces:

Frame, Disposable

public final class FrameLengthFrame
extends Object

An RSocket frame with a frame length.

See Also:

Framing Format

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 FrameLengthFrame	createFrameLengthFrame(ByteBuf byteBuf) Creates the frame with a frame length.
static FrameLengthFrame	createFrameLengthFrame(ByteBufAllocator byteBufAllocator, Frame frame) Creates the frame with a frame length.
void	dispose()
boolean	equals(Object o)
int	getFrameLength() Returns the frame length.
FrameType	getFrameType() Returns the FrameType.
ByteBuf	getUnsafeFrame() Returns the frame directly.
ByteBuf	getUnsafeFrameWithoutFrameLength() Returns the frame without frame length directly.
int	hashCode()
<T> T	mapFrameWithoutFrameLength(Function<ByteBuf,T> function) Exposes the Frame without the frame length as a ByteBuf 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

createFrameLengthFrame

public static FrameLengthFrame createFrameLengthFrame(ByteBuf byteBuf)

Creates the frame with a frame length.

Parameters:

byteBuf - the ByteBuf representing the frame

Returns:

the frame with a frame length

Throws:

NullPointerException - if byteBuf is null

createFrameLengthFrame

public static FrameLengthFrame createFrameLengthFrame(ByteBufAllocator byteBufAllocator,
                                                      Frame frame)

Creates the frame with a frame length.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

frame - the frame to prepend the frame length to

Returns:

the frame with a frame length

Throws:

NullPointerException - if byteBufAllocator or frame is null

getFrameLength

public int getFrameLength()

Returns the frame length.

Returns:

the frame length

getUnsafeFrameWithoutFrameLength

public ByteBuf getUnsafeFrameWithoutFrameLength()

Returns the frame without frame length directly.

Note: this frame without frame length 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 without frame length if you store it.

Returns:

the frame without frame length directly

See Also:

mapFrameWithoutFrameLength(Function)

mapFrameWithoutFrameLength

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

Exposes the Frame without the frame length as a ByteBuf for mapping to a different type.

Type Parameters:

T - the different type

Parameters:

function - the function to transform the Frame without the frame length as a ByteBuf to a different type

Returns:

the Frame without the frame length as a ByteBuf 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