EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
List of all members | Friends
thomsonreuters::ema::access::TunnelStreamRequest Class Reference

TunnelStreamRequest encapsulates tunnel stream request parameters. More...

Public Member Functions

Constructor
 TunnelStreamRequest ()
 
 TunnelStreamRequest (const TunnelStreamRequest &other)
 
Destructor
virtual ~TunnelStreamRequest ()
 
Operations
TunnelStreamRequestoperator= (const TunnelStreamRequest &other)
 
TunnelStreamRequestclear ()
 
TunnelStreamRequestdomainType (UInt8 domainType)
 
TunnelStreamRequestserviceId (UInt32 serviceId)
 
TunnelStreamRequestserviceName (const EmaString &serviceName)
 
TunnelStreamRequestname (const EmaString &name)
 
TunnelStreamRequestresponseTimeout (UInt32 timeout=60)
 
TunnelStreamRequestguaranteedOutputBuffers (UInt32 value=50)
 
TunnelStreamRequestclassOfService (const ClassOfService &cos)
 
TunnelStreamRequestloginReqMsg (const ReqMsg &loginReq)
 
Accessors
bool hasServiceId () const
 
bool hasServiceName () const
 
bool hasName () const
 
bool hasLoginReqMsg () const
 
UInt16 getDomainType () const
 
UInt32 getServiceId () const
 
const EmaStringgetServiceName () const
 
const EmaStringgetName () const
 
UInt32 getResponseTimeOut () const
 
UInt32 getGuaranteedOutputBuffers () const
 
const ClassOfServicegetClassOfService () const
 
const ReqMsggetLoginReqMsg () const
 

Friends

class TunnelItem
 

Detailed Description

TunnelStreamRequest contains options used for creation of a tunnel stream.

// create and populate TunnelStreamRequest object
ClassOfService cos;
cos.authentication( CosAuthentication().type( CosAuthentication::OmmLoginEnum ) )
.dataIntegrity( CosDataIntegrity().type( CosDataIntegrity::ReliableEnum ) )
.flowControl( CosFlowControl().type( CosFlowControl::BidirectionalEnum )
.recvWindowSize( 1200 )
.sendWindowSize( 1200 ) )
.guarantee( CosGuarantee().type( CosGuarantee::NoneEnum ) );
tsr.classOfService( cos )
.domainType( MMT_SYSTEM )
.name( "TUNNEL_STREAM" )
.serviceId( 1 )
.responseTimeout( 45 );
See Also
ClassOfService, OmmConsumer

Definition at line 586 of file TunnelStreamRequest.h.

Constructor & Destructor Documentation

thomsonreuters::ema::access::TunnelStreamRequest::TunnelStreamRequest ( )

Default constructor

thomsonreuters::ema::access::TunnelStreamRequest::TunnelStreamRequest ( const TunnelStreamRequest other)

Copy constructor

Parameters
[in]otherspecifies TunnelStreamRequest object to copy from
virtual thomsonreuters::ema::access::TunnelStreamRequest::~TunnelStreamRequest ( )
virtual

Destructor

Member Function Documentation

TunnelStreamRequest& thomsonreuters::ema::access::TunnelStreamRequest::classOfService ( const ClassOfService cos)

Specifies the ClassOfService.

Parameters
[in]cosspecifies ClassOfService
Returns
reference to this object
TunnelStreamRequest& thomsonreuters::ema::access::TunnelStreamRequest::clear ( )

Clears object by setting defaults

Returns
reference to this object
TunnelStreamRequest& thomsonreuters::ema::access::TunnelStreamRequest::domainType ( UInt8  domainType)

Specifies DomainType.

Parameters
[in]domainTypespecifies RDM Message Model Type
Returns
reference to this object
Exceptions
OmmUnsupportedDomainTypeExceptionif domainType is greater than 255
const ClassOfService& thomsonreuters::ema::access::TunnelStreamRequest::getClassOfService ( ) const

Retursn ClassOfService.

Returns
class of service
UInt16 thomsonreuters::ema::access::TunnelStreamRequest::getDomainType ( ) const

Returns DomainType.

Returns
domain type
UInt32 thomsonreuters::ema::access::TunnelStreamRequest::getGuaranteedOutputBuffers ( ) const

Returns number of GuaranteedOutputBuffers.

Returns
number of guaranteed output buffers
const ReqMsg& thomsonreuters::ema::access::TunnelStreamRequest::getLoginReqMsg ( ) const

Returns Login request message

Returns
login request message
Exceptions
OmmInvalidUsageExceptionif login request message is not set
const EmaString& thomsonreuters::ema::access::TunnelStreamRequest::getName ( ) const

Returns tunnel stream name.

Returns
tunnel stream name
Exceptions
OmmInvalidUsageExceptionif name is not set
UInt32 thomsonreuters::ema::access::TunnelStreamRequest::getResponseTimeOut ( ) const

Returns ResponseTimeOut.

Returns
response timeOut
UInt32 thomsonreuters::ema::access::TunnelStreamRequest::getServiceId ( ) const

Returns ServiceId.

Returns
service id
Exceptions
OmmInvalidUsageExceptionif service id is not set
const EmaString& thomsonreuters::ema::access::TunnelStreamRequest::getServiceName ( ) const

Returns ServiceNme.

Returns
service name
Exceptions
OmmInvalidUsageExceptionif service name is not set
TunnelStreamRequest& thomsonreuters::ema::access::TunnelStreamRequest::guaranteedOutputBuffers ( UInt32  value = 50)

Specifies the number of guaranteed output buffers available for the tunnel stream.

Parameters
[in]valuespecifies number of output buffers
Returns
reference to this object
bool thomsonreuters::ema::access::TunnelStreamRequest::hasLoginReqMsg ( ) const

Indicates presence of login request message.

Returns
true if login request message is set
bool thomsonreuters::ema::access::TunnelStreamRequest::hasName ( ) const

Indicates presence of name

Returns
true if service name is set
bool thomsonreuters::ema::access::TunnelStreamRequest::hasServiceId ( ) const

Indicates presence of service id

Returns
true if service id is set
bool thomsonreuters::ema::access::TunnelStreamRequest::hasServiceName ( ) const

Indicates presence of service name

Returns
true if service name is set
TunnelStreamRequest& thomsonreuters::ema::access::TunnelStreamRequest::loginReqMsg ( const ReqMsg loginReq)

Specifies login request message to be used if authentication type is set to CosAuthentication::OmmLoginEnum.

Parameters
[in]loginReqspecifies the OMM login request message
Returns
reference to this object
Remarks
if not specified, OmmConsumer will use same login request message as one used for establihment of the connection
TunnelStreamRequest& thomsonreuters::ema::access::TunnelStreamRequest::name ( const EmaString name)

Specifies the tunnel stream name, which is provided to the remote application.

Parameters
[in]namespecifies tunnel stream name
Returns
reference to this object
TunnelStreamRequest& thomsonreuters::ema::access::TunnelStreamRequest::operator= ( const TunnelStreamRequest other)

Assignment operator

Parameters
[in]otherspecifies TunnelStreamRequest object to copy from
Returns
reference to this object
TunnelStreamRequest& thomsonreuters::ema::access::TunnelStreamRequest::responseTimeout ( UInt32  timeout = 60)

Sets the duration to wait for a provider to respond to a tunnel stream open request.

Parameters
[in]timeOutspecifies time to wait for the response to the open request (in seconds)
Returns
reference to this object
TunnelStreamRequest& thomsonreuters::ema::access::TunnelStreamRequest::serviceId ( UInt32  serviceId)

Specifies ServiceId.

Remarks
One service identification must be set, either id or name.
Parameters
[in]serviceIdspecifies service id
Returns
reference to this object
Exceptions
OmmInvalidUsageExceptionif service name is already set
TunnelStreamRequest& thomsonreuters::ema::access::TunnelStreamRequest::serviceName ( const EmaString serviceName)

Specifies ServiceName.

Remarks
One service identification must be set, either id or name.
Parameters
[in]serviceNamespecifies service name
Returns
reference to this object
Exceptions
OmmInvalidUsageExceptionif service id is already set

Friends And Related Function Documentation

friend class TunnelItem
friend

Definition at line 746 of file TunnelStreamRequest.h.