io.rsocket.framing

Class RequestStreamFrame

java.lang.Object

io.rsocket.framing.RequestStreamFrame

All Implemented Interfaces:

DataFrame, FragmentableFrame, Frame, MetadataAndDataFrame, MetadataFrame, Disposable

public final class RequestStreamFrame
extends Object

An RSocket REQUEST_STREAM frame.

See Also:

Request Stream 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
RequestStreamFrame	createFragment(ByteBufAllocator byteBufAllocator, ByteBuf metadata, ByteBuf data) Generates the fragment for this frame.
RequestStreamFrame	createNonFragment(ByteBufAllocator byteBufAllocator, ByteBuf metadata, ByteBuf data) Generates the non-fragment for this frame.
static RequestStreamFrame	createRequestStreamFrame(ByteBuf byteBuf) Creates the REQUEST_STREAM frame.
static RequestStreamFrame	createRequestStreamFrame(ByteBufAllocator byteBufAllocator, boolean follows, int initialRequestN, ByteBuf metadata, ByteBuf data) Creates the REQUEST_STREAM frame.
static RequestStreamFrame	createRequestStreamFrame(ByteBufAllocator byteBufAllocator, boolean follows, int initialRequestN, String metadata, String data) Creates the REQUEST_STREAM frame.
void	dispose()
boolean	equals(Object o)
FrameType	getFrameType() Returns the FrameType.
int	getInitialRequestN() Returns the initial requestN.
ByteBuf	getUnsafeData() Returns the data directly.
ByteBuf	getUnsafeFrame() Returns the frame directly.
ByteBuf	getUnsafeMetadata() Returns the metadata directly.
int	hashCode()
boolean	isFollowsFlagSet() Returns whether the Follows 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.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

createRequestStreamFrame

public static RequestStreamFrame createRequestStreamFrame(ByteBuf byteBuf)

Creates the REQUEST_STREAM frame.

Parameters:

byteBuf - the ByteBuf representing the frame

Returns:

the REQUEST_STREAM frame.

Throws:

NullPointerException - if byteBuf is null

createRequestStreamFrame

public static RequestStreamFrame createRequestStreamFrame(ByteBufAllocator byteBufAllocator,
                                                          boolean follows,
                                                          int initialRequestN,
                                                          @Nullable
                                                          String metadata,
                                                          @Nullable
                                                          String data)

Creates the REQUEST_STREAM frame.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

follows - whether to set the Follows flag

initialRequestN - the initial requestN

metadata - the metadata

data - the data

Returns:

the REQUEST_STREAM frame

Throws:

NullPointerException - if byteBufAllocator is null

createRequestStreamFrame

public static RequestStreamFrame createRequestStreamFrame(ByteBufAllocator byteBufAllocator,
                                                          boolean follows,
                                                          int initialRequestN,
                                                          @Nullable
                                                          ByteBuf metadata,
                                                          @Nullable
                                                          ByteBuf data)

Creates the REQUEST_STREAM frame.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

follows - whether to set the Follows flag

initialRequestN - the initial requestN

metadata - the metadata

data - the data

Returns:

the REQUEST_STREAM frame

Throws:

NullPointerException - if byteBufAllocator is null

IllegalArgumentException - if initialRequestN is not positive

createFragment

public RequestStreamFrame createFragment(ByteBufAllocator byteBufAllocator,
                                         @Nullable
                                         ByteBuf metadata,
                                         @Nullable
                                         ByteBuf data)

Description copied from interface: FragmentableFrame

Generates the fragment for this frame.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

metadata - the metadata

data - the data

Returns:

the fragment for this frame

createNonFragment

public RequestStreamFrame createNonFragment(ByteBufAllocator byteBufAllocator,
                                            @Nullable
                                            ByteBuf metadata,
                                            @Nullable
                                            ByteBuf data)

Description copied from interface: FragmentableFrame

Generates the non-fragment for this frame.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

metadata - the metadata

data - the data

Returns:

the non-fragment for this frame

getInitialRequestN

public int getInitialRequestN()

Returns the initial requestN.

Returns:

the initial requestN

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)

toString

public String toString()

Overrides:

toString in class Object

isFollowsFlagSet

public final boolean isFollowsFlagSet()

Description copied from interface: FragmentableFrame

Returns whether the Follows flag is set.

Specified by:

isFollowsFlagSet in interface FragmentableFrame

Returns:

whether the Follows flag is set

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