Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration ConnectionOption

Connection options for use with SecondaryServers.

Index

Enumeration members

CONNECTION_TIMEOUT

CONNECTION_TIMEOUT: = 1

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

If a value is not specified the session's default connection timeout is used.

INPUT_BUFFER_SIZE

INPUT_BUFFER_SIZE: = 2

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.

MAXIMUM_QUEUE_SIZE

MAXIMUM_QUEUE_SIZE: = 3

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.

OUTPUT_BUFFER_SIZE

OUTPUT_BUFFER_SIZE: = 4

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.

RECONNECTION_TIMEOUT

RECONNECTION_TIMEOUT: = 5

Specifies the reconnection timeout session attribute.

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

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

If a value is not specified the session's default reconnection timeout is used.

This value cannot be supplied for a SECONDARY_ACCEPTOR server.

RECOVERY_BUFFER_SIZE

RECOVERY_BUFFER_SIZE: = 6

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.

This value cannot be supplied for a SECONDARY_ACCEPTOR server.

RETRY_DELAY

RETRY_DELAY: = 7

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

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

This value cannot be supplied for a SECONDARY_ACCEPTOR server.

WRITE_TIMEOUT

WRITE_TIMEOUT: = 8

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

If a value is not specified the session's default write timeout is used.