com.thomsonreuters.upa.valueadd.reactor

Class ReactorConnectOptions

java.lang.Object

com.thomsonreuters.upa.valueadd.reactor.ReactorConnectOptions

public class ReactorConnectOptions
extends java.lang.Object

ReactorConnectOptions to be used in the Reactor.connect(ReactorConnectOptions, ReactorRole, ReactorErrorInfo) call.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears this object for reuse.
java.util.List<ReactorConnectInfo>	connectionList() A list of connections.
int	copy(ReactorConnectOptions destOpts) This method will perform a deep copy into the passed in parameter's members from the Object calling this method.
int	reconnectAttemptLimit() Returns the reconnectAttemptLimit value.
int	reconnectAttemptLimit(int limit) The maximum number of times the Reactor will attempt to reconnect a channel.
int	reconnectMaxDelay() Returns the reconnectMaxDelay value.
int	reconnectMaxDelay(int delay) The maximum time the Reactor will wait before attempting to reconnect, in milliseconds.
int	reconnectMinDelay() Returns the reconnectMinDelay value.
int	reconnectMinDelay(int delay) The minimum time the Reactor will wait before attempting to reconnect, in milliseconds.

Methods inherited from class java.lang.Object

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

Method Detail

connectionList

public java.util.List<ReactorConnectInfo> connectionList()

A list of connections. Add at least one connection to the list. Additional connections are used as backups for fail-over in case the first connection is lost. Each connection in the list will be tried with each reconnection attempt.

Returns:

the list of connections

reconnectAttemptLimit

public int reconnectAttemptLimit()

Returns the reconnectAttemptLimit value.

Returns:

the reconnectAttemptLimit value

reconnectAttemptLimit

public int reconnectAttemptLimit(int limit)

The maximum number of times the Reactor will attempt to reconnect a channel. If set to -1, there is no limit. Must be in the range of -1 - 2147483647. Default is 0.

Parameters:

limit - the maximum number of reconnect attempts

Returns:

ReactorReturnCodes.SUCCESS if the limit is valid, otherwise ReactorReturnCodes.PARAMETER_OUT_OF_RANGE if the limit is out of range

reconnectMinDelay

public int reconnectMinDelay()

Returns the reconnectMinDelay value.

Returns:

the reconnectMinDelay value

reconnectMinDelay

public int reconnectMinDelay(int delay)

The minimum time the Reactor will wait before attempting to reconnect, in milliseconds. Must be in the range of 1000 - 2147483647. Default is 1000. Default value is used if value is greater than or equal to zero and less than 1000.

Parameters:

delay - the minimum reconnect delay

Returns:

ReactorReturnCodes.SUCCESS if the delay is valid, otherwise ReactorReturnCodes.PARAMETER_OUT_OF_RANGE if the delay is less than zero

reconnectMaxDelay

public int reconnectMaxDelay()

Returns the reconnectMaxDelay value.

Returns:

the reconnectMaxDelay value

reconnectMaxDelay

public int reconnectMaxDelay(int delay)

The maximum time the Reactor will wait before attempting to reconnect, in milliseconds. Must be in the range of 1000 - 2147483647 and must be greater than or equal to reconnectMinDelay. Default is 1000. reconnectMinDelay value is used if value is less than reconnectMinDelay.

Parameters:

delay - the maximum reconnect delay

Returns:

ReactorReturnCodes.SUCCESS if the delay is valid, otherwise ReactorReturnCodes.PARAMETER_OUT_OF_RANGE if the delay is less than zero

clear

public void clear()

Clears this object for reuse.

copy

public int copy(ReactorConnectOptions destOpts)

This method will perform a deep copy into the passed in parameter's members from the Object calling this method.

Parameters:

destOpts - the value getting populated with the values of the calling Object

Returns:

ReactorReturnCodes.SUCCESS on success, ReactorReturnCodes.FAILURE if the destOpts is null.