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

static org.xnio.Option<String>	AUTH_REALM The authentication realm to use if no authentication CallbackHandler is specified.
static org.xnio.Option<String>	AUTH_USER_NAME Deprecated.
static org.xnio.Option<Integer>	AUTHENTICATION_RETRIES Specify the number of times a client is allowed to retry authentication before closing the connection.
static org.xnio.Option<String>	AUTHORIZE_ID The SASL authorization ID.
static org.xnio.Option<Integer>	BUFFER_REGION_SIZE The size of allocated buffer regions.
static int	DEFAULT_AUTHENTICATION_RETRIES The default number of authentication retries.
static int	DEFAULT_HEARTBEAT_INTERVAL The default heartbeat interval.
static int	DEFAULT_MAX_INBOUND_CHANNELS The default maximum number of inbound channels.
static long	DEFAULT_MAX_INBOUND_MESSAGE_SIZE The default maximum inbound message size.
static int	DEFAULT_MAX_INBOUND_MESSAGES The default maximum number of concurrent inbound messages on a channel.
static int	DEFAULT_MAX_OUTBOUND_CHANNELS The default maximum number of outbound channels.
static long	DEFAULT_MAX_OUTBOUND_MESSAGE_SIZE The default maximum outbound message size.
static int	DEFAULT_RECEIVE_BUFFER_SIZE The default receive buffer size.
static String	DEFAULT_SASL_PROTOCOL The default SASL protocol name.
static int	DEFAULT_SEND_BUFFER_SIZE The default send buffer size.
static org.xnio.Option<Integer>	HEARTBEAT_INTERVAL The interval to use for connection heartbeat, in milliseconds.
static int	INCOMING_CHANNEL_DEFAULT_MAX_OUTBOUND_MESSAGES The default maximum number of concurrent outbound messages on an incoming channel.
static int	INCOMING_CHANNEL_DEFAULT_RECEIVE_WINDOW_SIZE The default requested window size of the receive direction for incoming channel open attempts.
static int	INCOMING_CHANNEL_DEFAULT_TRANSMIT_WINDOW_SIZE The default requested window size of the transmit direction for incoming channel open attempts.
static org.xnio.Option<Integer>	MAX_INBOUND_CHANNELS The maximum number of inbound channels to support for a connection.
static org.xnio.Option<Long>	MAX_INBOUND_MESSAGE_SIZE The maximum inbound message size to be allowed.
static org.xnio.Option<Integer>	MAX_INBOUND_MESSAGES The maximum number of concurrent inbound messages on a channel.
static org.xnio.Option<Integer>	MAX_OUTBOUND_CHANNELS The maximum number of outbound channels to support for a connection.
static org.xnio.Option<Long>	MAX_OUTBOUND_MESSAGE_SIZE The maximum outbound message size to send.
static org.xnio.Option<Integer>	MAX_OUTBOUND_MESSAGES The maximum number of concurrent outbound messages on a channel.
static int	OUTGOING_CHANNEL_DEFAULT_MAX_OUTBOUND_MESSAGES The default maximum number of concurrent outbound messages on an outgoing channel.
static int	OUTGOING_CHANNEL_DEFAULT_RECEIVE_WINDOW_SIZE The default requested window size of the receive direction for outgoing channel open attempts.
static int	OUTGOING_CHANNEL_DEFAULT_TRANSMIT_WINDOW_SIZE The default requested window size of the transmit direction for outgoing channel open attempts.
static org.xnio.Option<Integer>	RECEIVE_BUFFER_SIZE The size of the largest buffer that this endpoint will accept over a connection.
static org.xnio.Option<Integer>	RECEIVE_WINDOW_SIZE The maximum window size of the receive direction for connection channels, in bytes.
static org.xnio.Option<String>	SASL_PROTOCOL Where a SaslServer or SaslClient are created by default the protocol specified it 'remoting', this Option can be used to override this.
static org.xnio.Option<Integer>	SEND_BUFFER_SIZE The size of the largest buffer that this endpoint will transmit over a connection.
static org.xnio.Option<String>	SERVER_NAME The server side of the connection passes it's name to the client in the initial greeting, by default the name is automatically discovered from the local address of the connection or it can be overridden using this Option.
static org.xnio.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 org.xnio.Option<Integer> SEND_BUFFER_SIZE

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

DEFAULT_SEND_BUFFER_SIZE

public static final int DEFAULT_SEND_BUFFER_SIZE

The default send buffer size.

See Also:

Constant Field Values

RECEIVE_BUFFER_SIZE

public static final org.xnio.Option<Integer> RECEIVE_BUFFER_SIZE

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

DEFAULT_RECEIVE_BUFFER_SIZE

public static final int DEFAULT_RECEIVE_BUFFER_SIZE

The default receive buffer size.

See Also:

Constant Field Values

BUFFER_REGION_SIZE

public static final org.xnio.Option<Integer> BUFFER_REGION_SIZE

The size of allocated buffer regions.

TRANSMIT_WINDOW_SIZE

public static final org.xnio.Option<Integer> TRANSMIT_WINDOW_SIZE

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

INCOMING_CHANNEL_DEFAULT_TRANSMIT_WINDOW_SIZE

public static final int INCOMING_CHANNEL_DEFAULT_TRANSMIT_WINDOW_SIZE

The default requested window size of the transmit direction for incoming channel open attempts.

See Also:

Constant Field Values

OUTGOING_CHANNEL_DEFAULT_TRANSMIT_WINDOW_SIZE

public static final int OUTGOING_CHANNEL_DEFAULT_TRANSMIT_WINDOW_SIZE

The default requested window size of the transmit direction for outgoing channel open attempts.

See Also:

Constant Field Values

RECEIVE_WINDOW_SIZE

public static final org.xnio.Option<Integer> RECEIVE_WINDOW_SIZE

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

INCOMING_CHANNEL_DEFAULT_RECEIVE_WINDOW_SIZE

public static final int INCOMING_CHANNEL_DEFAULT_RECEIVE_WINDOW_SIZE

The default requested window size of the receive direction for incoming channel open attempts.

See Also:

Constant Field Values

OUTGOING_CHANNEL_DEFAULT_RECEIVE_WINDOW_SIZE

public static final int OUTGOING_CHANNEL_DEFAULT_RECEIVE_WINDOW_SIZE

The default requested window size of the receive direction for outgoing channel open attempts.

See Also:

Constant Field Values

MAX_OUTBOUND_CHANNELS

public static final org.xnio.Option<Integer> MAX_OUTBOUND_CHANNELS

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

DEFAULT_MAX_OUTBOUND_CHANNELS

public static final int DEFAULT_MAX_OUTBOUND_CHANNELS

The default maximum number of outbound channels.

See Also:

Constant Field Values

MAX_INBOUND_CHANNELS

public static final org.xnio.Option<Integer> MAX_INBOUND_CHANNELS

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

DEFAULT_MAX_INBOUND_CHANNELS

public static final int DEFAULT_MAX_INBOUND_CHANNELS

The default maximum number of inbound channels.

See Also:

Constant Field Values

AUTHORIZE_ID

public static final org.xnio.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_USER_NAME

@Deprecated
public static final org.xnio.Option<String> AUTH_USER_NAME

Deprecated.

Deprecated alias for AUTHORIZE_ID.

AUTH_REALM

public static final org.xnio.Option<String> AUTH_REALM

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

AUTHENTICATION_RETRIES

public static final org.xnio.Option<Integer> AUTHENTICATION_RETRIES

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

DEFAULT_AUTHENTICATION_RETRIES

public static final int DEFAULT_AUTHENTICATION_RETRIES

The default number of authentication retries.

See Also:

Constant Field Values

MAX_OUTBOUND_MESSAGES

public static final org.xnio.Option<Integer> MAX_OUTBOUND_MESSAGES

The maximum number of concurrent outbound messages on a channel.

INCOMING_CHANNEL_DEFAULT_MAX_OUTBOUND_MESSAGES

public static final int INCOMING_CHANNEL_DEFAULT_MAX_OUTBOUND_MESSAGES

The default maximum number of concurrent outbound messages on an incoming channel.

See Also:

Constant Field Values

OUTGOING_CHANNEL_DEFAULT_MAX_OUTBOUND_MESSAGES

public static final int OUTGOING_CHANNEL_DEFAULT_MAX_OUTBOUND_MESSAGES

The default maximum number of concurrent outbound messages on an outgoing channel.

See Also:

Constant Field Values

MAX_INBOUND_MESSAGES

public static final org.xnio.Option<Integer> MAX_INBOUND_MESSAGES

The maximum number of concurrent inbound messages on a channel.

DEFAULT_MAX_INBOUND_MESSAGES

public static final int DEFAULT_MAX_INBOUND_MESSAGES

The default maximum number of concurrent inbound messages on a channel.

See Also:

Constant Field Values

HEARTBEAT_INTERVAL

public static final org.xnio.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.

DEFAULT_HEARTBEAT_INTERVAL

public static final int DEFAULT_HEARTBEAT_INTERVAL

The default heartbeat interval.

See Also:

Constant Field Values

MAX_INBOUND_MESSAGE_SIZE

public static final org.xnio.Option<Long> MAX_INBOUND_MESSAGE_SIZE

The maximum inbound message size to be allowed. Messages exceeding this size will cause an exception to be thrown on the reading side as well as the writing side.

DEFAULT_MAX_INBOUND_MESSAGE_SIZE

public static final long DEFAULT_MAX_INBOUND_MESSAGE_SIZE

The default maximum inbound message size.

See Also:

Constant Field Values

MAX_OUTBOUND_MESSAGE_SIZE

public static final org.xnio.Option<Long> MAX_OUTBOUND_MESSAGE_SIZE

The maximum outbound message size to send. No messages larger than this well be transmitted; attempting to do so will cause an exception on the writing side.

DEFAULT_MAX_OUTBOUND_MESSAGE_SIZE

public static final long DEFAULT_MAX_OUTBOUND_MESSAGE_SIZE

The default maximum outbound message size.

See Also:

Constant Field Values

SERVER_NAME

public static final org.xnio.Option<String> SERVER_NAME

The server side of the connection passes it's name to the client in the initial greeting, by default the name is automatically discovered from the local address of the connection or it can be overridden using this Option.

SASL_PROTOCOL

public static final org.xnio.Option<String> SASL_PROTOCOL

Where a SaslServer or SaslClient are created by default the protocol specified it 'remoting', this Option can be used to override this.

DEFAULT_SASL_PROTOCOL

public static final String DEFAULT_SASL_PROTOCOL

The default SASL protocol name.

See Also:

Constant Field Values