EMA C++ Edition
OmmNiProviderConfig.h
Go to the documentation of this file.
1/*|-----------------------------------------------------------------------------
2 *| This source code is provided under the Apache 2.0 license
3 *| and is provided AS IS with no warranty or guarantee of fit for purpose.
4 *| See the project's LICENSE.md for details.
5 *| Copyright (C) 2019-2024 LSEG. All rights reserved. --
6 *|-----------------------------------------------------------------------------
7 */
8
9#ifndef __refinitiv_ema_access_OmmNiProviderConfig_h
10#define __refinitiv_ema_access_OmmNiProviderConfig_h
11
34
35namespace refinitiv {
36
37namespace ema {
38
39namespace access {
40
41class Data;
42class ReqMsg;
43class RefreshMsg;
44class OmmNiProviderConfigImpl;
45
47{
48public :
49
53 {
55 ApiDispatchEnum
56 };
57
61 {
62 ENC_NONE = 0x00,
63 ENC_TLSV1_2 = 0x04,
64 ENC_TLSV1_3 = 0x08
65 };
66
70 {
72 ApiControlEnum
73 };
74
76
77
81
83
84
90
92
93
97
99
100
105
107
108
113
119
125
131
138
145
157 OmmNiProviderConfig& host( const EmaString& host = "localhost:14003" );
158
166
175
181 OmmNiProviderConfig& operationModel( OperationModel operationModel = ApiDispatchEnum );
182
188
195
202
209
219
226
233
240
247
253
259
271
278
283 OmmNiProviderConfig& config( const Data& config );
284
291
298
305
313
321
322private:
323
324 friend class OmmNiProviderImpl;
325 friend class OmmProvider;
326
327 OmmNiProviderConfigImpl* _pImpl;
328
329 OmmNiProviderConfigImpl* getConfigImpl() const;
330
332 OmmNiProviderConfig& operator=( const OmmNiProviderConfig& );
333};
334
335}
336
337}
338
339}
340
341#endif // __refinitiv_ema_access_OmmNiProviderConfig_h
#define EMA_ACCESS_API
Definition: Common.h:95
*|--------------------------------------------------------------------------—
Definition: AckMsg.h:62
The access namespace contains all interfaces and definitions specified for use with the EMA Access pa...
The ema namespace contains all interfaces and definitions specified for use with EMA.
Data class is a parent abstract class defining common interfaces for all Data type classes.
Definition: Data.h:39
EmaString class is a container of a null terminated Ascii character string.
Definition: EmaString.h:57
OmmNiProviderConfig is used to specify configuration and behaviour of NonInteractive OmmProvider.
OmmNiProviderConfig & applicationId(const EmaString &applicationId)
OmmNiProviderConfig & host(const EmaString &host="localhost:14003")
OmmNiProviderConfig & operationModel(OperationModel operationModel=ApiDispatchEnum)
OmmNiProviderConfig & adminControlDirectory(AdminControl control=ApiControlEnum)
OmmNiProviderConfig & sslCAStore(const EmaString &sslCAStore)
OmmNiProviderConfig & instanceId(const EmaString &instanceId)
OmmNiProviderConfig & proxyPasswd(const EmaString &proxyPasswd)
OmmNiProviderConfig & tunnelingLibCryptoName(const EmaString &libcryptoName)
OmmNiProviderConfig & tunnelingSecurityProtocol(int securityProtocol)
OmmNiProviderConfig & position(const EmaString &position)
OmmNiProviderConfig & channelType(EmaConfig::ConnectionTypeEnum channelType)
OmmNiProviderConfig & password(const EmaString &password)
OmmNiProviderConfig & proxyUserName(const EmaString &proxyUserName)
OmmNiProviderConfig & addAdminMsg(const ReqMsg &reqMsg)
OmmNiProviderConfig & encryptedProtocolType(EmaConfig::EncryptedProtocolTypeEnum encProtocolType)
OmmNiProviderConfig & proxyDomain(const EmaString &proxyDomain)
OmmNiProviderConfig & addAdminMsg(const RefreshMsg &refreshMsg)
OmmNiProviderConfig & tunnelingObjectName(const EmaString &objectName)
OmmNiProviderConfig & username(const EmaString &username)
OmmNiProviderConfig & apiThreadBind(const EmaString &cpuString)
OmmNiProviderConfig & config(const Data &config)
OmmNiProviderConfig & workerThreadBind(const EmaString &cpuString)
OmmNiProviderConfig & tunnelingProxyPort(const EmaString &proxyPort)
OmmNiProviderConfig & tunnelingProxyHostName(const EmaString &proxyHostName)
OmmNiProviderConfig & libcurlName(const EmaString &libcurlName)
OmmNiProviderConfig & tunnelingLibSslName(const EmaString &libsslName)
OmmNiProviderConfig & shouldInitializeCPUIDlib(bool shouldInitCPUIDlib)
OmmNiProviderConfig & providerName(const EmaString &providerName)
OmmProvider class encapsulates functionality of an Interactive and NonInteractive OmmProvider applica...
Definition: OmmProvider.h:163
OmmProviderConfig is a base class for the OmmNiProviderConfig.
RefreshMsg conveys item image, state, permission and group information.
Definition: RefreshMsg.h:80
ReqMsg allows consumer application to express its interest in an item.
Definition: ReqMsg.h:60