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

OmmConsumerConfig is used to modify configuration and behavior of OmmConsumer. More...

Public Types

enum  EncryptionProtocolTypes {
  ENC_NONE = 0x00 ,
  ENC_TLSV1_2 = 0x04 ,
  ENC_TLSV1_3 = 0x08
}
 
enum  OperationModel {
  UserDispatchEnum ,
  ApiDispatchEnum
}
 

Public Member Functions

Constructor
 OmmConsumerConfig ()
  More...
 
 OmmConsumerConfig (const EmaString &configPath)
  More...
 
Destructor
virtual ~OmmConsumerConfig ()
  More...
 

Operations

class OmmConsumerImpl
 
class OmmConsumer
 
OmmConsumerConfigclear ()
  More...
 
OmmConsumerConfigusername (const EmaString &username)
  More...
 
OmmConsumerConfigpassword (const EmaString &password)
  More...
 
OmmConsumerConfigposition (const EmaString &position)
  More...
 
OmmConsumerConfigapplicationId (const EmaString &applicationId)
  More...
 
OmmConsumerConfigclientId (const EmaString &clientId)
  More...
 
OmmConsumerConfigclientSecret (const EmaString &clientSecret)
  More...
 
OmmConsumerConfigclientJWK (const EmaString &clientJWK)
  More...
 
OmmConsumerConfigaudience (const EmaString &audience="https://login.ciam.refinitiv.com/as/token.oauth2")
  More...
 
OmmConsumerConfigtokenScope (const EmaString &tokenScope="trapi.streaming.pricing.read")
  More...
 
OmmConsumerConfigtakeExclusiveSignOnControl (bool takeExclusiveSignOnControl=true)
  More...
 
OmmConsumerConfigtokenServiceUrl (const EmaString &tokenServiceUrl="https://api.refinitiv.com/auth/oauth2/v1/token")
  More...
 
OmmConsumerConfigtokenServiceUrlV1 (const EmaString &tokenServiceUrl="https://api.refinitiv.com/auth/oauth2/v1/token")
  More...
 
OmmConsumerConfigtokenServiceUrlV2 (const EmaString &tokenServiceUrl="https://api.refinitiv.com/auth/oauth2/v2/token")
  More...
 
OmmConsumerConfigserviceDiscoveryUrl (const EmaString &serviceDiscoveryUrl="https://api.refinitiv.com/streaming/pricing/v1/")
  More...
 
OmmConsumerConfighost (const EmaString &host="localhost:14002")
  More...
 
OmmConsumerConfigchannelType (EmaConfig::ConnectionTypeEnum channelType)
  More...
 
OmmConsumerConfigencryptedProtocolType (EmaConfig::EncryptedProtocolTypeEnum encProtocolType)
  More...
 
OmmConsumerConfigoperationModel (OperationModel operationModel=ApiDispatchEnum)
  More...
 
OmmConsumerConfigconsumerName (const EmaString &consumerName)
  More...
 
OmmConsumerConfigtunnelingProxyHostName (const EmaString &proxyHostName)
  More...
 
OmmConsumerConfigtunnelingProxyPort (const EmaString &proxyPort)
  More...
 
OmmConsumerConfigtunnelingSecurityProtocol (int securityProtocol)
  More...
 
OmmConsumerConfigtunnelingObjectName (const EmaString &objectName)
  More...
 
OmmConsumerConfigtunnelingLibSslName (const EmaString &libsslName)
  More...
 
OmmConsumerConfigtunnelingLibCryptoName (const EmaString &libcryptoName)
  More...
 
OmmConsumerConfiglibcurlName (const EmaString &libcurlName)
  More...
 
OmmConsumerConfigproxyUserName (const EmaString &proxyUserName)
  More...
 
OmmConsumerConfigproxyPasswd (const EmaString &proxyPasswd)
  More...
 
OmmConsumerConfigproxyDomain (const EmaString &proxyDomain)
  More...
 
OmmConsumerConfigsslCAStore (const EmaString &sslCAStore)
  More...
 
OmmConsumerConfigconfig (const Data &config)
  More...
 
OmmConsumerConfigaddAdminMsg (const ReqMsg &reqMsg)
  More...
 
OmmConsumerConfigaddOAuth2Credential (const OAuth2Credential &credential)
  More...
 
OmmConsumerConfigaddOAuth2Credential (const OAuth2Credential &credential, const OmmOAuth2ConsumerClient &client)
  More...
 
OmmConsumerConfigaddOAuth2Credential (const OAuth2Credential &credential, const OmmOAuth2ConsumerClient &client, void *closure)
  More...
 
OmmConsumerConfigaddLoginMsgCredential (const ReqMsg &reqMsg, const EmaString &channelList)
  More...
 
OmmConsumerConfigaddLoginMsgCredential (const ReqMsg &reqMsg, const EmaString &channelList, const OmmLoginCredentialConsumerClient &client)
  More...
 
OmmConsumerConfigaddLoginMsgCredential (const ReqMsg &reqMsg, const EmaString &channelList, const OmmLoginCredentialConsumerClient &client, void *closure)
  More...
 
OmmConsumerConfigrestLoggingCallback (OmmRestLoggingClient &ommRestLoggingClient, void *closure=(void *) 0)
  More...
 
OmmConsumerConfigworkerThreadBind (const EmaString &cpuString)
  More...
 
OmmConsumerConfigapiThreadBind (const EmaString &cpuString)
  More...
 
OmmConsumerConfigshouldInitializeCPUIDlib (bool shouldInitCPUIDlib)
  More...
 
OmmConsumerConfigdataDictionary (const refinitiv::ema::rdm::DataDictionary &dataDictionary, bool shouldCopyIntoAPI=false)
  More...
 
OmmConsumerConfigrestProxyHostName (const EmaString &restProxyHostName)
  More...
 
OmmConsumerConfigrestProxyPort (const EmaString &restProxyPort)
  More...
 
OmmConsumerConfigrestProxyUserName (const EmaString &restProxyUserName)
  More...
 
OmmConsumerConfigrestProxyPasswd (const EmaString &restProxyPasswd)
  More...
 
OmmConsumerConfigrestProxyDomain (const EmaString &restProxyDomain)
  More...
 

Detailed Description

OmmConsumerConfig provides a default basic OmmConsumer configuration.

The default configuration may be modified and or appended by using EmaConfig.xml file or any interface methods of this class.

The EmaConfig.xml file is read in if it is present in the working directory of the application.

Calling any interface methods of OmmConsumerConfig class overrides or appends the existing configuration.

Remarks
All methods in this class are Lock-free Method.
See also
OmmConsumer

Definition at line 48 of file OmmConsumerConfig.h.

Member Enumeration Documentation

◆ EncryptionProtocolTypes

Enumerator
ENC_NONE 

(0x00) No encryption.

ENC_TLSV1_2 

(0x04) Encryption using TLSv1.2 protocol

ENC_TLSV1_3 

(0x08) Encryption using TLSv1.3 protocol

Definition at line 62 of file OmmConsumerConfig.h.

◆ OperationModel

Enumerator
UserDispatchEnum 

specifies callbacks happen on user thread of control

ApiDispatchEnum 

specifies callbacks happen on API thread of control

Definition at line 54 of file OmmConsumerConfig.h.

Constructor & Destructor Documentation

◆ OmmConsumerConfig() [1/2]

refinitiv::ema::access::OmmConsumerConfig::OmmConsumerConfig ( )

Create an OmmConsumerConfig that enables customization of default implicit administrative domains and local configuration.

◆ OmmConsumerConfig() [2/2]

refinitiv::ema::access::OmmConsumerConfig::OmmConsumerConfig ( const EmaString configPath)

Create an OmmConsumerConfig that enables customization of default implicit administrative domains and local configuration.

Parameters
[in]configPathconfigPath configuration file name or name of directory containing a file named EmaConfig.xml
Remarks
path is optional. If not specified, application will use EmaConfig.xml (if any) found in current working directory

◆ ~OmmConsumerConfig()

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

Destructor.

Member Function Documentation

◆ addAdminMsg()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::addAdminMsg ( const ReqMsg reqMsg)

Specifies an administrative request message to override the default administrative request. Application may call multiple times prior to initialization. Supported domains include Login, Directory, and Dictionary.

Parameters
[in]reqMsgspecifies administrative domain request message
Returns
reference to this object

◆ addLoginMsgCredential() [1/3]

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::addLoginMsgCredential ( const ReqMsg reqMsg,
const EmaString channelList 
)

Specifies a set of Login credentials to be used with a specific set of channels. Application may call this multiple times prior to initialization to set multiple sets of credentials.

Parameters
[in]ReqMsgLogin domain request message. This message must follow the RDM Login domain.
[in]channelListComma separated list of channel names
Returns
reference to this object

◆ addLoginMsgCredential() [2/3]

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::addLoginMsgCredential ( const ReqMsg reqMsg,
const EmaString channelList,
const OmmLoginCredentialConsumerClient client 
)

Specifies a set of Login credentials to be used with a specific set of channels. Application may call this multiple times prior to initialization to set multiple sets of credentials.

Parameters
[in]ReqMsgLogin domain request message. This message must follow the RDM Login domain.
[in]channelListComma separated list of channel names
[in]clientcallback client associated with the above request message
Returns
reference to this object

◆ addLoginMsgCredential() [3/3]

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::addLoginMsgCredential ( const ReqMsg reqMsg,
const EmaString channelList,
const OmmLoginCredentialConsumerClient client,
void *  closure 
)

Specifies a set of Login credentials to be used with a specific set of channels. Application may call this multiple times prior to initialization to set multiple sets of credentials.

Parameters
[in]ReqMsgLogin domain request message. This message must follow the RDM Login domain.
[in]channelListComma separated list of channel names
[in]clientcallback client associated with the above request message
[in]closureuser specified closure
Returns
reference to this object

◆ addOAuth2Credential() [1/3]

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::addOAuth2Credential ( const OAuth2Credential credential)

Specifies a set of OAuth2 credentials to be used with a specific set of channels.
Application may call this multiple times prior to initialization to set multiple sets of credentials.

Parameters
[in]credentialspecifies oAuth2 credentials
Returns
reference to this object

◆ addOAuth2Credential() [2/3]

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::addOAuth2Credential ( const OAuth2Credential credential,
const OmmOAuth2ConsumerClient client 
)

Specifies a set of OAuth2 credentials to be used with a specific set of channels. Application may call this multiple times prior to initialization to set multiple sets of credentials.

Parameters
[in]credentialspecifies oAuth2 credentials
[in]clientcallback client associated with the above set of credentials
Returns
reference to this object

◆ addOAuth2Credential() [3/3]

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::addOAuth2Credential ( const OAuth2Credential credential,
const OmmOAuth2ConsumerClient client,
void *  closure 
)

Specifies a set of OAuth2 credentials to be used with a specific set of channels. Application may call this multiple times prior to initialization to set multiple sets of credentials.

Parameters
[in]credentialspecifies oAuth2 credentials
[in]clientcallback client associated with the above set of credentials
[in]closureuser specified closure
Returns
reference to this object

◆ apiThreadBind()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::apiThreadBind ( const EmaString cpuString)

Specifies the Cpu core to bind for internal EMA thread that dispatch messages. When ApiDispatchEnum set as operational model. Application may call multiple times prior to initialization.

Parameters
[in]cpuStringspecifies the Cpu core in string format (Cpu core id or P:X C:Y T:Z format).
Returns
reference to this object

◆ applicationId()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::applicationId ( const EmaString applicationId)

Specifies the authorization application identifier. Must be unique for each application. Range 257 to 65535 is available for site-specific use. Range 1 to 256 is reserved.

Parameters
[in]applicationIdspecifies respective login request attribute
Returns
reference to this object

◆ audience()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::audience ( const EmaString audience = "https://login.ciam.refinitiv.com/as/token.oauth2")

Specifies the audience claim for the JWT. Optional, used for V2 Client Credentials with JWT.

Parameters
[in]audiencespecifies the client audience claim
Returns
reference to this object

◆ channelType()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::channelType ( EmaConfig::ConnectionTypeEnum  channelType)

Specifies connection type. Overrides prior value

Parameters
[in]specifiesconnection type used by application. Connection type defined in EmaConfig::ConnectionTypeEnum
Exceptions
OmmInvalidUsageExceptionif use this API with WarmStandby channel configuration.
OmmInvalidUsageExceptionif channelType is not valid.
Returns
reference to this object

◆ clear()

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

Clears the OmmConsumerConfig and sets all the defaults.

Remarks
Invoking clear() method clears all the values and resets all the defaults
Returns
reference to this object

◆ clientId()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::clientId ( const EmaString clientId)

Specifies the clientID used for RDP token service. Mandatory, used to specify Application ID obtained from App Generator for V1 oAuth Password Credentials, or to specify Service Account username for V2 Client Credentials and V2 Client Credentials with JWT Logins.

Parameters
[in]clientIdspecifies the clientId.
Returns
reference to this object

◆ clientJWK()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::clientJWK ( const EmaString clientJWK)

Specifies the JWK formatted private key used to create the JWT. The JWT is used to authenticate with the RDP token service. Mandatory for V2 logins with client JWT logins

Parameters
[in]clientJWKspecifies the JWK formatted private key
Returns
reference to this object

◆ clientSecret()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::clientSecret ( const EmaString clientSecret)

Specifies the clientSecret, also known as the Service Account password, used to authenticate with RDP token service. Mandatory for V2 Client Credentials Logins and used in conjunction with clientID.

Parameters
[in]clientSecretspecifies a client secret.
Returns
reference to this object

◆ config()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::config ( const Data config)

Specifies the local configuration, overriding and adding to the current content.

Parameters
[in]configspecifies OmmConsumer configuration
Returns
reference to this object

◆ consumerName()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::consumerName ( const EmaString consumerName)

Create an OmmConsumer with consumer name. The OmmConsumer enables functionality that includes subscribing, posting and distributing generic messages. This name identifies configuration section to be used by OmmConsumer instance.

Parameters
[in]consumerNamespecifies name of OmmConsumer instance
Returns
reference to this object

◆ dataDictionary()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::dataDictionary ( const refinitiv::ema::rdm::DataDictionary dataDictionary,
bool  shouldCopyIntoAPI = false 
)

Specifies the DataDictionary object. Overrides DataDictionary object that is provided via EmaConfig.xml or Programmatic configure.

Parameters
[in]dataDictionaryspecifies the DataDictionary object.
[in]shouldCopyIntoAPIspecifies whether to copy dataDictionary into API or pass it in as a reference.
Exceptions
OmmInvalidUsageExceptionif application passes not fully loaded DataDictionary object
Returns
reference to this object.

◆ encryptedProtocolType()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::encryptedProtocolType ( EmaConfig::EncryptedProtocolTypeEnum  encProtocolType)

Specifies encrypted protocol type. Overrides prior value

Parameters
[in]specifiesencrypted protocol type used by application. Encrypted protocol type defined in EmaConfig::EncryptedProtocolTypeEnum
Exceptions
OmmInvalidUsageExceptionif use this API with WarmStandby channel configuration.
OmmInvalidUsageExceptionif use this API with not encoded channel type.
OmmInvalidUsageExceptionif encProtocolType is not valid.
Returns
reference to this object

◆ host()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::host ( const EmaString host = "localhost:14002")

Specifies a hostname and port. Overrides prior value.

Remarks
Implies usage of TCP IP channel or RSSL_CONN_TYPE_SOCKET.
Parameters
[in]hostspecifies server and port to which OmmConsumer will connect
Remarks
if host set to "<hostname>:<port>", then hostname:port is assumed
if host set to "", then localhost:14002 is assumed
if host set to ":", then localhost:14002 is assumed
if host set to "<hostname>", then hostname:14002 is assumed
if host set to "<hostname>:", then hostname:14002 is assumed
if host set to ":<port>", then localhost:port is assumed
Returns
reference to this object

◆ libcurlName()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::libcurlName ( const EmaString libcurlName)

Specifies the name of the lbicurl.so shared library for connecting through HTTP proxies. This is supported on Socket connections and Encrypted connections with Socket encrypted protocol.

Parameters
[in]libcurlNamespecifies the name of the libcurl.so shared library
Returns
reference to this object

◆ operationModel()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::operationModel ( OperationModel  operationModel = ApiDispatchEnum)

Specifies the operation model, overriding the default. The operation model specifies whether to dispatch messages in the user or application thread of control.

Parameters
[in]specifiesthreading and dispatching model used by application
Returns
reference to this object

◆ password()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::password ( const EmaString password)

Specifies the password. Mandatory for V1 oAuth Password Credentials logins with session management turned on. Overrides a value specified in Login domain via the addAdminMsg(..) method.

Parameters
[in]passwordspecifies respective login request attribute
Returns
reference to this object

◆ position()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::position ( const EmaString position)

Specifies the position. Overrides a value specified in Login domain via the addAdminMsg(..) method.

Parameters
[in]positionspecifies respective login request attribute
Returns
reference to this object

◆ proxyDomain()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::proxyDomain ( const EmaString proxyDomain)

Specifies the domain of the user to authenticate. Needed for NTLM or for Negotiate/Kerberos or for Kerberos authentication protocols.

For Negotiate/Kerberos or for Kerberos authentication protocols, proxyDomain should be the same as the domain in the 'realms' and 'domain_realm' sections of the Kerberos configuration file.

Parameters
[in]proxyDomainspecifies the domain used for tunneling connection.
Returns
reference to this object

◆ proxyPasswd()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::proxyPasswd ( const EmaString proxyPasswd)

Specifies the passwd to authenticate. Needed for all authentication protocols.

Parameters
[in]proxyPasswdspecifies password used for tunneling connection.
Returns
reference to this object

◆ proxyUserName()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::proxyUserName ( const EmaString proxyUserName)

Specifies the user name to authenticate. Needed for all authentication protocols.

Parameters
[in]proxyUserNamespecifies user name used for tunneling connection.
Returns
reference to this object

◆ restLoggingCallback()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::restLoggingCallback ( OmmRestLoggingClient ommRestLoggingClient,
void *  closure = (void *) 0 
)

Specifies the user callback client to receive REST logging messages.

Parameters
[in]ommRestLoggingClientspecifies the user callback client used for receiving REST logging messages.
[in]closurespecifies application defined identification value.
Returns
reference to this object

◆ restProxyDomain()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::restProxyDomain ( const EmaString restProxyDomain)

Specifies the domain of the user to authenticate to the proxy server for Rest requests: service discovery and auth token service. Needed for NTLM or for Negotiate/Kerberos or for Kerberos authentication protocols.

For Negotiate/Kerberos or for Kerberos authentication protocols, restProxyDomain should be the same as the domain in the 'realms' and 'domain_realm' sections of the Kerberos configuration file.

Parameters
[in]restProxyDomainspecifies the domain used for the proxy server authentication for Rest requests.
Returns
reference to this object

◆ restProxyHostName()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::restProxyHostName ( const EmaString restProxyHostName)

Specifies the address or host name of the proxy server for Rest requests: service discovery and auth token service.

Parameters
[in]restProxyHostNamespecifies the address or host name of the proxy server for Rest requests.
Returns
reference to this object

◆ restProxyPasswd()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::restProxyPasswd ( const EmaString restProxyPasswd)

Specifies the passwd to authenticate to the proxy server for Rest requests. Needed for all authentication protocols.

Parameters
[in]restProxyPasswdspecifies password for the proxy server authentication for Rest requests.
Returns
reference to this object

◆ restProxyPort()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::restProxyPort ( const EmaString restProxyPort)

Specifies the port number of the proxy server for Rest requests: service discovery and auth token service.

Parameters
[in]restProxyPortspecifies the port number of the proxy server for Rest requests.
Returns
reference to this object

◆ restProxyUserName()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::restProxyUserName ( const EmaString restProxyUserName)

Specifies the user name to authenticate to the proxy server for Rest requests. Needed for all authentication protocols.

Parameters
[in]restProxyUserNamespecifies user name for the proxy server authentication for Rest requests.
Returns
reference to this object

◆ serviceDiscoveryUrl()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::serviceDiscoveryUrl ( const EmaString serviceDiscoveryUrl = "https://api.refinitiv.com/streaming/pricing/v1/")

Specifies an URL to override the default for the RDP service discovery to get global endpoints

Parameters
[in]serviceDiscoveryUrlspecifies an URL for RDP service discovery.
Returns
reference to this object

◆ shouldInitializeCPUIDlib()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::shouldInitializeCPUIDlib ( bool  shouldInitCPUIDlib)

Specifies should ETA initialize CpuID library. It will analyze CPU topology. Application may call multiple times prior to initialization.

Parameters
[in]shouldInitCPUIDlibtrue ETA should initialize CpuID library; otherwise ETA will not initialize CpuID library.
Returns
reference to this object

◆ sslCAStore()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::sslCAStore ( const EmaString sslCAStore)

Specifies the path to an OpenSSL Certificate Authority store.

Parameters
[in]sslCAStorespecifies the file or directory where the CA store is located.
Returns
reference to this object

◆ takeExclusiveSignOnControl()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::takeExclusiveSignOnControl ( bool  takeExclusiveSignOnControl = true)

Specifies the take exclusive sign on control value. If set to true, other applications using the same credentials will be force signed-out. Optional and only used for V1 oAuth Password Credentials logins.

Parameters
[in]takeExclusiveSignOnControlthe exclusive sign on control.
Returns
reference to this object

◆ tokenScope()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::tokenScope ( const EmaString tokenScope = "trapi.streaming.pricing.read")

Specifies the token scope to limit the scope of generated token from the token service. Optional.

Parameters
[in]tokenScopespecifies a token scope
Returns
reference to this object

◆ tokenServiceUrl()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::tokenServiceUrl ( const EmaString tokenServiceUrl = "https://api.refinitiv.com/auth/oauth2/v1/token")

Specifies an URL to override the default for token service V1 Password Credentials to perform authentication to get access and refresh tokens.

Parameters
[in]tokenServiceUrlspecifies an URL for token service.
Returns
reference to this object

◆ tokenServiceUrlV1()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::tokenServiceUrlV1 ( const EmaString tokenServiceUrl = "https://api.refinitiv.com/auth/oauth2/v1/token")

Specifies an URL to override the default for token service V1 Password Credentials to perform authentication to get access and refresh tokens.

Parameters
[in]tokenServiceUrlspecifies an URL for token service.
Returns
reference to this object

◆ tokenServiceUrlV2()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::tokenServiceUrlV2 ( const EmaString tokenServiceUrl = "https://api.refinitiv.com/auth/oauth2/v2/token")

Specifies an URL to override the default for token service V2 Client Credentials to perform authentication to get access and refresh tokens.

Parameters
[in]tokenServiceUrlspecifies an URL for token service.
Returns
reference to this object

◆ tunnelingLibCryptoName()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::tunnelingLibCryptoName ( const EmaString libcryptoName)

Specifies the name of the libcrypto.so shared library for Encrypted connections.

Parameters
[in]libsslNamespecifies the name of the libcrypto.so shared library
Returns
reference to this object

◆ tunnelingLibSslName()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::tunnelingLibSslName ( const EmaString libsslName)

Specifies the name of the libssl.so shared library for Encrypted connections.

Parameters
[in]libsslNamespecifies the name of the libssl.so shared library
Returns
reference to this object

◆ tunnelingObjectName()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::tunnelingObjectName ( const EmaString objectName)

Specifies the object name to pass along with the underlying URL in HTTP and HTTPS connection messages.

Parameters
[in]objectNamespecifies the object name.
Returns
reference to this object

◆ tunnelingProxyHostName()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::tunnelingProxyHostName ( const EmaString proxyHostName)

Specifies the address or host name of the proxy server to connect to for an HTTP or HTTPS connection.

Parameters
[in]proxyHostNamespecifies the address or host name of the proxy server for tunneling connection.
Returns
reference to this object

◆ tunnelingProxyPort()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::tunnelingProxyPort ( const EmaString proxyPort)

Specifies the port number of the proxy server to connect to for an HTTP or HTTPS connection.

Parameters
[in]proxyPortspecifies the port number of the proxy server for tunneling connection.
Returns
reference to this object

◆ tunnelingSecurityProtocol()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::tunnelingSecurityProtocol ( int  securityProtocol)

Specifies the cryptographic protocols to be used for an Encrypted connection on a Linux operating system, of values TLSv1.2. The highest value of TLS will be selected by the Rssl API first, then it will roll back if the encryption handshake fails. The protocol defaults to TLSv1.2 and TLSv1.3. Use OmmConsumerConfig::EncryptionProtocolTypes flags to set allowed protocols.

Parameters
[in]securityProtocolspecifies a cryptopgraphic protocol.
Returns
reference to this object

◆ username()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::username ( const EmaString username)

Specifies the username. Mandatory for V1 oAuth Password Credentials logins with session management turned on. Overrides a value specified in Login domain via the addAdminMsg(..) method.

Parameters
[in]usernamespecifies name used on login request
Returns
reference to this object

◆ workerThreadBind()

OmmConsumerConfig& refinitiv::ema::access::OmmConsumerConfig::workerThreadBind ( const EmaString cpuString)

Specifies the Cpu core to bind for Reactor Worker thread. Application may call multiple times prior to initialization.

Parameters
[in]cpuStringspecifies the Cpu core in string format (Cpu core id or P:X C:Y T:Z format).
Returns
reference to this object