OmmIProviderConfig is used to specify configuration and behaviour of Interactive 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 | |
OmmIProviderConfig () | |
More... | |
OmmIProviderConfig (const EmaString &path) | |
More... | |
Destructor | |
virtual | ~OmmIProviderConfig () |
More... | |
Accessors | |
ProviderRole | getProviderRole () const |
More... | |
![]() | |
virtual | ~OmmProviderConfig () |
More... | |
Additional Inherited Members | |
![]() | |
OmmProviderConfig () | |
More... | |
OmmIProviderConfig provides a default basic Interactive 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 OmmIProviderConfig class overrides or appends the existing configuration.
Definition at line 44 of file OmmIProviderConfig.h.
Enumerator | |
---|---|
UserControlEnum | specifies user submit directory refresh message |
ApiControlEnum | specifies API sends down directory refresh message based on the configuration |
Definition at line 58 of file OmmIProviderConfig.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 66 of file OmmIProviderConfig.h.
Enumerator | |
---|---|
UserDispatchEnum | specifies callbacks happen on user thread of control |
ApiDispatchEnum | specifies callbacks happen on API thread of control |
Definition at line 50 of file OmmIProviderConfig.h.
refinitiv::ema::access::OmmIProviderConfig::OmmIProviderConfig | ( | ) |
Constructs OmmIProviderConfig
refinitiv::ema::access::OmmIProviderConfig::OmmIProviderConfig | ( | const EmaString & | path | ) |
Constructs OmmIProviderConfig
[in] | path | specifies configuration file name or name of directory containing a file named EmaConfig.xml |
|
virtual |
Destructor.
OmmIProviderConfig& refinitiv::ema::access::OmmIProviderConfig::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 and Dictionary domains only.
[in] | refreshMsg | specifies administrative domain refresh message |
OmmIProviderConfig& refinitiv::ema::access::OmmIProviderConfig::adminControlDictionary | ( | AdminControl | control = ApiControlEnum | ) |
Specifies whether API or user controls responding to dictionary requests.
[in] | control | specifies who responds to dictioanry requests |
OmmIProviderConfig& refinitiv::ema::access::OmmIProviderConfig::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 |
OmmIProviderConfig& refinitiv::ema::access::OmmIProviderConfig::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). |
OmmIProviderConfig& refinitiv::ema::access::OmmIProviderConfig::cipherSuite | ( | const EmaString & | cipherSuite | ) |
Optionally Specifies the cipher suites used by the provider. This is an OpenSSL formatted string string.
[in] | cipherSuite | specifies the ciphers to be used by the provider |
OmmIProviderConfig& refinitiv::ema::access::OmmIProviderConfig::clear | ( | ) |
Clears the OmmNiProviderConfig and sets all the defaults.
OmmIProviderConfig& refinitiv::ema::access::OmmIProviderConfig::config | ( | const Data & | config | ) |
Specifies the local configuration, overriding and adding to the current content.
[in] | config | specifies OmmProvider configuration |
OmmIProviderConfig& refinitiv::ema::access::OmmIProviderConfig::dhParams | ( | const EmaString & | dhParams | ) |
Specifies an optional DH Parameter file to be used with the provder.
[in] | dhParams | specifies the DH parameter file |
|
virtual |
Retrieve Provider's role
Implements refinitiv::ema::access::OmmProviderConfig.
OmmIProviderConfig& refinitiv::ema::access::OmmIProviderConfig::libCryptoName | ( | const EmaString & | libcryptoName | ) |
Specifies the name of the libcrypto.so shared library for Encrypted connections.
[in] | libcryptoName | specifies the name of the libcrypto.so shared library |
OmmIProviderConfig& refinitiv::ema::access::OmmIProviderConfig::libCurlName | ( | const EmaString & | libcurlName | ) |
Specifies the name of the libcurl.so shared library. This is not used server side connections, but this is required on first initialization for both REST and proxy connections.
[in] | libcryptoName | specifies the name of the libcrypto.so shared library |
OmmIProviderConfig& refinitiv::ema::access::OmmIProviderConfig::libSslName | ( | const EmaString & | libsslName | ) |
Specifies the name of the libssl.so shared library for Encrypted connections
[in] | libsslName | specifies the name of the libssl.so shared library |
OmmIProviderConfig& refinitiv::ema::access::OmmIProviderConfig::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 |
OmmIProviderConfig& refinitiv::ema::access::OmmIProviderConfig::port | ( | const EmaString & | port = "14002" | ) |
Specifies a port. Overrides prior value.
[in] | port | specifies server port on which OmmProvider will accept client connections |
OmmIProviderConfig& refinitiv::ema::access::OmmIProviderConfig::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 |
OmmIProviderConfig& refinitiv::ema::access::OmmIProviderConfig::securityProtocol | ( | 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. |
OmmIProviderConfig& refinitiv::ema::access::OmmIProviderConfig::serverCert | ( | const EmaString & | serverCert | ) |
Specifies the location of the server certificate file for encrypted providers.
[in] | serverCert | specifies the name of the server certificate file |
OmmIProviderConfig& refinitiv::ema::access::OmmIProviderConfig::serverPrivateKey | ( | const EmaString & | serverPrivateKey | ) |
Specifies the location of the private key file for encrypted providers.
[in] | serverPrivateKey | specifies the name of the private key file |
OmmIProviderConfig& refinitiv::ema::access::OmmIProviderConfig::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. |
OmmIProviderConfig& refinitiv::ema::access::OmmIProviderConfig::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). |
![]() |
![]() |
|