com.thomsonreuters.upa.valueadd.reactor

Class ReactorDispatchOptions

java.lang.Object

com.thomsonreuters.upa.valueadd.reactor.ReactorDispatchOptions

public class ReactorDispatchOptions
extends java.lang.Object

ReactorDispatchOptions to be used in the Reactor.dispatchAll(java.util.Set, ReactorDispatchOptions, ReactorErrorInfo) or Reactor.dispatchChannel(ReactorChannel, ReactorDispatchOptions, ReactorErrorInfo) call.

Constructor Summary

Constructors

Constructor and Description
ReactorDispatchOptions() Instantiates a new reactor dispatch options.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears this object for reuse.
int	maxMessages() Returns the maxMessages value.
int	maxMessages(int maxMessages) Controls the maximum number of events or messages processed in this call.
com.thomsonreuters.upa.transport.ReadArgs	readArgs() Returns the ReadArgs.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReactorDispatchOptions

public ReactorDispatchOptions()

Instantiates a new reactor dispatch options.

Method Detail

readArgs

public com.thomsonreuters.upa.transport.ReadArgs readArgs()

Returns the ReadArgs.

Returns:

the ReadArgs

maxMessages

public int maxMessages(int maxMessages)

Controls the maximum number of events or messages processed in this call. If this is larger than the number of available messages, Reactor.dispatchAll(java.util.Set, ReactorDispatchOptions, ReactorErrorInfo) or Reactor.dispatchChannel(ReactorChannel, ReactorDispatchOptions, ReactorErrorInfo) will return when there are no more events to process. MaxMessages must be greater than zero. Default is 100, which allows for up to 100 messages to be returned with a single call.

Parameters:

maxMessages - the max messages

Returns:

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

maxMessages

public int maxMessages()

Returns the maxMessages value.

Returns:

the maxMessages value

clear

public void clear()

Clears this object for reuse.