org.jboss.remoting3

Class RemotingOptions

java.lang.Object

org.jboss.remoting3.RemotingOptions

public final class RemotingOptions
extends Object

Common options for Remoting configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static Option<String>	AUTH_REALM The authentication realm to use if no authentication CallbackHandler is specified.
static Option<Integer>	AUTHENTICATION_RETRIES Specify the number of times a client is allowed to retry authentication before closing the connection.
static Option<String>	AUTHORIZE_ID The SASL authorization ID.
static Option<Integer>	BUFFER_REGION_SIZE The size of allocated buffer regions.
static Option<Integer>	HEARTBEAT_INTERVAL The interval to use for connection heartbeat, in milliseconds.
static Option<Integer>	MAX_INBOUND_CHANNELS The maximum number of inbound channels to support for a connection.
static Option<Integer>	MAX_INBOUND_MESSAGES The maximum number of consecutive inbound messages on a channel.
static Option<Integer>	MAX_OUTBOUND_CHANNELS The maximum number of outbound channels to support for a connection.
static Option<Integer>	MAX_OUTBOUND_MESSAGES The maximum number of consecutive outbound messages on a channel.
static Option<Integer>	RECEIVE_BUFFER_SIZE The size of the largest buffer that this endpoint will accept over a connection.
static Option<Integer>	RECEIVE_WINDOW_SIZE The maximum window size of the receive direction for connection channels, in bytes.
static Option<Integer>	SEND_BUFFER_SIZE The size of the largest buffer that this endpoint will transmit over a connection.
static Option<Integer>	TRANSMIT_WINDOW_SIZE The maximum window size of the transmit direction for connection channels, in bytes.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SEND_BUFFER_SIZE

public static final Option<Integer> SEND_BUFFER_SIZE

The size of the largest buffer that this endpoint will transmit over a connection.

RECEIVE_BUFFER_SIZE

public static final Option<Integer> RECEIVE_BUFFER_SIZE

The size of the largest buffer that this endpoint will accept over a connection.

BUFFER_REGION_SIZE

public static final Option<Integer> BUFFER_REGION_SIZE

The size of allocated buffer regions.

TRANSMIT_WINDOW_SIZE

public static final Option<Integer> TRANSMIT_WINDOW_SIZE

The maximum window size of the transmit direction for connection channels, in bytes.

RECEIVE_WINDOW_SIZE

public static final Option<Integer> RECEIVE_WINDOW_SIZE

The maximum window size of the receive direction for connection channels, in bytes.

MAX_OUTBOUND_CHANNELS

public static final Option<Integer> MAX_OUTBOUND_CHANNELS

The maximum number of outbound channels to support for a connection.

MAX_INBOUND_CHANNELS

public static final Option<Integer> MAX_INBOUND_CHANNELS

The maximum number of inbound channels to support for a connection.

AUTHORIZE_ID

public static final Option<String> AUTHORIZE_ID

The SASL authorization ID. Used as authentication user name to use if no authentication CallbackHandler is specified and the selected SASL mechanism demands a user name.

AUTH_REALM

public static final Option<String> AUTH_REALM

The authentication realm to use if no authentication CallbackHandler is specified.

AUTHENTICATION_RETRIES

public static final Option<Integer> AUTHENTICATION_RETRIES

Specify the number of times a client is allowed to retry authentication before closing the connection.

MAX_OUTBOUND_MESSAGES

public static final Option<Integer> MAX_OUTBOUND_MESSAGES

The maximum number of consecutive outbound messages on a channel.

MAX_INBOUND_MESSAGES

public static final Option<Integer> MAX_INBOUND_MESSAGES

The maximum number of consecutive inbound messages on a channel.

HEARTBEAT_INTERVAL

public static final Option<Integer> HEARTBEAT_INTERVAL

The interval to use for connection heartbeat, in milliseconds. If the connection is idle in the outbound direction for this amount of time, a ping message will be sent, which will trigger a corresponding reply message.