Modifier and Type	Class and Description
private static class	FrameType.Flags

Field Summary

Modifier and Type	Field and Description
public static final FrameType	CANCEL Cancel outstanding request.
public static final FrameType	COMPLETE A `PAYLOAD` frame with `COMPLETE` flag set.
pack-priv static final int	ENCODED_SIZE The size of the encoded frame type
private final int	encodedType
public static final FrameType	ERROR Error at connection or application level.
public static final FrameType	EXT Used To Extend more frame types as well as extensions.
private final int	flags
private static final FrameType[]	FRAME_TYPES_BY_ENCODED_TYPE
public static final FrameType	KEEPALIVE Connection keepalive.
public static final FrameType	LEASE Sent by Responder to grant the ability to send requests.
public static final FrameType	METADATA_PUSH Asynchronous Metadata frame.
public static final FrameType	NEXT A `PAYLOAD` frame with `NEXT` flag set.
public static final FrameType	NEXT_COMPLETE A `PAYLOAD` frame with `NEXT` and `COMPLETE` flags set.
public static final FrameType	PAYLOAD Payload on a stream.
public static final FrameType	REQUEST_CHANNEL Request a completable stream in both directions.
public static final FrameType	REQUEST_FNF A single one-way message.
public static final FrameType	REQUEST_N Request N more items with Reactive Streams semantics.
public static final FrameType	REQUEST_RESPONSE Request single response.
public static final FrameType	REQUEST_STREAM Request a completable stream.
public static final FrameType	RESERVED Reserved.
public static final FrameType	RESUME Replaces SETUP for Resuming Operation (optional).
public static final FrameType	RESUME_OK Sent in response to a RESUME if resuming operation possible (optional).
public static final FrameType	SETUP Sent by client to initiate protocol processing.

Constructor Summary

Access	Constructor and Description
private	FrameType(int encodedType)
private	FrameType(int encodedType, int flags)

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: whether the frame type can have data canHaveData() Whether the frame type can have data.
public boolean	Returns: whether the frame type can have metadata canHaveMetadata() Whether the frame type can have metadata
public static FrameType	Returns: the `FrameType` that matches the specified `encodedType` fromEncodedType(int the encoded type encodedType) Returns the `FrameType` that matches the specified `encodedType`.
public int	Returns: the encoded type getEncodedType() Returns the encoded type.
private static int	getMaximumEncodedType()
public boolean	Returns: wether the frame type starts with an initial `requestN` hasInitialRequestN() Whether the frame type starts with an initial `requestN`.
public boolean	Returns: whether the frame type is fragmentable isFragmentable() Whether the frame type is fragmentable.
public boolean	Returns: whether the frame type is a request type isRequestType() Whether the frame type is a request type.
public static FrameType	valueOf(String name)
public static FrameType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CANCEL	back to summary
public static final FrameType CANCEL Cancel outstanding request. See Also Cancel Frame

CANCEL

back to summary

public static final FrameType CANCEL

Cancel outstanding request.

See Also: Cancel Frame

COMPLETE	back to summary
public static final FrameType COMPLETE A `PAYLOAD` frame with `COMPLETE` flag set.

ENCODED_SIZE	back to summary
pack-priv static final int ENCODED_SIZE The size of the encoded frame type

encodedType	back to summary
private final int encodedType

ERROR	back to summary
public static final FrameType ERROR Error at connection or application level. See Also Error Frame

ERROR

back to summary

public static final FrameType ERROR

Error at connection or application level.

See Also: Error Frame

EXT	back to summary
public static final FrameType EXT Used To Extend more frame types as well as extensions. See Also Extension Frame

EXT

back to summary

public static final FrameType EXT

Used To Extend more frame types as well as extensions.

See Also: Extension Frame

flags	back to summary
private final int flags

FRAME_TYPES_BY_ENCODED_TYPE	back to summary
private static final FrameType[] FRAME_TYPES_BY_ENCODED_TYPE

KEEPALIVE	back to summary
public static final FrameType KEEPALIVE Connection keepalive. See Also Keepalive Frame

KEEPALIVE

back to summary

public static final FrameType KEEPALIVE

Connection keepalive.

See Also: Keepalive Frame

LEASE	back to summary
public static final FrameType LEASE Sent by Responder to grant the ability to send requests. See Also Lease Frame

LEASE

back to summary

public static final FrameType LEASE

Sent by Responder to grant the ability to send requests.

See Also: Lease Frame

METADATA_PUSH

back to summary

public static final FrameType METADATA_PUSH

Asynchronous Metadata frame.

See Also: Metadata Push Frame

NEXT	back to summary
public static final FrameType NEXT A `PAYLOAD` frame with `NEXT` flag set.

NEXT_COMPLETE	back to summary
public static final FrameType NEXT_COMPLETE A `PAYLOAD` frame with `NEXT` and `COMPLETE` flags set.

PAYLOAD	back to summary
public static final FrameType PAYLOAD Payload on a stream. For example, response to a request, or message on a channel. See Also Payload Frame

PAYLOAD

back to summary

public static final FrameType PAYLOAD

Payload on a stream. For example, response to a request, or message on a channel.

See Also: Payload Frame

REQUEST_CHANNEL	back to summary
public static final FrameType REQUEST_CHANNEL Request a completable stream in both directions. See Also Request Channel Frame

REQUEST_CHANNEL

back to summary

public static final FrameType REQUEST_CHANNEL

Request a completable stream in both directions.

See Also: Request Channel Frame

REQUEST_FNF	back to summary
public static final FrameType REQUEST_FNF A single one-way message. See Also Request Fire-and-Forget Frame

REQUEST_FNF

back to summary

public static final FrameType REQUEST_FNF

A single one-way message.

See Also: Request Fire-and-Forget Frame

REQUEST_N	back to summary
public static final FrameType REQUEST_N Request N more items with Reactive Streams semantics. See Also RequestN Frame

REQUEST_N

back to summary

public static final FrameType REQUEST_N

Request N more items with Reactive Streams semantics.

See Also: RequestN Frame

REQUEST_RESPONSE	back to summary
public static final FrameType REQUEST_RESPONSE Request single response. See Also Request Response Frame

REQUEST_RESPONSE

back to summary

public static final FrameType REQUEST_RESPONSE

Request single response.

See Also: Request Response Frame

REQUEST_STREAM	back to summary
public static final FrameType REQUEST_STREAM Request a completable stream. See Also Request Stream Frame

REQUEST_STREAM

back to summary

public static final FrameType REQUEST_STREAM

Request a completable stream.

See Also: Request Stream Frame

RESERVED	back to summary
public static final FrameType RESERVED Reserved.

RESUME	back to summary
public static final FrameType RESUME Replaces SETUP for Resuming Operation (optional). See Also Resume Frame

RESUME

back to summary

public static final FrameType RESUME

Replaces SETUP for Resuming Operation (optional).

See Also: Resume Frame

RESUME_OK	back to summary
public static final FrameType RESUME_OK Sent in response to a RESUME if resuming operation possible (optional). See Also Resume OK Frame

RESUME_OK

back to summary

public static final FrameType RESUME_OK

Sent in response to a RESUME if resuming operation possible (optional).

See Also: Resume OK Frame

SETUP	back to summary
public static final FrameType SETUP Sent by client to initiate protocol processing. See Also Setup Frame

SETUP

back to summary

public static final FrameType SETUP

Sent by client to initiate protocol processing.

See Also: Setup Frame

Constructor Detail

FrameType	back to summary
private FrameType(int encodedType)

FrameType	back to summary
private FrameType(int encodedType, int flags)

Method Detail

canHaveData	back to summary
public boolean canHaveData() Whether the frame type can have data. Returns:boolean whether the frame type can have data

canHaveData

back to summary

public boolean canHaveData()

Whether the frame type can have data.

Returns:boolean: whether the frame type can have data

canHaveMetadata

back to summary

public boolean canHaveMetadata()

Whether the frame type can have metadata

Returns:boolean: whether the frame type can have metadata

fromEncodedType back to summary

fromEncodedType	back to summary
public static FrameType fromEncodedType(int encodedType) Returns the `FrameType` that matches the specified `encodedType`. Parameters encodedType:int the encoded type Returns:FrameType the `FrameType` that matches the specified `encodedType`

public static FrameType fromEncodedType(int encodedType)

Returns the FrameType that matches the specified encodedType.

Parameters

encodedType:int: the encoded type

Returns:FrameType

the FrameType that matches the specified encodedType

getEncodedType	back to summary
public int getEncodedType() Returns the encoded type. Returns:int the encoded type

getEncodedType

back to summary

public int getEncodedType()

Returns the encoded type.

Returns:int: the encoded type

getMaximumEncodedType	back to summary
private static int getMaximumEncodedType()

hasInitialRequestN back to summary

hasInitialRequestN	back to summary
public boolean hasInitialRequestN() Whether the frame type starts with an initial `requestN`. Returns:boolean wether the frame type starts with an initial `requestN`

public boolean hasInitialRequestN()

Whether the frame type starts with an initial requestN.

Returns:boolean: wether the frame type starts with an initial requestN

isFragmentable	back to summary
public boolean isFragmentable() Whether the frame type is fragmentable. Returns:boolean whether the frame type is fragmentable

isFragmentable

back to summary

public boolean isFragmentable()

Whether the frame type is fragmentable.

Returns:boolean: whether the frame type is fragmentable

isRequestType	back to summary
public boolean isRequestType() Whether the frame type is a request type. Returns:boolean whether the frame type is a request type

isRequestType

back to summary

public boolean isRequestType()

Whether the frame type is a request type.

Returns:boolean: whether the frame type is a request type

valueOf	back to summary
public static FrameType valueOf(String name)

values	back to summary
public static FrameType[] values()

io.rsocket.frame back to summary

private Class FrameType.Flags

Class Inheritance

extends Object

java.lang.Object
io.rsocket.frame.FrameType.Flags

Field Summary

Modifier and Type	Field and Description
private static final int	CAN_HAVE_DATA
private static final int	CAN_HAVE_METADATA
private static final int	EMPTY
private static final int	HAS_INITIAL_REQUEST_N
private static final int	IS_FRAGMENTABLE
private static final int	IS_REQUEST_TYPE

Constructor Summary

Access	Constructor and Description
private	Flags()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

CAN_HAVE_DATA	back to summary
private static final int CAN_HAVE_DATA

CAN_HAVE_METADATA	back to summary
private static final int CAN_HAVE_METADATA

EMPTY	back to summary
private static final int EMPTY

HAS_INITIAL_REQUEST_N	back to summary
private static final int HAS_INITIAL_REQUEST_N

IS_FRAGMENTABLE	back to summary
private static final int IS_FRAGMENTABLE

IS_REQUEST_TYPE	back to summary
private static final int IS_REQUEST_TYPE

Constructor Detail

Flags	back to summary
private Flags()

public final Enum FrameType

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class FrameType.Flags

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail