com.thomsonreuters.upa.valueadd.reactor

Class TunnelStreamOpenOptions

java.lang.Object

com.thomsonreuters.upa.valueadd.reactor.TunnelStreamOpenOptions

public class TunnelStreamOpenOptions
extends java.lang.Object

The options for opening a TunnelStream.

See Also:

TunnelStream, ReactorChannel.openTunnelStream(TunnelStreamOpenOptions, ReactorErrorInfo)

Constructor Summary

Constructors

Constructor and Description
TunnelStreamOpenOptions()

Method Summary

Modifier and Type	Method and Description
LoginRequest	authLoginRequest() Returns the login request to send, if using authentication.
void	authLoginRequest(LoginRequest loginRequest) Sets the login request to send, if using authentication.
ClassOfService	classOfService() Returns the class of service of the TunnelStream.
void	clear() Clears the TunnelStreamOpenOptions for re-use.
TunnelStreamDefaultMsgCallback	defaultMsgCallback() The TunnelStreamDefaultMsgCallback of the TunnelStream.
void	defaultMsgCallback(TunnelStreamDefaultMsgCallback callback) The TunnelStreamDefaultMsgCallback of the TunnelStream.
int	domainType() Returns the domain type of the TunnelStream.
void	domainType(int domainType) Sets the domain type of the TunnelStream.
int	guaranteedOutputBuffers() Returns the number of guaranteed output buffers that will be available for the tunnel stream.
int	guaranteedOutputBuffers(int numBuffers) Sets the number of guaranteed output buffers that will be available for the tunnel stream.
java.lang.String	name() Returns the name of the TunnelStream.
void	name(java.lang.String name) Sets the name of the TunnelStream.
TunnelStreamQueueMsgCallback	queueMsgCallback() The QueueMsgCallback of the TunnelStream.
void	queueMsgCallback(TunnelStreamQueueMsgCallback callback) The QueueMsgCallback of the TunnelStream.
int	responseTimeout() Returns the response timeout value.
int	responseTimeout(int timeout) The amount of time (in seconds) to wait for a provider to respond to a TunnelStream open request.
int	serviceId() Returns the service identifier of the TunnelStream.
void	serviceId(int serviceId) Sets the service identifier of the TunnelStream.
TunnelStreamStatusEventCallback	statusEventCallback() The TunnelStreamStatusEventCallback of the TunnelStream.
void	statusEventCallback(TunnelStreamStatusEventCallback callback) The TunnelStreamStatusEventCallback of the TunnelStream.
int	streamId() Returns the stream id of the TunnelStream.
void	streamId(int streamId) Sets the stream id of the TunnelStream.
java.lang.Object	userSpecObject() Returns the user specified object to be set on the TunnelStream.
void	userSpecObject(java.lang.Object userSpecObject) Sets a user specified object to be set on the TunnelStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

TunnelStreamOpenOptions

public TunnelStreamOpenOptions()

Method Detail

domainType

public int domainType()

Returns the domain type of the TunnelStream.

Returns:

the int

domainType

public void domainType(int domainType)

Sets the domain type of the TunnelStream.

Parameters:

domainType - the domain type

streamId

public int streamId()

Returns the stream id of the TunnelStream.

Returns:

the int

streamId

public void streamId(int streamId)

Sets the stream id of the TunnelStream.

Parameters:

streamId - the stream id

serviceId

public int serviceId()

Returns the service identifier of the TunnelStream.

Returns:

the int

serviceId

public void serviceId(int serviceId)

Sets the service identifier of the TunnelStream.

Parameters:

serviceId - the service id

responseTimeout

public int responseTimeout(int timeout)

The amount of time (in seconds) to wait for a provider to respond to a TunnelStream open request. If the provider does not respond in time, a TunnelStreamStatusEvent is sent to the application to indicate the TunnelStream could not be opened. Timeout must be greater than zero. Default is 60 seconds.

Parameters:

timeout - the response timeout in seconds

Returns:

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

responseTimeout

public int responseTimeout()

Returns the response timeout value.

Returns:

the response timeout value

guaranteedOutputBuffers

public int guaranteedOutputBuffers(int numBuffers)

Sets the number of guaranteed output buffers that will be available for the tunnel stream. Must be greater than 0.

Parameters:

numBuffers - the number of guaranteed output buffers

Returns:

ReactorReturnCodes.SUCCESS if the number of guaranteed output buffers is valid, otherwise ReactorReturnCodes.PARAMETER_OUT_OF_RANGE if the number of guaranteed output buffers is out of range

guaranteedOutputBuffers

public int guaranteedOutputBuffers()

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

Returns:

the number of guaranteed output buffers

statusEventCallback

public void statusEventCallback(TunnelStreamStatusEventCallback callback)

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

Parameters:

callback - the callback

statusEventCallback

public TunnelStreamStatusEventCallback statusEventCallback()

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

Returns:

the tunnelStreamDefaultMsgCallback

defaultMsgCallback

public void defaultMsgCallback(TunnelStreamDefaultMsgCallback callback)

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

Parameters:

callback - the callback

defaultMsgCallback

public TunnelStreamDefaultMsgCallback defaultMsgCallback()

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

Returns:

the tunnelStreamDefaultMsgCallback

queueMsgCallback

public void queueMsgCallback(TunnelStreamQueueMsgCallback callback)

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

Parameters:

callback - the callback

queueMsgCallback

public TunnelStreamQueueMsgCallback queueMsgCallback()

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

Returns:

the queueMsgCallback

authLoginRequest

public LoginRequest authLoginRequest()

Returns the login request to send, if using authentication.

Returns:

the login request

authLoginRequest

public void authLoginRequest(LoginRequest loginRequest)

Sets the login request to send, if using authentication.

Parameters:

loginRequest - the login request

name

public java.lang.String name()

Returns the name of the TunnelStream.

Returns:

the string

name

public void name(java.lang.String name)

Sets the name of the TunnelStream. Length of the name must be in the range of 0-255.

Parameters:

name - the name

userSpecObject

public java.lang.Object userSpecObject()

Returns the user specified object to be set on the TunnelStream.

Returns:

the object

userSpecObject

public void userSpecObject(java.lang.Object userSpecObject)

Sets a user specified object to be set on the TunnelStream.

Parameters:

userSpecObject - the user spec object

classOfService

public ClassOfService classOfService()

Returns the class of service of the TunnelStream. Use to set class of service for the TunnelStream.

Returns:

the class of service

See Also:

ClassOfService

clear

public void clear()

Clears the TunnelStreamOpenOptions for re-use.