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

CosCommon encapsulates common member of the ClassOfService class. More...

Public Member Functions

Constructor
 CosCommon ()
  More...
 
 CosCommon (const CosCommon &other)
  More...
 
Destructor
virtual ~CosCommon ()
  More...
 
Operations
CosCommonoperator= (const CosCommon &other)
  More...
 
CosCommonclear ()
  More...
 
CosCommonmaxMsgSize (UInt64 maxMsgSize=6144)
  More...
 

Accessors

UInt64 getMaxMsgSize () const
  More...
 

Detailed Description

CosCommon describes common options related to the exchange of messages.

See also
ClassOfService

Definition at line 31 of file TunnelStreamRequest.h.

Constructor & Destructor Documentation

◆ CosCommon() [1/2]

refinitiv::ema::access::CosCommon::CosCommon ( )

Default constructor

Remarks
specifies default maximum message size as 6144

◆ CosCommon() [2/2]

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

Copy constructor

Parameters
[in]otherspecifies CosCommon object to copy from

◆ ~CosCommon()

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

Destructor

Member Function Documentation

◆ clear()

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

Clears object by setting defaults

Returns
reference to this object

◆ getMaxMsgSize()

UInt64 refinitiv::ema::access::CosCommon::getMaxMsgSize ( ) const

Returns maximum message size assigned by provider accepting the tunnel stream request

Returns
maximum message size

◆ maxMsgSize()

CosCommon& refinitiv::ema::access::CosCommon::maxMsgSize ( UInt64  maxMsgSize = 6144)

Specifies maximum size of messages exchanged on the tunnel stream.

Parameters
[in]maxSizespecifies maximum message size (valid range 1 - 2,147,483,647)
Returns
reference to this object
Remarks
this value is set by providers while accepting a tunnel stream
Exceptions
OmmOutOfRangeExceptionif passed in value is out of valid range

◆ operator=()

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

Assignment operator

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