Function | Description |
---|---|
addAdminMsg( const ReqMsg& ) | Populates part of or all of the login request message, directory request message, or dictionary request message according to the specification discussed in the Enterprise Message API LSEG Domain Model (RDM) Usage Guide specific to the programming language you use to override the default administrative request. Application may call multiple times prior to initialization. |
addLoginMsgCredential(const ReqMsg& reqMsg, const EmaString& channelList) addLoginMsgCredential(const ReqMsg& reqMsg, const EmaString& channelList, const OmmLoginCredentialConsumerClient& client) addLoginMsgCredential(const ReqMsg& reqMsg, const EmaString& channelList, const OmmLoginCredentialConsumerClient& client, void* closure) | Allows the user to configure multiple login credentials for an OmmConsumerConfig's channels. Sets a login request message to be used with the channels defined in the channelList. channelList is a comma separated string of channel names defined in the Channel Group (see Section 3.4). All login request messages for any given OMMConsumer configuration need to have the same SingleOpen and Allow Suspect Data Verification options set. If a channel is not specified through this configuration, a login request message that has been set via AddAdminMsg will be used. If no message has been set through AddAdminMsg,the default Enterprise Message API login request will be used. If the OmmLoginCredentialConsumerClient is set, the Enterprise Message API will call back the user on reconnection to update the UserName or Authentication Extended members of the login request. This will not be called if the channel has session management enabled. If specified, the closure pointer will be returned to the user in the OmmLoginCredentialConsumerClient::onLoginCredentialRenewal event callback. |
addOAuth2Credential(const OAuth2Credential& credential) addOAuth2Credential(const OAuth2Credential& credential, const OmmOAuth2ConsumerClient& client) addOAuth2Credential(const OAuth2Credential& credential, const OmmOAuth2ConsumerClient& client, void* closure); | Allows the user to configure multiple oAuth credentials for an OmmConsumerConfig's channels. Sets oAuth credentials to be used with channels that have EnableSessionManagement turned on. The OAuth2Credential object allows the user to specify a comma separated string of channel names defined in the Channel Group (see Section 3.4). If a set of oAuth credentials is defined through the username, password, clientId, and clientSecret, then these will be used if a configured channel is not explicitly referenced. If specified, the closure pointer will be returned to the user in the OmmOAuth2ConsumerClient::onCredentialRenewal event callback. For more information about the oAuth functionality, refer to the Enterprise Message API Developers Guide. |
applicationId( const EmaString& ) | Sets the applicationId variable. applicationId has no default value. |
audience( String) | Optional. Used only with Version 2 oAuthClientCredential with JWT. Sets the audience claim for the JWT. |
channelType(ConnectionTypes) | Optional. Specifies the channel type used by the current consumer. Use EmaConfig::ConnectionTypeEnum to set allowed connection type. |
clear() | Clears existing content from the OmmConsumerConfig object. |
clientId( const EmaString& ) | Required. Specifies an authentication parameter. • Version 1 Authentication: a unique ID for application used to make an authentication request. • Version 2 Authentication: a unique ID provisioned as part of Service Account used to make an authentication request. For details on Version 1 and Version 2 Authentication, refer to the Enterprise Message API Developers Guide, Section “Consuming Data from the Cloud”. |
clientJwk( String) | Required for Version 2 oAuthClientCredential with JWT. Sets the JWK formatted private key used to create the JWT. The JWT is used to authenticate with the RDP token service. |
clientSecret( const EmaString& ) | Sets the client secret. Optional for Version 1 oAuthPasswordGrant authentication. Required for Version 2 oAuthClientCredential authentication and provisioned as part of Service Account. |
config( const Data& ) | Passes in the consumer's programmatic configuration. |
consumerName( const EmaString& ) | Sets the consumer name, which is used to select a specific consumer as defined in the Enterprise Message API's configuration. If a consumer does not exist with that name, the application throws an exception. |
dataDictionary(const DataDictionary&, bool shouldCopyIntoAPI) | Optional. Specifies the DataDictionary object with a mandatory bool or flag. If flag is true, the DataDictionary object will be copied into API space; otherwise, it will be passed in as a reference. Overrides DataDictionary object provided via EmaConfig.xml or programmatic configuration. |
encryptedProtocolType(EncryptedProtocol Types) | Optional. Specifies the encrypted protocol type used by the current consumer. Use EmaConfig::EncryptedProtocolTypeEnum to set allowed encrypted protocol type. |
host( const EmaString& host) | Sets the host and port parameters. For details, refer to Section 4.4.2. Sample value: “localhost:14002”. |
libcurlName( const EmaString& ) | Optional. Specifies the location of libcurl, which is used by EMA for handling any RDP interactions or proxy connections. |
operationModel( OperationModel ) | Optional. Sets the operation model to either of these: • OperationModel.API_DISPATCH (default) • OperationModel.USER_DISPATCH |
password( const EmaString& ) | Required for Version 1 oAuthPasswordGrant authentication. Specifies the password used together with the username to obtain the access token. |
position( const EmaString& ) | Sets the position variable. position has no default value. |
proxyDomain(const EmaString& ) | Optional. Specifies the domain for an NTLM or Kerberos authenticated proxy. |
proxyPasswd(const EmaString& ) | Optional. Sets password for proxy authentication. |
proxyUserName(const EmaString& ) | Optional. Sets username for proxy authentication. |
restLoggingCallback ( OmmRestLoggingClient& ) | Optional. When this callback is set or specified in OmmConsumer client config (defined as OmmRestLoggingClient), REST message logs (if enabled) may be received by EMA application via onRestLoggingEvent. |
restProxyDomain(const EmaString& ) | Optional. 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. restProxyDomain should be the same as the domain in the “realms” and “domain_realm” sections of the Kerberos configuration file. |
restProxyHostName(const EmaString& ) | Optional. Specifies the address or host name of the proxy server for REST requests: service discovery and auth token service. |
restProxyPasswd(const EmaString& ) | Optional. Specifies the password to authenticate to the proxy server for REST requests: service discovery and auth token service. Needed for all authentication protocols. |
restProxyPort(const EmaString& ) | Optional. Specifies the port number of the proxy server for REST requests: service discovery and auth token service. |
restProxyUserName(const EmaString& ) | Optional. Specifies the user name to authenticate to the proxy server for REST requests: service discovery and auth token service. Needed for all authentication protocols. |
ServiceDiscoveryUrl( const EmaString& ) | Optional. Specifies a URL to override the default for the RDP service discovery to get global endpoints. Default value is https://api.refinitiv.com/streaming/pricing/v1/. |
sslCAStore(const EmaString& ) | Optional. Specifies the location (either directory or file path) of the Certificate Authority store. This is optional. By default, EMA will load the system's default Certificate Authority store. |
takeExclusiveSignOnControl( bool) | Optional. Specifies exclusive sign on control to force sign-out of other applications using the same credentials. Default value is True. |
tokenScope( const EmaString& ) | Optional for Version 1 and Version 2 authentication. Specifies token scope to override the default for limiting the scope of generated token from the token service. Defaults to trapi.streaming.pricing.read. |
tokenServiceUrlV1( const EmaString& ) | Optional. Specifies a URL to override the default for token service V1 oAuthPasswordGrant to perform authentication to get access and refresh tokens. Default value is https://api.refinitiv.com/auth/oauth2/v1/token. |
tokenServiceUrlV2( const EmaString& ) | Optional. Specifies a URL to override the default for token service V2 oAuthClientCredentials to perform authentication to get access and refresh tokens. Default value is https://api.refinitiv.com/auth/oauth2/v2/token. |
tunnelingLibCryptoName( const EmaString& ) | Optional. Specifies the name of the libcrypto.so shared library for Encrypted connections. See Enterprise Message API C++ Edition Developers Guide for details on default libcrypto names per platform and OpenSSL version. |
tunnelingLibSslName( const EmaString& ) | Optional. Specifies the name of the libssl.so shared library for Encrypted connections. See the Enterprise Message API C++ Edition Developers Guide for details on default libssl names per platform and OpenSSL version. |
tunnelingProxyHostName( const EmaString& ) | Optional. Specifies the host name of an HTTP Proxy for any Socket, Websocket, or Encrypted connections. |
tunnelingProxyPort( const EmaString& ) | Optional. Specifies the port number of the proxy server to connect to for an HTTP connection. |
tunnelingSecurityProtocol( int ) | Optional. Specifies the cryptographic protocols to be used for an Encrypted connection. The highest value of TLS will be selected by the EMA API first, then it will roll back if the encryption handshake fails. TLS 1.2 and TLS 1.3 are supported. |
OmmConsumerConfig& tunnelingSecurityProtocol(int securityProtocol) | Specifies the cryptographic protocols to be used for an Encrypted connection on a Linux operating system. The protocol supports TLS v1.2 and TLS v1.3. Use OmmConsumerConfig::EncryptedProtocolTypes flags to set allowed protocols. @param[in] securityProtocol specifies a cryptopgraphic protocol. @return reference to this object. |
username( const EmaString& ) | Required for Version 1 oAuthPasswordGrant authentication. Specifies the username used to obtain the authentication token from the Delivery Platform and provisioned with Machine Account. Optional otherwise. Sets username; if not specified, username is extracted from run-time environment. |