FrameType (rsocket-core 1.1.1 API)

java.lang.Object
- java.lang.Enum<FrameType>
- - io.rsocket.frame.FrameType

All Implemented Interfaces:

Serializable, Comparable<FrameType>
```
public enum FrameType
extends Enum<FrameType>
```
Types of Frame that can be sent.

See Also:

Frame Types

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CANCEL` Cancel outstanding request.
`COMPLETE` A `PAYLOAD` frame with `COMPLETE` flag set.
`ERROR` Error at connection or application level.
`EXT` Used To Extend more frame types as well as extensions.
`KEEPALIVE` Connection keepalive.
`LEASE` Sent by Responder to grant the ability to send requests.
`METADATA_PUSH` Asynchronous Metadata frame.
`NEXT` A `PAYLOAD` frame with `NEXT` flag set.
`NEXT_COMPLETE` A `PAYLOAD` frame with `NEXT` and `COMPLETE` flags set.
`PAYLOAD` Payload on a stream.
`REQUEST_CHANNEL` Request a completable stream in both directions.
`REQUEST_FNF` A single one-way message.
`REQUEST_N` Request N more items with Reactive Streams semantics.
`REQUEST_RESPONSE` Request single response.
`REQUEST_STREAM` Request a completable stream.
`RESERVED` Reserved.
`RESUME` Replaces SETUP for Resuming Operation (optional).
`RESUME_OK` Sent in response to a RESUME if resuming operation possible (optional).
`SETUP` Sent by client to initiate protocol processing.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canHaveData()` Whether the frame type can have data.
`boolean`	`canHaveMetadata()` Whether the frame type can have metadata
`static FrameType`	`fromEncodedType(int encodedType)` Returns the `FrameType` that matches the specified `encodedType`.
`int`	`getEncodedType()` Returns the encoded type.
`boolean`	`hasInitialRequestN()` Whether the frame type starts with an initial `requestN`.
`boolean`	`isFragmentable()` Whether the frame type is fragmentable.
`boolean`	`isRequestType()` Whether the frame type is a request type.
`static FrameType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static FrameType[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - RESERVED
```
public static final FrameType RESERVED
```
    Reserved.
  - SETUP
```
public static final FrameType SETUP
```
    Sent by client to initiate protocol processing.
    
    See Also:
    
    Setup Frame
  - LEASE
```
public static final FrameType LEASE
```
    Sent by Responder to grant the ability to send requests.
    
    See Also:
    
    Lease Frame
  - KEEPALIVE
```
public static final FrameType KEEPALIVE
```
    Connection keepalive.
    
    See Also:
    
    Keepalive Frame
  - REQUEST_RESPONSE
```
public static final FrameType REQUEST_RESPONSE
```
    Request single response.
    
    See Also:
    
    Request Response Frame
  - REQUEST_FNF
```
public static final FrameType REQUEST_FNF
```
    A single one-way message.
    
    See Also:
    
    Request Fire-and-Forget Frame
  - REQUEST_STREAM
```
public static final FrameType REQUEST_STREAM
```
    Request a completable stream.
    
    See Also:
    
    Request Stream Frame
  - REQUEST_CHANNEL
```
public static final FrameType REQUEST_CHANNEL
```
    Request a completable stream in both directions.
    
    See Also:
    
    Request Channel Frame
  - REQUEST_N
```
public static final FrameType REQUEST_N
```
    Request N more items with Reactive Streams semantics.
    
    See Also:
    
    RequestN Frame
  - CANCEL
```
public static final FrameType CANCEL
```
    Cancel outstanding request.
    
    See Also:
    
    Cancel Frame
  - PAYLOAD
```
public static final FrameType PAYLOAD
```
    Payload on a stream. For example, response to a request, or message on a channel.
    
    See Also:
    
    Payload Frame
  - ERROR
```
public static final FrameType ERROR
```
    Error at connection or application level.
    
    See Also:
    
    Error Frame
  - METADATA_PUSH
```
public static final FrameType METADATA_PUSH
```
    Asynchronous Metadata frame.
    
    See Also:
    
    Metadata Push Frame
  - RESUME
```
public static final FrameType RESUME
```
    Replaces SETUP for Resuming Operation (optional).
    
    See Also:
    
    Resume Frame
  - RESUME_OK
```
public static final FrameType RESUME_OK
```
    Sent in response to a RESUME if resuming operation possible (optional).
    
    See Also:
    
    Resume OK Frame
  - NEXT
```
public static final FrameType NEXT
```
    A PAYLOAD frame with NEXT flag set.
  - COMPLETE
```
public static final FrameType COMPLETE
```
    A PAYLOAD frame with COMPLETE flag set.
  - NEXT_COMPLETE
```
public static final FrameType NEXT_COMPLETE
```
    A PAYLOAD frame with NEXT and COMPLETE flags set.
  - EXT
```
public static final FrameType EXT
```
    Used To Extend more frame types as well as extensions.
    
    See Also:
    
    Extension Frame
- Method Detail
  - values
```
public static FrameType[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (FrameType c : FrameType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static FrameType valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - fromEncodedType
```
public static FrameType fromEncodedType(int encodedType)
```
    Returns the FrameType that matches the specified encodedType.
    
    Parameters:
    
    encodedType - the encoded type
    
    Returns:
    
    the FrameType that matches the specified encodedType
  - canHaveData
```
public boolean canHaveData()
```
    Whether the frame type can have data.
    
    Returns:
    
    whether the frame type can have data
  - canHaveMetadata
```
public boolean canHaveMetadata()
```
    Whether the frame type can have metadata
    
    Returns:
    
    whether the frame type can have metadata
  - getEncodedType
```
public int getEncodedType()
```
    Returns the encoded type.
    
    Returns:
    
    the encoded type
  - hasInitialRequestN
```
public boolean hasInitialRequestN()
```
    Whether the frame type starts with an initial requestN.
    
    Returns:
    
    wether the frame type starts with an initial requestN
  - isFragmentable
```
public boolean isFragmentable()
```
    Whether the frame type is fragmentable.
    
    Returns:
    
    whether the frame type is fragmentable
  - isRequestType
```
public boolean isRequestType()
```
    Whether the frame type is a request type.
    
    Returns:
    
    whether the frame type is a request type

Enum FrameType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

RESERVED

SETUP

LEASE

KEEPALIVE

REQUEST_RESPONSE

REQUEST_FNF

REQUEST_STREAM

REQUEST_CHANNEL

REQUEST_N

CANCEL

PAYLOAD

ERROR

METADATA_PUSH

RESUME

RESUME_OK

NEXT

COMPLETE

NEXT_COMPLETE

EXT

Method Detail

values

valueOf

fromEncodedType

canHaveData

canHaveMetadata

getEncodedType

hasInitialRequestN

isFragmentable

isRequestType