com.thomsonreuters.upa.valueadd.reactor

Class ReactorChannel

java.lang.Object

com.thomsonreuters.upa.valueadd.common.VaNode

com.thomsonreuters.upa.valueadd.reactor.ReactorChannel

public class ReactorChannel
extends VaNode

Channel representing a connection handled by a Reactor.

See Also:

Reactor, Reactor.connect(com.thomsonreuters.upa.valueadd.reactor.ReactorConnectOptions, com.thomsonreuters.upa.valueadd.reactor.ReactorRole, com.thomsonreuters.upa.valueadd.reactor.ReactorErrorInfo), Reactor.accept(com.thomsonreuters.upa.transport.Server, com.thomsonreuters.upa.valueadd.reactor.ReactorAcceptOptions, com.thomsonreuters.upa.valueadd.reactor.ReactorRole, com.thomsonreuters.upa.valueadd.reactor.ReactorErrorInfo), close(com.thomsonreuters.upa.valueadd.reactor.ReactorErrorInfo)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReactorChannel.State The ReactorChannel's state.

Constructor Summary

Constructors

Constructor and Description
ReactorChannel()

Method Summary

Modifier and Type	Method and Description
int	acceptTunnelStream(TunnelStreamRequestEvent event, TunnelStreamAcceptOptions options, ReactorErrorInfo errorInfo) Accept a tunnel stream for a ReactorChannel.
int	bufferUsage(ReactorErrorInfo errorInfo) Retrieve the total number of used buffers for a ReactorChannel.
com.thomsonreuters.upa.transport.Channel	channel() The Channel associated with this ReactorChannel.
int	close(ReactorErrorInfo errorInfo) Closes a reactor channel and removes it from the Reactor.
int	dispatch(ReactorDispatchOptions dispatchOptions, ReactorErrorInfo errorInfo) Process this channel's events and messages from the Reactor.
com.thomsonreuters.upa.transport.TransportBuffer	getBuffer(int size, boolean packedBuffer, ReactorErrorInfo errorInfo) Gets a buffer from the ReactorChannel for writing a message.
java.lang.String	hostname() provides the name of the host to which a consumer or niprovider application is connected.
int	info(ReactorChannelInfo info, ReactorErrorInfo errorInfo) Returns information about the ReactorChannel.
int	ioctl(int code, int value, ReactorErrorInfo errorInfo) Changes some aspects of the ReactorChannel.
int	majorVersion() When a ReactorChannel becomes active for a client or server, this is populated with the negotiated major version number that is associated with the content being sent on this connection.
int	minorVersion() When a ReactorChannel becomes active for a client or server, this is populated with the negotiated minor version number that is associated with the content being sent on this connection.
java.nio.channels.SelectableChannel	oldSelectableChannel() The old SelectableChannel associated with this ReactorChannel.
int	openTunnelStream(TunnelStreamOpenOptions options, ReactorErrorInfo errorInfo) Open a tunnel stream for a ReactorChannel.
int	packBuffer(com.thomsonreuters.upa.transport.TransportBuffer buffer, ReactorErrorInfo errorInfo) Packs a buffer and returns the amount of available bytes remaining in the buffer for packing.
int	protocolType() When a ReactorChannel becomes active for a client or server, this is populated with the protocolType associated with the content being sent on this connection.
Reactor	reactor() The Reactor associated with this ReactorChannel.
void	reactor(Reactor reactor) Sets the Reactor associated with this ReactorChannel.
int	rejectTunnelStream(TunnelStreamRequestEvent event, TunnelStreamRejectOptions options, ReactorErrorInfo errorInfo) Reject a tunnel stream for a ReactorChannel.
int	releaseBuffer(com.thomsonreuters.upa.transport.TransportBuffer buffer, ReactorErrorInfo errorInfo) Returns an unwritten buffer to the ReactorChannel.
java.nio.channels.SelectableChannel	selectableChannel() The SelectableChannel associated with this ReactorChannel.
com.thomsonreuters.upa.transport.Server	server() The Server associated with this ReactorChannel.
ReactorChannel.State	state() The state of the ReactorChannel.
int	submit(MsgBase rdmMsg, ReactorSubmitOptions submitOptions, ReactorErrorInfo errorInfo) Sends an RDM message to the channel.
int	submit(com.thomsonreuters.upa.codec.Msg msg, ReactorSubmitOptions submitOptions, ReactorErrorInfo errorInfo) Sends a message to the channel.
int	submit(com.thomsonreuters.upa.transport.TransportBuffer buffer, ReactorSubmitOptions submitOptions, ReactorErrorInfo errorInfo) Sends the given TransportBuffer to the channel.
java.lang.String	toString() Returns a String representation of this object.
java.lang.Object	userSpecObj() The user specified object associated with this ReactorChannel.

Methods inherited from class com.thomsonreuters.upa.valueadd.common.VaNode

inPool, next, next, returnToPool

Methods inherited from class java.lang.Object

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

Constructor Detail

ReactorChannel

public ReactorChannel()

Method Detail

state

public ReactorChannel.State state()

The state of the ReactorChannel.

Returns:

the state of the ReactorChannel

toString

public java.lang.String toString()

Returns a String representation of this object.

Overrides:

toString in class java.lang.Object

Returns:

string representation of this object

reactor

public Reactor reactor()

The Reactor associated with this ReactorChannel.

Returns:

the associated Reactor

reactor

public void reactor(Reactor reactor)

Sets the Reactor associated with this ReactorChannel.

Parameters:

reactor - the associated Reactor

oldSelectableChannel

public java.nio.channels.SelectableChannel oldSelectableChannel()

The old SelectableChannel associated with this ReactorChannel. Must be unregistered when handling a ReactorChannelEventTypes.FD_CHANGE event.

Returns:

old SelectableChannel

selectableChannel

public java.nio.channels.SelectableChannel selectableChannel()

The SelectableChannel associated with this ReactorChannel. Used to register with a selector.

Returns:

SelectableChannel

channel

public com.thomsonreuters.upa.transport.Channel channel()

The Channel associated with this ReactorChannel.

Returns:

Channel

server

public com.thomsonreuters.upa.transport.Server server()

The Server associated with this ReactorChannel.

Returns:

Server

userSpecObj

public java.lang.Object userSpecObj()

The user specified object associated with this ReactorChannel.

Returns:

user specified object

dispatch

public int dispatch(ReactorDispatchOptions dispatchOptions,
                    ReactorErrorInfo errorInfo)

Process this channel's events and messages from the Reactor. These are passed to the calling application via the callback methods associated with the channel.

Parameters:

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)

submit

public int submit(com.thomsonreuters.upa.transport.TransportBuffer buffer,
                  ReactorSubmitOptions submitOptions,
                  ReactorErrorInfo errorInfo)

Sends the given TransportBuffer to the channel.

Parameters:

buffer - the buffer to send

submitOptions - options for how to send the message

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

Returns:

ReactorReturnCodes.SUCCESS, if submit succeeded or ReactorReturnCodes.WRITE_CALL_AGAIN, if the buffer cannot be written at this time or ReactorReturnCodes.FAILURE, if submit failed (refer to errorInfo for additional information)

submit

public int submit(com.thomsonreuters.upa.codec.Msg msg,
                  ReactorSubmitOptions submitOptions,
                  ReactorErrorInfo errorInfo)

Sends a message to the channel.

Parameters:

msg - the message to send

submitOptions - options for how to send the message

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

Returns:

ReactorReturnCodes.SUCCESS, if submit succeeded or ReactorReturnCodes.WRITE_CALL_AGAIN, if the message cannot be written at this time or ReactorReturnCodes.NO_BUFFERS, if there are no more buffers to encode the message into or ReactorReturnCodes.FAILURE, if submit failed (refer to errorInfo for additional information)

submit

public int submit(MsgBase rdmMsg,
                  ReactorSubmitOptions submitOptions,
                  ReactorErrorInfo errorInfo)

Sends an RDM message to the channel.

Parameters:

rdmMsg - the RDM message to send

submitOptions - options for how to send the message

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

Returns:

ReactorReturnCodes.SUCCESS, if submit succeeded or ReactorReturnCodes.WRITE_CALL_AGAIN, if the message cannot be written at this time or ReactorReturnCodes.NO_BUFFERS, if there are no more buffers to encode the message into or ReactorReturnCodes.FAILURE, if submit failed (refer to errorInfo for additional information)

close

public int close(ReactorErrorInfo errorInfo)

Closes a reactor channel and removes it from the Reactor. May be called inside or outside of a callback function, however the channel should no longer be used afterwards.

Parameters:

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

Returns:

ReactorReturnCodes indicating success or failure

getBuffer

public com.thomsonreuters.upa.transport.TransportBuffer getBuffer(int size,
                                                                  boolean packedBuffer,
                                                                  ReactorErrorInfo errorInfo)

Gets a buffer from the ReactorChannel for writing a message.

Parameters:

size - the size(in bytes) of the buffer to get

packedBuffer - whether the buffer allows packing multiple messages via packBuffer(TransportBuffer, ReactorErrorInfo)

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

Returns:

the buffer for writing the message or null, if an error occurred (errorInfo will be populated with information)

releaseBuffer

public int releaseBuffer(com.thomsonreuters.upa.transport.TransportBuffer buffer,
                         ReactorErrorInfo errorInfo)

Returns an unwritten buffer to the ReactorChannel.

Parameters:

buffer - the buffer to release

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

Returns:

ReactorReturnCodes indicating success or failure

packBuffer

public int packBuffer(com.thomsonreuters.upa.transport.TransportBuffer buffer,
                      ReactorErrorInfo errorInfo)

Packs a buffer and returns the amount of available bytes remaining in the buffer for packing.

Parameters:

buffer - the buffer to be packed

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

Returns:

ReactorReturnCodes or the amount of available bytes remaining in the buffer for packing

info

public int info(ReactorChannelInfo info,
                ReactorErrorInfo errorInfo)

Returns information about the ReactorChannel.

Parameters:

info - ReactorChannelInfo structure to be populated with information

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

Returns:

ReactorReturnCodes indicating success or failure

bufferUsage

public int bufferUsage(ReactorErrorInfo errorInfo)

Retrieve the total number of used buffers for a ReactorChannel.

Parameters:

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

Returns:

if positive, the total number of buffers in use by this channel or if negative, ReactorReturnCodes failure code

ioctl

public int ioctl(int code,
                 int value,
                 ReactorErrorInfo errorInfo)

Changes some aspects of the ReactorChannel.

Parameters:

code - code indicating the option to change

value - value to change the option to

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

Returns:

ReactorReturnCodes indicating success or failure

See Also:

IoctlCodes

majorVersion

public int majorVersion()

When a ReactorChannel becomes active for a client or server, this is populated with the negotiated major version number that is associated with the content being sent on this connection. Typically, a major version increase is associated with the introduction of incompatible change. The transport layer is data neutral and does not change nor depend on any information in content being distributed. This information is provided to help client and server applications manage the information they are communicating.

Returns:

the majorVersion

hostname

public java.lang.String hostname()

provides the name of the host to which a consumer or niprovider application is connected.

Returns:

the host name

minorVersion

public int minorVersion()

When a ReactorChannel becomes active for a client or server, this is populated with the negotiated minor version number that is associated with the content being sent on this connection. Typically, a minor version increase is associated with a fully backward compatible change or extension. The transport layer is data neutral and does not change nor depend on any information in content being distributed. This information is provided to help client and server applications manage the information they are communicating.

Returns:

the minorVersion

protocolType

public int protocolType()

When a ReactorChannel becomes active for a client or server, this is populated with the protocolType associated with the content being sent on this connection. If the protocolType indicated by a server does not match the protocolType that a client specifies, the connection will be rejected. The transport layer is data neutral and does not change nor depend on any information in content being distributed. This information is provided to help client and server applications manage the information they are communicating.

Returns:

the protocolType

openTunnelStream

public int openTunnelStream(TunnelStreamOpenOptions options,
                            ReactorErrorInfo errorInfo)

Open a tunnel stream for a ReactorChannel. Used by TunnelStream consumers. Once the TunnelStream is created, use it to send messages to and receive messages from the tunnel stream.

Parameters:

options - the options for opening the tunnel stream

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

Returns:

ReactorReturnCodes indicating success or failure

See Also:

TunnelStreamOpenOptions

acceptTunnelStream

public int acceptTunnelStream(TunnelStreamRequestEvent event,
                              TunnelStreamAcceptOptions options,
                              ReactorErrorInfo errorInfo)

Accept a tunnel stream for a ReactorChannel. Used by TunnelStream providers. Once the TunnelStream is accepted, use it to send messages to and receive messages from the tunnel stream.

Parameters:

event - the request information of the tunnel stream request to accept

options - the options for accepting the tunnel stream

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

Returns:

ReactorReturnCodes indicating success or failure

See Also:

TunnelStreamRequestEvent, TunnelStreamAcceptOptions

rejectTunnelStream

public int rejectTunnelStream(TunnelStreamRequestEvent event,
                              TunnelStreamRejectOptions options,
                              ReactorErrorInfo errorInfo)

Reject a tunnel stream for a ReactorChannel. Used by TunnelStream providers.

Parameters:

event - the request information of the tunnel stream request to reject

options - the options for rejecting the tunnel stream

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

Returns:

ReactorReturnCodes indicating success or failure

See Also:

TunnelStreamRequestEvent