EMA C++ Edition
List of all members | Public Types
refinitiv::ema::access::CosGuarantee Class Reference

CosGuarantee encapsulates guarantee member of the ClassOfService class. More...

Public Types

enum  CosGuaranteeType {
  NoneEnum = 0 ,
  PersistentQueueEnum = 1
}
 

Public Member Functions

Constructor
 CosGuarantee ()
  More...
 
 CosGuarantee (const CosGuarantee &other)
  More...
 
Destructor
virtual ~CosGuarantee ()
  More...
 
Operations
CosGuaranteeoperator= (const CosGuarantee &other)
  More...
 
CosGuaranteeclear ()
  More...
 
CosGuaranteetype (CosGuaranteeType type=NoneEnum)
  More...
 
CosGuaranteepersistLocally (bool persistLocally=true)
  More...
 
CosGuaranteepersistenceFilePath (const EmaString &filePath=EmaString())
  More...
 

Accessors

CosGuaranteeType getType () const
  More...
 
bool getPersistLocally () const
  More...
 
const EmaStringgetPersistenceFilePath () const
  More...
 

Detailed Description

CosGuarantee contains options related to the guarantee of content submitted over the tunnel stream.

See also
ClassOfService

Definition at line 348 of file TunnelStreamRequest.h.

Member Enumeration Documentation

◆ CosGuaranteeType

An enumeration representing guarantee type.

Enumerator
NoneEnum 

Indicates no guarantee

PersistentQueueEnum 

Indicates persistent queue

Definition at line 355 of file TunnelStreamRequest.h.

Constructor & Destructor Documentation

◆ CosGuarantee() [1/2]

refinitiv::ema::access::CosGuarantee::CosGuarantee ( )

Default constructor

◆ CosGuarantee() [2/2]

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

Copy constructor

Parameters
[in]otherspecifies CosGuarantee object to copy from

◆ ~CosGuarantee()

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

Destructor

Member Function Documentation

◆ clear()

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

Clears object by setting defaults

Returns
reference to this object

◆ getPersistenceFilePath()

const EmaString& refinitiv::ema::access::CosGuarantee::getPersistenceFilePath ( ) const

Returns file path where files containing persistent messages may be stored

Returns
file path where files containing persistent messages are stored

◆ getPersistLocally()

bool refinitiv::ema::access::CosGuarantee::getPersistLocally ( ) const

Returns if messages should be persisted locally

Returns
if messages should be persisted locally

◆ getType()

CosGuaranteeType refinitiv::ema::access::CosGuarantee::getType ( ) const

Returns guarantee type

Returns
guarantee type

◆ operator=()

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

Assignment operator

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

◆ persistenceFilePath()

CosGuarantee& refinitiv::ema::access::CosGuarantee::persistenceFilePath ( const EmaString filePath = EmaString())

Specifies where files containing persistent messages are stored

Parameters
[in]filePathspecifies path to store files containing persistent messages
Returns
reference to this object
Remarks
If an empty string is passed in, the current working directory is assumed

◆ persistLocally()

CosGuarantee& refinitiv::ema::access::CosGuarantee::persistLocally ( bool  persistLocally = true)

Specifies if messages are persisted locally

Parameters
[in]persistLocallyspecifies if messages need to be persisted locally
Returns
reference to this object
Remarks
If type is set to CosGuaranteeType::NoneEnum, then this parameter has no effect

◆ type()

CosGuarantee& refinitiv::ema::access::CosGuarantee::type ( CosGuaranteeType  type = NoneEnum)

Specifies guarantee type

Parameters
[in]typeguarantee type
Returns
reference to this object
Exceptions
OmmOutOfRangeExceptionif passed in guarantee type is not valid