com.thomsonreuters.upa.valueadd.reactor

Class TunnelStreamAcceptOptions

java.lang.Object

com.thomsonreuters.upa.valueadd.reactor.TunnelStreamAcceptOptions

public class TunnelStreamAcceptOptions
extends java.lang.Object

The options for accepting a TunnelStream.

See Also:

TunnelStream, ReactorChannel.acceptTunnelStream(TunnelStreamRequestEvent, TunnelStreamAcceptOptions, ReactorErrorInfo)

Constructor Summary

Constructors

Constructor and Description
TunnelStreamAcceptOptions()

Method Summary

Modifier and Type	Method and Description
ClassOfService	classOfService() Returns the class of service of the TunnelStream.
void	clear() Clears the TunnelStreamAcceptOptions for re-use.
TunnelStreamDefaultMsgCallback	defaultMsgCallback() The TunnelStreamDefaultMsgCallback of the accepted TunnelStream.
void	defaultMsgCallback(TunnelStreamDefaultMsgCallback callback) The TunnelStreamDefaultMsgCallback of the accepted 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.
TunnelStreamStatusEventCallback	statusEventCallback() The TunnelStreamStatusEventCallback of the accepted TunnelStream.
void	statusEventCallback(TunnelStreamStatusEventCallback callback) The TunnelStreamStatusEventCallback of the accepted 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

TunnelStreamAcceptOptions

public TunnelStreamAcceptOptions()

Method Detail

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

statusEventCallback

public void statusEventCallback(TunnelStreamStatusEventCallback callback)

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

Parameters:

callback - the callback

statusEventCallback

public TunnelStreamStatusEventCallback statusEventCallback()

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

Returns:

the tunnelStreamDefaultMsgCallback

defaultMsgCallback

public void defaultMsgCallback(TunnelStreamDefaultMsgCallback callback)

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

Parameters:

callback - the callback

defaultMsgCallback

public TunnelStreamDefaultMsgCallback defaultMsgCallback()

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

Returns:

the tunnelStreamDefaultMsgCallback

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

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

clear

public void clear()

Clears the TunnelStreamAcceptOptions for re-use.