com.pushtechnology.diffusion.client.features.control

Enum RemoteServers.RemoteServer.ConnectionOption

java.lang.Object

java.lang.Enum<RemoteServers.RemoteServer.ConnectionOption>

com.pushtechnology.diffusion.client.features.control.RemoteServers.RemoteServer.ConnectionOption

All Implemented Interfaces:

Serializable, Comparable<RemoteServers.RemoteServer.ConnectionOption>

Enclosing interface:

RemoteServers.RemoteServer

public static enum RemoteServers.RemoteServer.ConnectionOption
extends Enum<RemoteServers.RemoteServer.ConnectionOption>

Connection option key.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONNECTION_TIMEOUT Specifies the connection timeout session attribute value (in milliseconds).
INPUT_BUFFER_SIZE Specifies the input buffer size session attribute.
MAXIMUM_QUEUE_SIZE Specifies the maximum queue size session attribute.
OUTPUT_BUFFER_SIZE Specifies the output buffer size session attribute.
RECONNECTION_TIMEOUT Specifies the reconnection timeout session attribute.
RECOVERY_BUFFER_SIZE Specifies the recovery buffer size session attribute.
RETRY_DELAY Specifies the delay after losing a connection before attempting a reconnection.
WRITE_TIMEOUT Specifies the write timeout session attribute value (in milliseconds).

Method Summary

Modifier and Type	Method and Description
static RemoteServers.RemoteServer.ConnectionOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static RemoteServers.RemoteServer.ConnectionOption[]	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

RECONNECTION_TIMEOUT

public static final RemoteServers.RemoteServer.ConnectionOption RECONNECTION_TIMEOUT

Specifies the reconnection timeout session attribute.

This is the total time in milliseconds that will be allowed to reconnect a failed connection to the remote server.

For reconnection to work the remote server connector must have been configured to support reconnection.

If a value is not specified DEFAULT_RECONNECTION_TIMEOUT is used.

RETRY_DELAY

public static final RemoteServers.RemoteServer.ConnectionOption RETRY_DELAY

Specifies the delay after losing a connection before attempting a reconnection.

The value is specified in milliseconds. Default 1000 (1 second).

RECOVERY_BUFFER_SIZE

public static final RemoteServers.RemoteServer.ConnectionOption RECOVERY_BUFFER_SIZE

Specifies the recovery buffer size session attribute.

If the remote server is configured to support reconnection, a session established with a non-zero reconnect-timeout retains a buffer of sent messages. If the session disconnects and reconnects, this buffer is used to re-send messages that the server has not received.

The default value is 10,000 messages. If reconnect-timeout is 0 then this value is ignored.

INPUT_BUFFER_SIZE

public static final RemoteServers.RemoteServer.ConnectionOption INPUT_BUFFER_SIZE

Specifies the input buffer size session attribute.

This is the size of the input buffer to use for the connection with the remote server. It is used to receive messages from the remote server. This should be set to the same size as the output buffer used at the remote server.

If not specified, a default of 1024k is used.

OUTPUT_BUFFER_SIZE

public static final RemoteServers.RemoteServer.ConnectionOption OUTPUT_BUFFER_SIZE

Specifies the output buffer size session attribute.

This is the size of the output buffer to use for the connection with the remote server. It is used to send messages to the remote server. This should be set to the same size as the input buffer used by the remote server.

If not specified, a default of 1024k is used.

MAXIMUM_QUEUE_SIZE

public static final RemoteServers.RemoteServer.ConnectionOption MAXIMUM_QUEUE_SIZE

Specifies the maximum queue size session attribute.

This is the maximum number of messages that can be queued to send to the remote server. If this number is exceeded, the connection will be closed. This must be sufficient to cater for messages that may be queued whilst disconnected (awaiting reconnect).

The default value is 10,000 messages.

CONNECTION_TIMEOUT

public static final RemoteServers.RemoteServer.ConnectionOption CONNECTION_TIMEOUT

Specifies the connection timeout session attribute value (in milliseconds).

If a value is not specified DEFAULT_CONNECTION_TIMEOUT is used.

WRITE_TIMEOUT

public static final RemoteServers.RemoteServer.ConnectionOption WRITE_TIMEOUT

Specifies the write timeout session attribute value (in milliseconds).

If a value is not specified DEFAULT_WRITE_TIMEOUT is used.

Method Detail

values

public static RemoteServers.RemoteServer.ConnectionOption[] 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 (RemoteServers.RemoteServer.ConnectionOption c : RemoteServers.RemoteServer.ConnectionOption.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RemoteServers.RemoteServer.ConnectionOption 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