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

CosAuthentication encapsulates authentication member of the ClassOfService class. More...

Public Types

enum  CosAuthenticationType {
  NotRequiredEnum = 0 ,
  OmmLoginEnum = 1
}
 

Public Member Functions

Constructor
 CosAuthentication ()
  More...
 
 CosAuthentication (const CosAuthentication &other)
  More...
 
Destructor
virtual ~CosAuthentication ()
  More...
 
Operations
CosAuthenticationoperator= (const CosAuthentication &other)
  More...
 
CosAuthenticationclear ()
  More...
 
CosAuthenticationtype (CosAuthenticationType type=NotRequiredEnum)
  More...
 

Accessors

CosAuthenticationType getType () const
  More...
 

Detailed Description

CosAuthentication contains options to authenticate a consumer to the corresponding provider.

See also
ClassOfService

Definition at line 98 of file TunnelStreamRequest.h.

Member Enumeration Documentation

◆ CosAuthenticationType

An enumeration representing authentication type.

Enumerator
NotRequiredEnum 

Indicates authentication is not required

OmmLoginEnum 

Indicates OmmLogin message is required for authentication

Definition at line 105 of file TunnelStreamRequest.h.

Constructor & Destructor Documentation

◆ CosAuthentication() [1/2]

refinitiv::ema::access::CosAuthentication::CosAuthentication ( )

Default constructor

◆ CosAuthentication() [2/2]

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

Copy constructor

Parameters
[in]otherspecifies CosAuthentication object to copy from

◆ ~CosAuthentication()

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

Destructor

Member Function Documentation

◆ clear()

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

Clears object by setting defaults

Returns
reference to this object

◆ getType()

CosAuthenticationType refinitiv::ema::access::CosAuthentication::getType ( ) const

Returns Authentication type

Returns
authentication type

◆ operator=()

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

Assignment operator

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

◆ type()

CosAuthentication& refinitiv::ema::access::CosAuthentication::type ( CosAuthenticationType  type = NotRequiredEnum)

Specifies authentication type

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