com.thomsonreuters.upa.valueadd.reactor

Class Reactor

java.lang.Object

com.thomsonreuters.upa.valueadd.reactor.Reactor

public class Reactor
extends java.lang.Object

The Reactor. Applications create Reactor objects by calling ReactorFactory.createReactor(ReactorOptions, ReactorErrorInfo), create connections by calling connect(ReactorConnectOptions, ReactorRole, ReactorErrorInfo)/ accept(com.thomsonreuters.upa.transport.Server, ReactorAcceptOptions, ReactorRole, ReactorErrorInfo) and process events by calling ReactorChannel.dispatch(ReactorDispatchOptions, ReactorErrorInfo)/ dispatchAll(Set, ReactorDispatchOptions, ReactorErrorInfo).

See Also:

ReactorChannel, ReactorFactory.createReactor(com.thomsonreuters.upa.valueadd.reactor.ReactorOptions, com.thomsonreuters.upa.valueadd.reactor.ReactorErrorInfo), shutdown(com.thomsonreuters.upa.valueadd.reactor.ReactorErrorInfo), connect(com.thomsonreuters.upa.valueadd.reactor.ReactorConnectOptions, com.thomsonreuters.upa.valueadd.reactor.ReactorRole, com.thomsonreuters.upa.valueadd.reactor.ReactorErrorInfo), accept(com.thomsonreuters.upa.transport.Server, com.thomsonreuters.upa.valueadd.reactor.ReactorAcceptOptions, com.thomsonreuters.upa.valueadd.reactor.ReactorRole, com.thomsonreuters.upa.valueadd.reactor.ReactorErrorInfo), ReactorChannel.dispatch(com.thomsonreuters.upa.valueadd.reactor.ReactorDispatchOptions, com.thomsonreuters.upa.valueadd.reactor.ReactorErrorInfo), dispatchAll(java.util.Set<java.nio.channels.SelectionKey>, com.thomsonreuters.upa.valueadd.reactor.ReactorDispatchOptions, com.thomsonreuters.upa.valueadd.reactor.ReactorErrorInfo), ReactorChannel.submit(com.thomsonreuters.upa.transport.TransportBuffer, com.thomsonreuters.upa.valueadd.reactor.ReactorSubmitOptions, com.thomsonreuters.upa.valueadd.reactor.ReactorErrorInfo), ReactorChannel.close(com.thomsonreuters.upa.valueadd.reactor.ReactorErrorInfo)

Method Summary

Modifier and Type	Method and Description
int	accept(com.thomsonreuters.upa.transport.Server server, ReactorAcceptOptions reactorAcceptOptions, ReactorRole role, ReactorErrorInfo errorInfo) Adds a server-side channel to the Reactor.
int	connect(ReactorConnectOptions reactorConnectOptions, ReactorRole role, ReactorErrorInfo errorInfo) Adds a client-side channel to the Reactor.
int	dispatchAll(java.util.Set<java.nio.channels.SelectionKey> keySet, ReactorDispatchOptions dispatchOptions, ReactorErrorInfo errorInfo) Process all channels' events and messages from the Reactor.
boolean	isShutdown() Returns whether or not the Reactor is shutdown.
int	queryServiceDiscovery(ReactorServiceDiscoveryOptions options, ReactorErrorInfo errorInfo) Queries EDP-RT service discovery to get service endpoint information.
ReactorChannel	reactorChannel() The Reactor's internal channel that's used to communicate with the worker thread.
int	shutdown(ReactorErrorInfo errorInfo) Shuts down and cleans up a Reactor.
int	submitChannel(ReactorChannel reactorChannel, MsgBase rdmMsg, ReactorSubmitOptions submitOptions, ReactorErrorInfo errorInfo)
java.lang.Object	userSpecObj() Returns the userSpecObj that was specified in the ReactorOptions when this Reactor was created.

Methods inherited from class java.lang.Object

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

Method Detail

userSpecObj

public java.lang.Object userSpecObj()

Returns the userSpecObj that was specified in the ReactorOptions when this Reactor was created.

Returns:

the userSpecObj

isShutdown

public boolean isShutdown()

Returns whether or not the Reactor is shutdown.

Returns:

true if the Reactor is shutdown, or false if it isn't

shutdown

public int shutdown(ReactorErrorInfo errorInfo)

Shuts down and cleans up a Reactor. Stops the UPA Reactor if necessary and sends ReactorChannelEvents to all active channels indicating that they are down. Once this call is made, the Reactor is destroyed and no further calls should be made with it.

Parameters:

errorInfo - Error structure to be populated in the event of an error

Returns:

ReactorReturnCodes indicating success or failure

reactorChannel

public ReactorChannel reactorChannel()

The Reactor's internal channel that's used to communicate with the worker thread.

Returns:

the Reactor's internal channel

accept

public int accept(com.thomsonreuters.upa.transport.Server server,
                  ReactorAcceptOptions reactorAcceptOptions,
                  ReactorRole role,
                  ReactorErrorInfo errorInfo)

Adds a server-side channel to the Reactor. Once the channel is initialized, the channelEventCallback will receive an event indicating that the channel is up.

Parameters:

server - server that is accepting this connection (a server can be created with Transport.bind(com.thomsonreuters.upa.transport.BindOptions, com.thomsonreuters.upa.transport.Error))

reactorAcceptOptions - options for this connection

role - role of this connection

errorInfo - error structure to be populated in the event of failure

Returns:

ReactorReturnCodes indicating success or failure

connect

public int connect(ReactorConnectOptions reactorConnectOptions,
                   ReactorRole role,
                   ReactorErrorInfo errorInfo)

Adds a client-side channel to the Reactor. Once the channel is initialized, the channelEventCallback will receive an event indicating that the channel is up.

Parameters:

reactorConnectOptions - options for this connection

role - role of this connection

errorInfo - error structure to be populated in the event of failure

Returns:

ReactorReturnCodes indicating success or failure

queryServiceDiscovery

public int queryServiceDiscovery(ReactorServiceDiscoveryOptions options,
                                 ReactorErrorInfo errorInfo)

Queries EDP-RT service discovery to get service endpoint information.

Parameters:

options - The ReactorServiceDiscoveryOptions to configure options and specify the ReactorServiceEndpointEventCallback to receive service endpoint information.

errorInfo - error structure to be populated in the event of failure

Returns:

ReactorReturnCodes indicating success or failure

submitChannel

public int submitChannel(ReactorChannel reactorChannel,
                         MsgBase rdmMsg,
                         ReactorSubmitOptions submitOptions,
                         ReactorErrorInfo errorInfo)

dispatchAll

public int dispatchAll(java.util.Set<java.nio.channels.SelectionKey> keySet,
                       ReactorDispatchOptions dispatchOptions,
                       ReactorErrorInfo errorInfo)

Process all channels' events and messages from the Reactor. These are passed to the calling application via the the callback methods associated with each of the channels. If keySet parameter is non-null, events and messages are processed from the channels associated with keys in the selected key set. Once processed, keys are removed from the selected key set. If keySet parameter is null, events and messages are processed from all channels in a round-robin manner.

Parameters:

keySet - key set from the selector's registered channels

dispatchOptions - options for how to dispatch

errorInfo - error structure to be populated in the event of failure

Returns:

a positive value if dispatching succeeded and there are more messages to process or ReactorReturnCodes.SUCCESS if dispatching succeeded and there are no more messages to process or ReactorReturnCodes.FAILURE, if dispatching failed (refer to errorInfo for additional information)