EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
List of all members | Public Types
thomsonreuters::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 ()
 
 CosGuarantee (const CosGuarantee &other)
 
Destructor
virtual ~CosGuarantee ()
 
Operations
CosGuaranteeoperator= (const CosGuarantee &other)
 
CosGuaranteeclear ()
 
CosGuaranteetype (CosGuaranteeType type=NoneEnum)
 
CosGuaranteepersistLocally (bool persistLocally=true)
 
CosGuaranteepersistenceFilePath (const EmaString &filePath=EmaString())
 
Accessors
CosGuaranteeType getType () const
 
bool getPersistLocally () const
 
const EmaStringgetPersistenceFilePath () const
 

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

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

thomsonreuters::ema::access::CosGuarantee::CosGuarantee ( )

Default constructor

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

Copy constructor

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

Destructor

Member Function Documentation

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

Clears object by setting defaults

Returns
reference to this object
const EmaString& thomsonreuters::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
bool thomsonreuters::ema::access::CosGuarantee::getPersistLocally ( ) const

Returns if messages should be persisted locally

Returns
if messages should be persisted locally
CosGuaranteeType thomsonreuters::ema::access::CosGuarantee::getType ( ) const

Returns guarantee type

Returns
guarantee type
CosGuarantee& thomsonreuters::ema::access::CosGuarantee::operator= ( const CosGuarantee other)

Assignment operator

Parameters
[in]otherspecifies CosGuarantee object to copy from
Returns
reference to this object
CosGuarantee& thomsonreuters::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
CosGuarantee& thomsonreuters::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
CosGuarantee& thomsonreuters::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