EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
List of all members | Public Types | Friends
thomsonreuters::ema::access::OmmIProviderConfig Class Reference

OmmIProviderConfig is used to specify configuration and behaviour of Interactive OmmProvider. More...

Inheritance diagram for thomsonreuters::ema::access::OmmIProviderConfig:
thomsonreuters::ema::access::OmmProviderConfig

Public Types

enum  AdminControl {
  UserControlEnum,
  ApiControlEnum
}
 
enum  OperationModel {
  UserDispatchEnum,
  ApiDispatchEnum
}
 
- Public Types inherited from thomsonreuters::ema::access::OmmProviderConfig
enum  ProviderRole {
  NonInteractiveEnum,
  InteractiveEnum
}
 

Public Member Functions

Constructor
 OmmIProviderConfig ()
 
 OmmIProviderConfig (const EmaString &path)
 
Destructor
virtual ~OmmIProviderConfig ()
 
Accessors
ProviderRole getProviderRole () const
 
Operations
OmmIProviderConfigclear ()
 
OmmIProviderConfigport (const EmaString &port="14002")
 
OmmIProviderConfigoperationModel (OperationModel operationModel=ApiDispatchEnum)
 
OmmIProviderConfigadminControlDirectory (AdminControl control=ApiControlEnum)
 
OmmIProviderConfigadminControlDictionary (AdminControl control=ApiControlEnum)
 
OmmIProviderConfigproviderName (const EmaString &providerName)
 
OmmIProviderConfigconfig (const Data &config)
 
OmmIProviderConfiglibSslName (const EmaString &libsslName)
 
OmmIProviderConfiglibCryptoName (const EmaString &libcryptoName)
 
OmmIProviderConfiglibCurlName (const EmaString &libcurlName)
 
OmmIProviderConfigserverCert (const EmaString &serverCert)
 
OmmIProviderConfigserverPrivateKey (const EmaString &serverPrivateKey)
 
OmmIProviderConfigcipherSuite (const EmaString &cipherSuite)
 
OmmIProviderConfigdhParams (const EmaString &dhParams)
 
OmmIProviderConfigaddAdminMsg (const RefreshMsg &refreshMsg)
 
- Public Member Functions inherited from thomsonreuters::ema::access::OmmProviderConfig
virtual ~OmmProviderConfig ()
 

Friends

class OmmIProviderImpl
 
class OmmProvider
 

Additional Inherited Members

- Protected Member Functions inherited from thomsonreuters::ema::access::OmmProviderConfig
 OmmProviderConfig ()
 

Detailed Description

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.

Remarks
All methods in this class are Lock-free Method.
See Also
OmmProvider, OmmProviderConfig

Definition at line 44 of file OmmIProviderConfig.h.

Member Enumeration Documentation

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
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.

Constructor & Destructor Documentation

thomsonreuters::ema::access::OmmIProviderConfig::OmmIProviderConfig ( )

Constructs OmmIProviderConfig

thomsonreuters::ema::access::OmmIProviderConfig::OmmIProviderConfig ( const EmaString path)

Constructs OmmIProviderConfig

Parameters
[in]pathspecifies 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
virtual thomsonreuters::ema::access::OmmIProviderConfig::~OmmIProviderConfig ( )
virtual

Destructor.

Member Function Documentation

OmmIProviderConfig& thomsonreuters::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.

Parameters
[in]refreshMsgspecifies administrative domain refresh message
Returns
reference to this object
OmmIProviderConfig& thomsonreuters::ema::access::OmmIProviderConfig::adminControlDictionary ( AdminControl  control = ApiControlEnum)

Specifies whether API or user controls responding to dictionary requests.

Parameters
[in]controlspecifies who responds to dictioanry requests
Returns
reference to this object
OmmIProviderConfig& thomsonreuters::ema::access::OmmIProviderConfig::adminControlDirectory ( AdminControl  control = ApiControlEnum)

Specifies whether API or user controls sending of Directory refresh message.

Parameters
[in]controlspecifies who sends down the directory refresh message
Returns
reference to this object
OmmIProviderConfig& thomsonreuters::ema::access::OmmIProviderConfig::cipherSuite ( const EmaString cipherSuite)
Optionally Specifies the cipher suites used by the provider.  This is an OpenSSL formatted string string.
Parameters
[in]cipherSuitespecifies the ciphers to be used by the provider
Returns
reference to this object
OmmIProviderConfig& thomsonreuters::ema::access::OmmIProviderConfig::clear ( )

Clears the OmmNiProviderConfig and sets all the defaults.

Remarks
Invoking clear() method clears all the values and resets all the defaults
Returns
reference to this object
OmmIProviderConfig& thomsonreuters::ema::access::OmmIProviderConfig::config ( const Data config)

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

Parameters
[in]configspecifies OmmProvider configuration
Returns
reference to this object
OmmIProviderConfig& thomsonreuters::ema::access::OmmIProviderConfig::dhParams ( const EmaString dhParams)
Specifies an optional DH Parameter file to be used with the provder.
Parameters
[in]dhParamsspecifies the DH parameter file
Returns
reference to this object
ProviderRole thomsonreuters::ema::access::OmmIProviderConfig::getProviderRole ( ) const
virtual

Retrieve Provider's role

Returns
role of this OmmIProviderConfig instance

Implements thomsonreuters::ema::access::OmmProviderConfig.

OmmIProviderConfig& thomsonreuters::ema::access::OmmIProviderConfig::libCryptoName ( const EmaString libcryptoName)
Specifies the name of the libcrypto.so shared library for Encrypted connections.
Parameters
[in]libcryptoNamespecifies the name of the libcrypto.so shared library
Returns
reference to this object
OmmIProviderConfig& thomsonreuters::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.
Parameters
[in]libcryptoNamespecifies the name of the libcrypto.so shared library
Returns
reference to this object
OmmIProviderConfig& thomsonreuters::ema::access::OmmIProviderConfig::libSslName ( 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
OmmIProviderConfig& thomsonreuters::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.

Parameters
[in]specifiesthreading and dispatching model used by application
Returns
reference to this object
OmmIProviderConfig& thomsonreuters::ema::access::OmmIProviderConfig::port ( const EmaString port = "14002")

Specifies a port. Overrides prior value.

Remarks
Implies usage of TCP IP channel or RSSL_SOCKET.
Parameters
[in]portspecifies server port on which OmmProvider will accept client connections
Returns
reference to this object
OmmIProviderConfig& thomsonreuters::ema::access::OmmIProviderConfig::providerName ( const EmaString providerName)

Create an OmmProvider with providerName. This name identifies configuration section to be used by OmmProvider instance.

Parameters
[in]providerNamespecifies name of OmmProvider instance
Returns
reference to this object
OmmIProviderConfig& thomsonreuters::ema::access::OmmIProviderConfig::serverCert ( const EmaString serverCert)
Specifies the location of the server certificate file for encrypted providers.
Parameters
[in]serverCertspecifies the name of the server certificate file
Returns
reference to this object
OmmIProviderConfig& thomsonreuters::ema::access::OmmIProviderConfig::serverPrivateKey ( const EmaString serverPrivateKey)
Specifies the location of the private key file for encrypted providers.
Parameters
[in]serverPrivateKeyspecifies the name of the private key file
Returns
reference to this object

Friends And Related Function Documentation

friend class OmmIProviderImpl
friend

Definition at line 196 of file OmmIProviderConfig.h.

friend class OmmProvider
friend

Definition at line 197 of file OmmIProviderConfig.h.