io.rsocket.framing

Class StreamIdFrame

java.lang.Object

io.rsocket.framing.StreamIdFrame

All Implemented Interfaces:

Frame, Disposable

public final class StreamIdFrame
extends Object

An RSocket frame with a stream id.

See Also:

Frame Header 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 StreamIdFrame	createStreamIdFrame(ByteBuf byteBuf) Creates the frame with a stream id.
static StreamIdFrame	createStreamIdFrame(ByteBufAllocator byteBufAllocator, int streamId, Frame frame) Creates the frame with a stream id.
void	dispose()
boolean	equals(Object o)
FrameType	getFrameType() Returns the FrameType.
int	getStreamId() Returns the stream id.
ByteBuf	getUnsafeFrame() Returns the frame directly.
ByteBuf	getUnsafeFrameWithoutStreamId() Returns the frame without stream id directly.
int	hashCode()
<T> T	mapFrameWithoutStreamId(Function<ByteBuf,T> function) Exposes the Frame without the stream id 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

createStreamIdFrame

public static StreamIdFrame createStreamIdFrame(ByteBuf byteBuf)

Creates the frame with a stream id.

Parameters:

byteBuf - the ByteBuf representing the frame

Returns:

the frame with a stream id

Throws:

NullPointerException - if byteBuf is null

createStreamIdFrame

public static StreamIdFrame createStreamIdFrame(ByteBufAllocator byteBufAllocator,
                                                int streamId,
                                                Frame frame)

Creates the frame with a stream id.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

streamId - the stream id

frame - the frame to prepend the stream id to

Returns:

the frame with a stream id

Throws:

NullPointerException - if byteBufAllocator or frame is null

getStreamId

public int getStreamId()

Returns the stream id.

Returns:

the stream id

getUnsafeFrameWithoutStreamId

public ByteBuf getUnsafeFrameWithoutStreamId()

Returns the frame without stream id directly.

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

Returns:

the frame without stream id directly

See Also:

mapFrameWithoutStreamId(Function)

mapFrameWithoutStreamId

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

Exposes the Frame without the stream id 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 stream id as a ByteBuf to a different type

Returns:

the Frame without the stream id 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