Protocol

java.lang.Object
- org.jboss.remoting3.remote.Protocol

```
final class Protocol
extends java.lang.Object
```
The "remote" protocol. Use this class to create an instance of the connection provider for the "remote" protocol.

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) static byte`	`AUTH_CHALLENGE` Sent by server byte 0: AUTH_CHALLENGE byte 1..n: challenge body
`(package private) static byte`	`AUTH_COMPLETE` Sent by server byte 0: AUTH_COMPLETE
`(package private) static byte`	`AUTH_REJECTED` Sent by server byte 0: AUTH_REJECTED
`(package private) static byte`	`AUTH_REQUEST` Sent by client byte 0: AUTH_REQUEST byte 1..n: request body
`(package private) static byte`	`AUTH_RESPONSE` Sent by client byte 0: AUTH_RESPONSE byte 1..n: response body
`(package private) static int`	`BH_FAULTY_MSG_SIZE` Bad message size flag.
`(package private) static int`	`BH_MESSAGE_CLOSE` Message close protocol flag.
`(package private) static byte`	`CAP_CHANNELS_IN`
`(package private) static byte`	`CAP_CHANNELS_OUT`
`(package private) static byte`	`CAP_ENDPOINT_NAME`
`(package private) static byte`	`CAP_MESSAGE_CLOSE`
`(package private) static byte`	`CAP_SASL_MECH`
`(package private) static byte`	`CAP_STARTTLS`
`(package private) static byte`	`CAP_VERSION`
`(package private) static byte`	`CAP_VERSION_STRING`
`(package private) static byte`	`CAPABILITIES` Sent by client then server.
`(package private) static byte`	`CHANNEL_CLOSED` byte 0: CHANNEL_CLOSE_READ byte 1..4: channel ID Sent when a channel is closed without necessarily consuming all of its incoming messages.
`(package private) static byte`	`CHANNEL_OPEN_ACK` byte 0: CHANNEL_OPEN_ACK byte 1..4: channel ID (MSb = 0) byte 5..n: agreed parameters (see Channel Open Parameters below) inbound = responder->requester outbound = requester->responder
`(package private) static byte`	`CHANNEL_OPEN_REQUEST` byte 0: CHANNEL_OPEN_REQUEST byte 1..4: new channel ID (MSb = 1) byte n+1..m: requested parameters (see Channel Open Parameters below) `O_SERVICE_NAME` is required inbound = responder->requester outbound = requester->responder
`(package private) static byte`	`CHANNEL_SHUTDOWN_WRITE` byte 0: CHANNEL_CLOSE_WRITE byte 1..4: channel ID Sent when channel writes are shut down.
`(package private) static byte`	`CONNECTION_ALIVE` byte 0: CONNECTION_ALIVE byte 1..n: random padding (optional)
`(package private) static byte`	`CONNECTION_ALIVE_ACK` byte 0: CONNECTION_ALIVE byte 1..n: random padding (optional)
`(package private) static byte`	`CONNECTION_CLOSE` byte 0: CONNECTION_CLOSE No packets may be sent afterwards.
`(package private) static byte`	`GREETING` Sent by server only.
`(package private) static byte`	`GRT_SERVER_NAME`
`(package private) static byte`	`MESSAGE_CLOSE` byte 0: MESSAGE_CLOSE byte 1..4: channel ID byte 5..6: message ID Always flows from message recipient to message sender.
`(package private) static byte`	`MESSAGE_DATA` byte 0: MESSAGE_DATA byte 1..4: channel ID byte 5..6: message ID byte 7: flags: - - - - - C N E C = Cancelled N = New E = EOF byte 8..n: message content Always flows from message sender to message recipient.
`(package private) static byte`	`MESSAGE_WINDOW_OPEN` byte 0: MESSAGE_WINDOW_OPEN byte 1..4: channel ID byte 5..6: message ID byte 7..10: window open amount Always flows from message recipient to message sender.
`(package private) static byte`	`MSG_FLAG_CANCELLED`
`(package private) static byte`	`MSG_FLAG_EOF`
`(package private) static byte`	`MSG_FLAG_NEW`
`(package private) static byte`	`NAK` Sent by server when message is not understood or invalid.
`(package private) static int`	`O_END` End of parameters; no content.
`(package private) static int`	`O_MAX_INBOUND_MSG_COUNT` Max requester-bound message count; mandatory uint16 content.
`(package private) static int`	`O_MAX_INBOUND_MSG_SIZE` Max requester-bound message size; mandatory uint63 content.
`(package private) static int`	`O_MAX_INBOUND_MSG_WINDOW_SIZE` Max inbound message window size; mandatory uint31 content.
`(package private) static int`	`O_MAX_OUTBOUND_MSG_COUNT` Max responder-bound message count; mandatory uint16 content.
`(package private) static int`	`O_MAX_OUTBOUND_MSG_SIZE` Max responder-bound message size; mandatory uint63 content.
`(package private) static int`	`O_MAX_OUTBOUND_MSG_WINDOW_SIZE` Max responder-bound message window size; mandatory uint31 content.
`(package private) static int`	`O_SERVICE_NAME` Service name; mandatory utf8 content.
`(package private) static byte`	`SERVICE_ERROR` byte 0: SERVICE_ERROR byte 1..4: channel ID (MSb = 0) byte 5..n: reason UTF8
`(package private) static byte`	`SERVICE_NOT_FOUND` byte 0: SERVICE_NOT_FOUND byte 1..4: channel ID (MSb = 0)
`(package private) static byte`	`STARTTLS` Sent by client then server byte 0: STARTTLS
`(package private) static java.nio.charset.Charset`	`UTF_8`
`(package private) static byte`	`VERSION` The highest-supported version of the remote protocol supported by this implementation.

Constructor Summary

Constructors
Modifier Constructor and Description

private Protocol()

Constructors
Modifier	Constructor and Description
`private`	`Protocol()`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BH_MESSAGE_CLOSE
```
static final int BH_MESSAGE_CLOSE
```
    Message close protocol flag. If true, the remote side knows how to participate in proper async close protocol; if false, just wing it and hope for the best.
    
    See Also:
    
    Constant Field Values
  - BH_FAULTY_MSG_SIZE
```
static final int BH_FAULTY_MSG_SIZE
```
    Bad message size flag. If true, we know that the remote side is going to do the following: 1) Open the internal inbound window size by 8 bytes too many per acknowledged incoming message... and kill the connection if more than 2**29 messages are received due to the window "flipping" to negative values 2) Send an ack/window open which is sized 8 bytes too large per incoming message 3) Shrink its internal outbound window size by 8 bytes too many per outgoing message To compensate we must: 1) Avoid "crashing" the window which will gradually open too much over time 2) Shrink our internal outbound window counter by an extra 8 bytes per outbound message 3) Send message ACKs which are oversized by an extra 8 bytes per inbound message to prevent the window from sliding shut over time
    
    See Also:
    
    Constant Field Values
  - VERSION
```
static final byte VERSION
```
    The highest-supported version of the remote protocol supported by this implementation.
    
    See Also:
    
    Constant Field Values
  - GREETING
```
static final byte GREETING
```
    Sent by server only. byte 0: GREETING byte 1..n: greeting message body
    
    See Also:
    
    Constant Field Values
  - CAPABILITIES
```
static final byte CAPABILITIES
```
    Sent by client then server. byte 0: CAPABILITIES byte 1..n: capabilities summary
    
    See Also:
    
    Constant Field Values
  - AUTH_REQUEST
```
static final byte AUTH_REQUEST
```
    Sent by client byte 0: AUTH_REQUEST byte 1..n: request body
    
    See Also:
    
    Constant Field Values
  - AUTH_CHALLENGE
```
static final byte AUTH_CHALLENGE
```
    Sent by server byte 0: AUTH_CHALLENGE byte 1..n: challenge body
    
    See Also:
    
    Constant Field Values
  - AUTH_RESPONSE
```
static final byte AUTH_RESPONSE
```
    Sent by client byte 0: AUTH_RESPONSE byte 1..n: response body
    
    See Also:
    
    Constant Field Values
  - AUTH_COMPLETE
```
static final byte AUTH_COMPLETE
```
    Sent by server byte 0: AUTH_COMPLETE
    
    See Also:
    
    Constant Field Values
  - AUTH_REJECTED
```
static final byte AUTH_REJECTED
```
    Sent by server byte 0: AUTH_REJECTED
    
    See Also:
    
    Constant Field Values
  - STARTTLS
```
static final byte STARTTLS
```
    Sent by client then server byte 0: STARTTLS
    
    See Also:
    
    Constant Field Values
  - NAK
```
static final byte NAK
```
    Sent by server when message is not understood or invalid. byte 0: NAK
    
    See Also:
    
    Constant Field Values
  - CHANNEL_OPEN_REQUEST
```
static final byte CHANNEL_OPEN_REQUEST
```
    byte 0: CHANNEL_OPEN_REQUEST byte 1..4: new channel ID (MSb = 1) byte n+1..m: requested parameters (see Channel Open Parameters below) O_SERVICE_NAME is required inbound = responder->requester outbound = requester->responder
    
    See Also:
    
    Constant Field Values
  - CHANNEL_OPEN_ACK
```
static final byte CHANNEL_OPEN_ACK
```
    byte 0: CHANNEL_OPEN_ACK byte 1..4: channel ID (MSb = 0) byte 5..n: agreed parameters (see Channel Open Parameters below) inbound = responder->requester outbound = requester->responder
    
    See Also:
    
    Constant Field Values
  - SERVICE_NOT_FOUND
```
static final byte SERVICE_NOT_FOUND
```
    byte 0: SERVICE_NOT_FOUND byte 1..4: channel ID (MSb = 0)
    
    See Also:
    
    Constant Field Values
  - SERVICE_ERROR
```
static final byte SERVICE_ERROR
```
    byte 0: SERVICE_ERROR byte 1..4: channel ID (MSb = 0) byte 5..n: reason UTF8
    
    See Also:
    
    Constant Field Values
  - CHANNEL_SHUTDOWN_WRITE
```
static final byte CHANNEL_SHUTDOWN_WRITE
```
    byte 0: CHANNEL_CLOSE_WRITE byte 1..4: channel ID Sent when channel writes are shut down.
    
    See Also:
    
    Constant Field Values
  - CHANNEL_CLOSED
```
static final byte CHANNEL_CLOSED
```
    byte 0: CHANNEL_CLOSE_READ byte 1..4: channel ID Sent when a channel is closed without necessarily consuming all of its incoming messages. Tell the sending side to drop and close all in-progress messages, and refuse new ones.
    
    See Also:
    
    Constant Field Values
  - MESSAGE_DATA
```
static final byte MESSAGE_DATA
```
    byte 0: MESSAGE_DATA byte 1..4: channel ID byte 5..6: message ID byte 7: flags: - - - - - C N E C = Cancelled N = New E = EOF byte 8..n: message content Always flows from message sender to message recipient.
    
    See Also:
    
    Constant Field Values
  - MESSAGE_WINDOW_OPEN
```
static final byte MESSAGE_WINDOW_OPEN
```
    byte 0: MESSAGE_WINDOW_OPEN byte 1..4: channel ID byte 5..6: message ID byte 7..10: window open amount Always flows from message recipient to message sender.
    
    See Also:
    
    Constant Field Values
  - MESSAGE_CLOSE
```
static final byte MESSAGE_CLOSE
```
    byte 0: MESSAGE_CLOSE byte 1..4: channel ID byte 5..6: message ID Always flows from message recipient to message sender.
    
    See Also:
    
    Constant Field Values
  - CONNECTION_ALIVE
```
static final byte CONNECTION_ALIVE
```
    byte 0: CONNECTION_ALIVE byte 1..n: random padding (optional)
    
    See Also:
    
    Constant Field Values
  - CONNECTION_ALIVE_ACK
```
static final byte CONNECTION_ALIVE_ACK
```
    byte 0: CONNECTION_ALIVE byte 1..n: random padding (optional)
    
    See Also:
    
    Constant Field Values
  - CONNECTION_CLOSE
```
static final byte CONNECTION_CLOSE
```
    byte 0: CONNECTION_CLOSE No packets may be sent afterwards. Connection is closed when message is sent and received.
    
    See Also:
    
    Constant Field Values
  - O_END
```
static final int O_END
```
    End of parameters; no content.
    
    See Also:
    
    Constant Field Values
  - O_SERVICE_NAME
```
static final int O_SERVICE_NAME
```
    Service name; mandatory utf8 content.
    
    See Also:
    
    Constant Field Values
  - O_MAX_INBOUND_MSG_WINDOW_SIZE
```
static final int O_MAX_INBOUND_MSG_WINDOW_SIZE
```
    Max inbound message window size; mandatory uint31 content. On channel open requests, this is inbound from the requester (client) viewpoint. On channel open replies, this is inbound from the requester (client) viewpoint.
    
    See Also:
    
    Constant Field Values
  - O_MAX_INBOUND_MSG_COUNT
```
static final int O_MAX_INBOUND_MSG_COUNT
```
    Max requester-bound message count; mandatory uint16 content.
    
    See Also:
    
    Constant Field Values
  - O_MAX_OUTBOUND_MSG_WINDOW_SIZE
```
static final int O_MAX_OUTBOUND_MSG_WINDOW_SIZE
```
    Max responder-bound message window size; mandatory uint31 content.
    
    See Also:
    
    Constant Field Values
  - O_MAX_OUTBOUND_MSG_COUNT
```
static final int O_MAX_OUTBOUND_MSG_COUNT
```
    Max responder-bound message count; mandatory uint16 content.
    
    See Also:
    
    Constant Field Values
  - O_MAX_INBOUND_MSG_SIZE
```
static final int O_MAX_INBOUND_MSG_SIZE
```
    Max requester-bound message size; mandatory uint63 content.
    
    See Also:
    
    Constant Field Values
  - O_MAX_OUTBOUND_MSG_SIZE
```
static final int O_MAX_OUTBOUND_MSG_SIZE
```
    Max responder-bound message size; mandatory uint63 content.
    
    See Also:
    
    Constant Field Values
  - CAP_VERSION
```
static final byte CAP_VERSION
```
    See Also:
    
    Constant Field Values
  - CAP_SASL_MECH
```
static final byte CAP_SASL_MECH
```
    See Also:
    
    Constant Field Values
  - CAP_STARTTLS
```
static final byte CAP_STARTTLS
```
    See Also:
    
    Constant Field Values
  - CAP_ENDPOINT_NAME
```
static final byte CAP_ENDPOINT_NAME
```
    See Also:
    
    Constant Field Values
  - CAP_MESSAGE_CLOSE
```
static final byte CAP_MESSAGE_CLOSE
```
    See Also:
    
    Constant Field Values
  - CAP_VERSION_STRING
```
static final byte CAP_VERSION_STRING
```
    See Also:
    
    Constant Field Values
  - CAP_CHANNELS_IN
```
static final byte CAP_CHANNELS_IN
```
    See Also:
    
    Constant Field Values
  - CAP_CHANNELS_OUT
```
static final byte CAP_CHANNELS_OUT
```
    See Also:
    
    Constant Field Values
  - GRT_SERVER_NAME
```
static final byte GRT_SERVER_NAME
```
    See Also:
    
    Constant Field Values
  - UTF_8
```
static final java.nio.charset.Charset UTF_8
```
  - MSG_FLAG_EOF
```
static final byte MSG_FLAG_EOF
```
    See Also:
    
    Constant Field Values
  - MSG_FLAG_NEW
```
static final byte MSG_FLAG_NEW
```
    See Also:
    
    Constant Field Values
  - MSG_FLAG_CANCELLED
```
static final byte MSG_FLAG_CANCELLED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Protocol
```
private Protocol()
```

Class Protocol

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BH_MESSAGE_CLOSE

BH_FAULTY_MSG_SIZE

VERSION

GREETING

CAPABILITIES

AUTH_REQUEST

AUTH_CHALLENGE

AUTH_RESPONSE

AUTH_COMPLETE

AUTH_REJECTED

STARTTLS

NAK

CHANNEL_OPEN_REQUEST

CHANNEL_OPEN_ACK

SERVICE_NOT_FOUND

SERVICE_ERROR

CHANNEL_SHUTDOWN_WRITE

CHANNEL_CLOSED

MESSAGE_DATA

MESSAGE_WINDOW_OPEN

MESSAGE_CLOSE

CONNECTION_ALIVE

CONNECTION_ALIVE_ACK

CONNECTION_CLOSE

O_END

O_SERVICE_NAME

O_MAX_INBOUND_MSG_WINDOW_SIZE

O_MAX_INBOUND_MSG_COUNT

O_MAX_OUTBOUND_MSG_WINDOW_SIZE

O_MAX_OUTBOUND_MSG_COUNT

O_MAX_INBOUND_MSG_SIZE

O_MAX_OUTBOUND_MSG_SIZE

CAP_VERSION

CAP_SASL_MECH

CAP_STARTTLS

CAP_ENDPOINT_NAME

CAP_MESSAGE_CLOSE

CAP_VERSION_STRING

CAP_CHANNELS_IN

CAP_CHANNELS_OUT

GRT_SERVER_NAME

UTF_8

MSG_FLAG_EOF

MSG_FLAG_NEW

MSG_FLAG_CANCELLED

Constructor Detail

Protocol