OmmNiProviderConfig is used to specify configuration and behaviour of NonInteractive OmmProvider. More...
Public Types | |
enum | AdminControl { UserControlEnum , ApiControlEnum } |
enum | EncryptionProtocolTypes { ENC_NONE = 0x00 , ENC_TLSV1_2 = 0x04 , ENC_TLSV1_3 = 0x08 } |
enum | OperationModel { UserDispatchEnum , ApiDispatchEnum } |
![]() | |
enum | ProviderRole { NonInteractiveEnum , InteractiveEnum } |
Public Member Functions | |
Constructor | |
OmmNiProviderConfig () | |
More... | |
OmmNiProviderConfig (const EmaString &path) | |
More... | |
Destructor | |
virtual | ~OmmNiProviderConfig () |
More... | |
Accessors | |
ProviderRole | getProviderRole () const |
More... | |
![]() | |
virtual | ~OmmProviderConfig () |
More... | |
Additional Inherited Members | |
![]() | |
OmmProviderConfig () | |
More... | |
OmmNiProviderConfig provides a default basic NonInteractive OmmProvider 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 OmmNiProviderConfig class overrides or appends the existing configuration.
Definition at line 46 of file OmmNiProviderConfig.h.
Enumerator | |
---|---|
UserControlEnum | specifies user submit directory refresh message |
ApiControlEnum | specifies API sends down directory refresh message based on the configuration |
Definition at line 69 of file OmmNiProviderConfig.h.
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 60 of file OmmNiProviderConfig.h.
Enumerator | |
---|---|
UserDispatchEnum | specifies callbacks happen on user thread of control |
ApiDispatchEnum | specifies callbacks happen on API thread of control |
Definition at line 52 of file OmmNiProviderConfig.h.
refinitiv::ema::access::OmmNiProviderConfig::OmmNiProviderConfig | ( | ) |
Constructs OmmNiProviderConfig
refinitiv::ema::access::OmmNiProviderConfig::OmmNiProviderConfig | ( | const EmaString & | path | ) |
Constructs OmmNiProviderConfig
[in] | path | specifies configuration file name or name of directory containing a file named EmaConfig.xml |
|
virtual |
Destructor.
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::addAdminMsg | ( | const RefreshMsg & | refreshMsg | ) |
Specifies an administrative refresh message to override the default administrative refresh. Application may call multiple times prior to initialization. Supports Directory domain only.
[in] | refreshMsg | specifies administrative domain refresh message |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::addAdminMsg | ( | const ReqMsg & | reqMsg | ) |
Specifies an administrative request message to override the default administrative request. Application may call multiple times prior to initialization. Supports Login domain only.
[in] | reqMsg | specifies administrative domain request message |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::adminControlDirectory | ( | AdminControl | control = ApiControlEnum | ) |
Specifies whether API or user controls sending of Directory refresh message.
[in] | control | specifies who sends down the directory refresh message |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::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.
[in] | cpuString | specifies the Cpu core in string format (Cpu core id or P:X C:Y T:Z format). |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::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.
[in] | applicationId | specifies respective login request attribute |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::channelType | ( | EmaConfig::ConnectionTypeEnum | channelType | ) |
Specifies connection type. Overrides prior value
[in] | specifies | connection type used by application. Connection type defined in EmaConfig::ConnectionTypeEnum |
OmmInvalidUsageException | if use this API with WarmStandby channel configuration. |
OmmInvalidUsageException | if channelType is not valid. |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::clear | ( | ) |
Clears the OmmNiProviderConfig and sets all the defaults.
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::config | ( | const Data & | config | ) |
Specifies the local configuration, overriding and adding to the current content.
[in] | config | specifies OmmProvider configuration |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::encryptedProtocolType | ( | EmaConfig::EncryptedProtocolTypeEnum | encProtocolType | ) |
Specifies encrypted protocol type. Overrides prior value
[in] | specifies | encrypted protocol type used by application. Encrypted protocol type defined in EmaConfig::EncryptedProtocolTypeEnum |
OmmInvalidUsageException | if use this API with WarmStandby channel configuration. |
OmmInvalidUsageException | if use this API with not encoded channel type. |
OmmInvalidUsageException | if encProtocolType is not valid. |
|
virtual |
Retrieve Provider's role
Implements refinitiv::ema::access::OmmProviderConfig.
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::host | ( | const EmaString & | host = "localhost:14003" | ) |
Specifies a hostname and port. Overrides prior value.
[in] | host | specifies server and port to which OmmProvider will connect |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::instanceId | ( | const EmaString & | instanceId | ) |
Specifies the instance identifier. Can be any ASCII string, e.g. "Instance1". Used to differentiate applications running on the same client host.
[in] | instanceId | specifies respective login request attribute |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::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.
[in] | libcurlName | specifies the name of the libcurl.so shared library |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::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.
[in] | specifies | threading and dispatching model used by application |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::password | ( | const EmaString & | password | ) |
Specifies the password. Overrides a value specified in Login domain via the addAdminMsg( const ReqMsg& ) method.
[in] | password | specifies respective login request attribute |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::position | ( | const EmaString & | position | ) |
Specifies the position. Overrides a value specified in Login domain via the addAdminMsg( const ReqMsg& ) method.
[in] | position | specifies respective login request attribute |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::providerName | ( | const EmaString & | providerName | ) |
Create an OmmProvider with providerName. This name identifies configuration section to be used by OmmProvider instance.
[in] | providerName | specifies name of OmmProvider instance |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::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.
[in] | proxyDomain | specifies the domain used for tunneling connection. |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::proxyPasswd | ( | const EmaString & | proxyPasswd | ) |
Specifies the passwd to authenticate. Needed for all authentication protocols.
[in] | proxyPasswd | specifies password used for tunneling connection. |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::proxyUserName | ( | const EmaString & | proxyUserName | ) |
Specifies the user name to authenticate. Needed for all authentication protocols.
[in] | proxyUserName | specifies user name used for tunneling connection. |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::shouldInitializeCPUIDlib | ( | bool | shouldInitCPUIDlib | ) |
Specifies should ETA initialize CpuID library. It will analyze CPU topology. Application may call multiple times prior to initialization.
[in] | shouldInitCPUIDlib | true ETA should initialize CpuID library; otherwise ETA will not initialize CpuID library. |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::sslCAStore | ( | const EmaString & | sslCAStore | ) |
Specifies the path to an OpenSSL Certificate Authority store.
[in] | sslCAStore | specifies the file or directory where the CA store is located. |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::tunnelingLibCryptoName | ( | const EmaString & | libcryptoName | ) |
Specifies the name of the libcrypto.so shared library for Encrypted connections on a Linux operating system.
[in] | libsslName | specifies the name of the libcrypto.so shared library |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::tunnelingLibSslName | ( | const EmaString & | libsslName | ) |
Specifies the name of the libssl.so shared library for Encrypted connections on a Linux operating system.
[in] | libsslName | specifies the name of the libssl.so shared library |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::tunnelingObjectName | ( | const EmaString & | objectName | ) |
Specifies the object name to pass along with the underlying URL in HTTP and HTTPS connection messages.
[in] | objectName | specifies the object name. |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::tunnelingProxyHostName | ( | const EmaString & | proxyHostName | ) |
Specifies the address or host name of the proxy server to connect to for an HTTP or HTTPS connection.
[in] | proxyHostName | specifies the address or host name of the proxy server for tunneling connection. |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::tunnelingProxyPort | ( | const EmaString & | proxyPort | ) |
Specifies the port number of the proxy server to connect to for an HTTP or HTTPS connection.
[in] | proxyPort | specifies the port number of the proxy server for tunneling connection. |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::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 OmmNiProviderConfig::EncryptionProtocolTypes flags to set allowed protocols.
[in] | securityProtocol | specifies a cryptopgraphic protocol. |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::username | ( | const EmaString & | username | ) |
Specifies the username. Overrides a value specified in Login domain via the addAdminMsg( const ReqMsg& ) method.
[in] | username | specifies name used on login request |
OmmNiProviderConfig& refinitiv::ema::access::OmmNiProviderConfig::workerThreadBind | ( | const EmaString & | cpuString | ) |
Specifies the Cpu core to bind for Reactor Worker thread. Application may call multiple times prior to initialization.
[in] | cpuString | specifies the Cpu core in string format (Cpu core id or P:X C:Y T:Z format). |
![]() |
![]() |
|