EMA C++ Edition
List of all members
refinitiv::ema::access::TunnelStreamRequest Class Reference

TunnelStreamRequest encapsulates tunnel stream request parameters. More...

Public Member Functions

Constructor
 TunnelStreamRequest ()
  More...
 
 TunnelStreamRequest (const TunnelStreamRequest &other)
  More...
 
Destructor
virtual ~TunnelStreamRequest ()
  More...
 
Operations
TunnelStreamRequestoperator= (const TunnelStreamRequest &other)
  More...
 
TunnelStreamRequestclear ()
  More...
 
TunnelStreamRequestdomainType (UInt8 domainType)
  More...
 
TunnelStreamRequestserviceId (UInt32 serviceId)
  More...
 
TunnelStreamRequestserviceName (const EmaString &serviceName)
  More...
 
TunnelStreamRequestname (const EmaString &name)
  More...
 
TunnelStreamRequestresponseTimeout (UInt32 timeout=60)
  More...
 
TunnelStreamRequestguaranteedOutputBuffers (UInt32 value=50)
  More...
 
TunnelStreamRequestclassOfService (const ClassOfService &cos)
  More...
 
TunnelStreamRequestloginReqMsg (const ReqMsg &loginReq)
  More...
 

Accessors

class TunnelItem
 
bool hasServiceId () const
  More...
 
bool hasServiceName () const
  More...
 
bool hasName () const
  More...
 
bool hasLoginReqMsg () const
  More...
 
UInt16 getDomainType () const
  More...
 
UInt32 getServiceId () const
  More...
 
const EmaStringgetServiceName () const
  More...
 
const EmaStringgetName () const
  More...
 
UInt32 getResponseTimeOut () const
  More...
 
UInt32 getGuaranteedOutputBuffers () const
  More...
 
const ClassOfServicegetClassOfService () const
  More...
 
const ReqMsggetLoginReqMsg () const
  More...
 

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 );
static const refinitiv::ema::access::UInt8 MMT_SYSTEM
Definition: EmaRdm.h:68
See also
ClassOfService, OmmConsumer

Definition at line 586 of file TunnelStreamRequest.h.

Constructor & Destructor Documentation

◆ TunnelStreamRequest() [1/2]

refinitiv::ema::access::TunnelStreamRequest::TunnelStreamRequest ( )

Default constructor

◆ TunnelStreamRequest() [2/2]

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

Copy constructor

Parameters
[in]otherspecifies TunnelStreamRequest object to copy from

◆ ~TunnelStreamRequest()

virtual refinitiv::ema::access::TunnelStreamRequest::~TunnelStreamRequest ( )
virtual

Destructor

Member Function Documentation

◆ classOfService()

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

Specifies the ClassOfService.

Parameters
[in]cosspecifies ClassOfService
Returns
reference to this object

◆ clear()

TunnelStreamRequest& refinitiv::ema::access::TunnelStreamRequest::clear ( )

Clears object by setting defaults

Returns
reference to this object

◆ domainType()

TunnelStreamRequest& refinitiv::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

◆ getClassOfService()

const ClassOfService& refinitiv::ema::access::TunnelStreamRequest::getClassOfService ( ) const

Retursn ClassOfService.

Returns
class of service

◆ getDomainType()

UInt16 refinitiv::ema::access::TunnelStreamRequest::getDomainType ( ) const

Returns DomainType.

Returns
domain type

◆ getGuaranteedOutputBuffers()

UInt32 refinitiv::ema::access::TunnelStreamRequest::getGuaranteedOutputBuffers ( ) const

Returns number of GuaranteedOutputBuffers.

Returns
number of guaranteed output buffers

◆ getLoginReqMsg()

const ReqMsg& refinitiv::ema::access::TunnelStreamRequest::getLoginReqMsg ( ) const

Returns Login request message

Returns
login request message
Exceptions
OmmInvalidUsageExceptionif login request message is not set

◆ getName()

const EmaString& refinitiv::ema::access::TunnelStreamRequest::getName ( ) const

Returns tunnel stream name.

Returns
tunnel stream name
Exceptions
OmmInvalidUsageExceptionif name is not set

◆ getResponseTimeOut()

UInt32 refinitiv::ema::access::TunnelStreamRequest::getResponseTimeOut ( ) const

Returns ResponseTimeOut.

Returns
response timeOut

◆ getServiceId()

UInt32 refinitiv::ema::access::TunnelStreamRequest::getServiceId ( ) const

Returns ServiceId.

Returns
service id
Exceptions
OmmInvalidUsageExceptionif service id is not set

◆ getServiceName()

const EmaString& refinitiv::ema::access::TunnelStreamRequest::getServiceName ( ) const

Returns ServiceNme.

Returns
service name
Exceptions
OmmInvalidUsageExceptionif service name is not set

◆ guaranteedOutputBuffers()

TunnelStreamRequest& refinitiv::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

◆ hasLoginReqMsg()

bool refinitiv::ema::access::TunnelStreamRequest::hasLoginReqMsg ( ) const

Indicates presence of login request message.

Returns
true if login request message is set

◆ hasName()

bool refinitiv::ema::access::TunnelStreamRequest::hasName ( ) const

Indicates presence of name

Returns
true if service name is set

◆ hasServiceId()

bool refinitiv::ema::access::TunnelStreamRequest::hasServiceId ( ) const

Indicates presence of service id

Returns
true if service id is set

◆ hasServiceName()

bool refinitiv::ema::access::TunnelStreamRequest::hasServiceName ( ) const

Indicates presence of service name

Returns
true if service name is set

◆ loginReqMsg()

TunnelStreamRequest& refinitiv::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

◆ name()

TunnelStreamRequest& refinitiv::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

◆ operator=()

TunnelStreamRequest& refinitiv::ema::access::TunnelStreamRequest::operator= ( const TunnelStreamRequest other)

Assignment operator

Parameters
[in]otherspecifies TunnelStreamRequest object to copy from
Returns
reference to this object

◆ responseTimeout()

TunnelStreamRequest& refinitiv::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

◆ serviceId()

TunnelStreamRequest& refinitiv::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

◆ serviceName()

TunnelStreamRequest& refinitiv::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