com.thomsonreuters.upa.valueadd.reactor

Class TunnelStream

java.lang.Object

com.thomsonreuters.upa.valueadd.reactor.TunnelStream

public class TunnelStream
extends java.lang.Object

Class to operate upon a TunnelStream. A tunnel stream is a private stream that supports interactions with guaranteed messaging and other auxiliary services.

Constructor Summary

Constructors

Constructor and Description
TunnelStream(ReactorChannel reactorChannel, TunnelStreamOpenOptions options) Creates a consumer-side tunnel stream.
TunnelStream(ReactorChannel reactorChannel, TunnelStreamRequestEvent event, TunnelStreamAcceptOptions options) Creates a provider-side tunnel stream.

Method Summary

Modifier and Type	Method and Description
ClassOfService	classOfService() The class of service of the tunnel stream.
int	close(boolean finalStatusEvent, ReactorErrorInfo errorInfo) Closes the tunnel stream.
TunnelStreamDefaultMsgCallback	defaultMsgCallback() The TunnelStreamDefaultMsgCallback of the TunnelStream.
int	domainType() The domain type of the tunnel stream.
com.thomsonreuters.upa.transport.TransportBuffer	getBuffer(int size, ReactorErrorInfo errorInfo) Gets a buffer from the TunnelStream for writing a message.
int	guaranteedOutputBuffers() The number of guaranteed output buffers that will be available for the tunnel stream.
boolean	isProvider() Returns whether or not this is a provider tunnel stream.
java.lang.String	name() The name of the TunnelStream.
TunnelStreamQueueMsgCallback	queueMsgCallback() The QueueMsgCallback of the TunnelStream.
ReactorChannel	reactorChannel() The reactor channel associated with the tunnel stream.
int	releaseBuffer(com.thomsonreuters.upa.transport.TransportBuffer buffer, ReactorErrorInfo errorInfo) Returns an unwritten buffer to the TunnelStream.
int	serviceId() The service identifier of the tunnel stream.
com.thomsonreuters.upa.codec.State	state() The current known state of the tunnel stream, as indicated by the last received response.
TunnelStreamStatusEventCallback	statusEventCallback() The TunnelStreamStatusEventCallback of the TunnelStream.
int	streamId() The stream id of the tunnel stream.
int	submit(MsgBase rdmMsg, ReactorErrorInfo errorInfo) Sends an RDM message to the tunnel stream.
int	submit(com.thomsonreuters.upa.codec.Msg msg, ReactorErrorInfo errorInfo) Sends a message to the tunnel stream.
int	submit(com.thomsonreuters.upa.transport.TransportBuffer buffer, TunnelStreamSubmitOptions options, ReactorErrorInfo errorInfo) Sends a buffer to the tunnel stream.
java.lang.Object	userSpecObject() A user specified object, possibly a closure.

Methods inherited from class java.lang.Object

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

Constructor Detail

TunnelStream

public TunnelStream(ReactorChannel reactorChannel,
                    TunnelStreamOpenOptions options)

Creates a consumer-side tunnel stream.

Parameters:

reactorChannel - the reactor channel

options - the options

TunnelStream

public TunnelStream(ReactorChannel reactorChannel,
                    TunnelStreamRequestEvent event,
                    TunnelStreamAcceptOptions options)

Creates a provider-side tunnel stream.

Parameters:

reactorChannel - the reactor channel

event - the event

options - the options

Method Detail

getBuffer

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

Gets a buffer from the TunnelStream for writing a message.

Parameters:

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

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 TunnelStream.

Parameters:

buffer - the buffer to release

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

Returns:

ReactorReturnCodes indicating success or failure

submit

public int submit(com.thomsonreuters.upa.transport.TransportBuffer buffer,
                  TunnelStreamSubmitOptions options,
                  ReactorErrorInfo errorInfo)

Sends a buffer to the tunnel stream.

Parameters:

buffer - the buffer to send

options - the options

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

Returns:

ReactorReturnCodes.SUCCESS, if submit succeeded or ReactorReturnCodes.PERSISTENCE_FULL, if the persistence file is full or ReactorReturnCodes.INVALID_ENCODING, if the buffer encoding is invalid or ReactorReturnCodes.FAILURE, if submit failed (refer to errorInfo for additional information)

submit

public int submit(MsgBase rdmMsg,
                  ReactorErrorInfo errorInfo)

Sends an RDM message to the tunnel stream.

Parameters:

rdmMsg - the RDM message to send

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

Returns:

ReactorReturnCodes.SUCCESS, if submit succeeded or ReactorReturnCodes.PERSISTENCE_FULL, if the persistence file is full or ReactorReturnCodes.FAILURE, if submit failed (refer to errorInfo for additional information)

submit

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

Sends a message to the tunnel stream.

Parameters:

msg - the message to send

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

Returns:

ReactorReturnCodes.SUCCESS, if submit succeeded or ReactorReturnCodes.FAILURE, if submit failed (refer to errorInfo for additional information)

close

public int close(boolean finalStatusEvent,
                 ReactorErrorInfo errorInfo)

Closes the tunnel stream. The finalStatusEvent argument indicates that the application wishes to receive a final TunnelStreamStatusEvent when the closing of the tunnel stream to the remote end is complete. If this is set to true, the tunnel stream will be cleaned up once the final TunnelStreamStatusEvent event is provided to the application. This is indicated by a non-open state.streamState on the event such as StreamStates.CLOSED or StreamStates.CLOSED_RECOVER.

Parameters:

finalStatusEvent - if true, a final TunnelStreamStatusEvent is provided to the application when the closing of the tunnel stream to the remote end is complete

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

Returns:

ReactorReturnCodes indicating success or failure

streamId

public int streamId()

The stream id of the tunnel stream.

Returns:

the stream id

domainType

public int domainType()

The domain type of the tunnel stream.

Returns:

the domain type

serviceId

public int serviceId()

The service identifier of the tunnel stream.

Returns:

the service id

classOfService

public ClassOfService classOfService()

The class of service of the tunnel stream.

Returns:

the ClassOfService

See Also:

ClassOfService

guaranteedOutputBuffers

public int guaranteedOutputBuffers()

The number of guaranteed output buffers that will be available for the tunnel stream.

Returns:

the number of guaranteed output buffers

statusEventCallback

public TunnelStreamStatusEventCallback statusEventCallback()

The TunnelStreamStatusEventCallback of the TunnelStream. Handles stream events for tunnel stream.

Returns:

the tunnelStreamDefaultMsgCallback

defaultMsgCallback

public TunnelStreamDefaultMsgCallback defaultMsgCallback()

The TunnelStreamDefaultMsgCallback of the TunnelStream. Handles message events for tunnel stream.

Returns:

the tunnelStreamDefaultMsgCallback

queueMsgCallback

public TunnelStreamQueueMsgCallback queueMsgCallback()

The QueueMsgCallback of the TunnelStream. Handles message events for queue message streams.

Returns:

the queueMsgCallback

name

public java.lang.String name()

The name of the TunnelStream.

Returns:

the TunnelStream name

userSpecObject

public java.lang.Object userSpecObject()

A user specified object, possibly a closure. This information can be useful for coupling this TunnelStream with other user created information, such as a watch list associated with it.

Returns:

the userSpecObject

state

public com.thomsonreuters.upa.codec.State state()

The current known state of the tunnel stream, as indicated by the last received response.

Returns:

the current state

reactorChannel

public ReactorChannel reactorChannel()

The reactor channel associated with the tunnel stream.

Returns:

the reactor channel

isProvider

public boolean isProvider()

Returns whether or not this is a provider tunnel stream.

Returns:

true, if is provider