28#ifndef INCLUDED_BLPAPI_SESSIONOPTIONS
29#define INCLUDED_BLPAPI_SESSIONOPTIONS
90#ifndef INCLUDED_BLPAPI_CALL
94#ifndef INCLUDED_BLPAPI_CORRELATIONID
98#ifndef INCLUDED_BLPAPI_DEFS
102#ifndef INCLUDED_BLPAPI_EXCEPTION
106#ifndef INCLUDED_BLPAPI_STREAMPROXY
110#ifndef INCLUDED_BLPAPI_TLSOPTIONS
114#ifndef INCLUDED_BLPAPI_TYPES
153 const char *serverHost,
154 unsigned short serverPort,
160 const char *serverHost,
161 unsigned short serverPort,
172 unsigned int timeoutInMilliseconds);
189 int allowMultipleCorrelatorsPerMsg);
210 blpapi_CorrelationId_t *cid);
282 const char **serverHost,
283 unsigned short *serverPort,
289 const char **serverHost,
290 unsigned short *serverPort,
291 const char **socks5Host,
292 unsigned short *sock5Port,
391 const char *applicationIdentityKey,
395 const char **applicationIdentityKey,
401 const char *sessionName,
943 std::ostream&
print(std::ostream& stream,
945 int spacesPerLevel = 4)
const;
965 std::ostream& stream,
const SessionOptions& sessionOptions);
1021 const char *serverHost,
unsigned short serverPort,
size_t index)
1028 unsigned short serverPort,
1044 d_handle_p, timeoutMilliSeconds));
1053 const char *serviceIdentifier)
1056 d_handle_p, serviceIdentifier);
1065 bool newAllowMultipleCorrelatorsPerMsg)
1068 d_handle_p, newAllowMultipleCorrelatorsPerMsg);
1073#if BLPAPI_COMPAT_33X
1083 d_handle_p, newMaxPendingRequests);
1089 d_handle_p, autoRestart ? 1 : 0);
1095 blpapi_CorrelationId_t cidHandle = cid.impl();
1099 d_handle_p, authOptions.
handle(), &cidHandle));
1117 d_handle_p, eventQueueSize);
1125 d_handle_p, hiWaterMark));
1133 d_handle_p, loWaterMark));
1141 d_handle_p, inactivityTime));
1145 int responseTimeout)
1149 d_handle_p, responseTimeout));
1155 d_handle_p, isEnabled));
1162 d_handle_p, shouldRecrod);
1169 d_handle_p, timeoutMsecs));
1176 d_handle_p, timeoutMsecs));
1182 (d_handle_p, tlsOptions.
handle());
1189 d_handle_p, timeoutMsecs));
1196 d_handle_p, isDisabled));
1206 return static_cast<unsigned short>(
1212 return static_cast<size_t>(
1217 unsigned short *serverPortOut,
1221 d_handle_p, serverHostOut, serverPortOut, index);
1225 unsigned short *serverPortOut,
1229 const char *socks5ConfigHost = 0;
1230 unsigned short socks5ConfigPort = 0;
1239 if (socks5ConfigHost) {
1240 *socksConfig =
Socks5Config(socks5ConfigHost, socks5ConfigPort);
1366 const std::string& applicationIdentityKey)
1380 &aik, &size, d_handle_p));
1381 return std::string(aik, size);
1406 std::ostream& stream,
int indentLevel,
int spacesPerLevel)
const
1422 return sessionOptions.
print(stream, 0, -1);
Provides configuration settings for authorization.
Provide functions for dispatchtbl.
#define BLPAPI_CALL_SESSIONOPTIONS_SETMAXEVENTQUEUESIZE(a1, a2)
Definition blpapi_call.h:362
#define BLPAPI_CALL_SESSIONOPTION_RECORDSUBSCRIPTIONDATARECEIVETIMES(a1)
Definition blpapi_call.h:458
#define BLPAPI_CALL_SESSIONOPTIONS_DEFAULTKEEPALIVERESPONSETIMEOUT(a1)
Definition blpapi_call.h:380
#define BLPAPI_CALL_SESSIONOPTIONS_SLOWCONSUMERLOWATERMARK(a1)
Definition blpapi_call.h:375
#define BLPAPI_CALL_SESSIONOPTIONS_SETBANDWIDTHSAVEMODEDISABLED(a1, a2)
Definition blpapi_call.h:390
#define BLPAPI_CALL_SESSIONOPTION_SETRECORDSUBSCRIPTIONDATARECEIVETIMES( a1, a2)
Definition blpapi_call.h:455
#define BLPAPI_CALL_SESSIONOPTIONS_DEFAULTKEEPALIVEINACTIVITYTIME(a1)
Definition blpapi_call.h:378
#define BLPAPI_CALL_SESSIONOPTIONS_SETDEFAULTKEEPALIVEINACTIVITYTIME(a1, a2)
Definition blpapi_call.h:384
#define BLPAPI_CALL_SESSIONOPTIONS_SETSLOWCONSUMERHIWATERMARK(a1, a2)
Definition blpapi_call.h:364
#define BLPAPI_CALL_SESSIONOPTIONS_MAXEVENTQUEUESIZE(a1)
Definition blpapi_call.h:371
#define BLPAPI_CALL_AVAILABLE(FUNCNAME)
Definition blpapi_call.h:352
#define BLPAPI_CALL_SESSIONOPTIONS_SETDEFAULTKEEPALIVERESPONSETIMEOUT(a1, a2)
Definition blpapi_call.h:386
#define BLPAPI_CALL_SESSIONOPTIONS_KEEPALIVEENABLED(a1)
Definition blpapi_call.h:382
#define BLPAPI_CALL_SESSIONOPTIONS_SLOWCONSUMERHIWATERMARK(a1)
Definition blpapi_call.h:373
#define BLPAPI_CALL(FUNCNAME)
Definition blpapi_call.h:353
#define BLPAPI_CALL_SESSIONOPTIONS_BANDWIDTHSAVEMODEDISABLED(a1)
Definition blpapi_call.h:392
#define BLPAPI_CALL_SESSIONOPTIONS_SETKEEPALIVEENABLED(a1, a2)
Definition blpapi_call.h:388
#define BLPAPI_CALL_SESSIONOPTIONS_SETSLOWCONSUMERLOWATERMARK(a1, a2)
Definition blpapi_call.h:366
Provide a key to identify individual subscriptions or requests.
Common definitions used by the library.
#define BLPAPI_CLIENTMODE_COMPAT_33X
Definition blpapi_defs.h:112
#define BLPAPI_CLIENTMODE_DAPI
Definition blpapi_defs.h:110
#define BLPAPI_CLIENTMODE_SAPI
Definition blpapi_defs.h:111
#define BLPAPI_CLIENTMODE_AUTO
Definition blpapi_defs.h:109
#define BLPAPI_EXPORT
Definition blpapi_defs.h:171
Provide a collection of errors that library can return.
Defines Exceptions that can be thrown by the blpapi library.
BLPAPI_EXPORT int blpapi_SessionOptions_recordSubscriptionDataReceiveTimes(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int blpapi_SessionOptions_keepAliveEnabled(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int blpapi_SessionOptions_setServerAddressWithProxy(blpapi_SessionOptions_t *parameters, const char *serverHost, unsigned short serverPort, const blpapi_Socks5Config_t *socks5Config, size_t index)
BLPAPI_EXPORT int blpapi_SessionOptions_serviceDownloadTimeout(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int blpapi_SessionOptions_sessionName(const char **sessionName, size_t *size, blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT size_t blpapi_SessionOptions_maxEventQueueSize(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT void blpapi_SessionOptions_copy(blpapi_SessionOptions_t *lhs, const blpapi_SessionOptions_t *rhs)
BLPAPI_EXPORT int blpapi_SessionOptions_defaultKeepAliveInactivityTime(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int blpapi_SessionOptions_setDefaultKeepAliveResponseTimeout(blpapi_SessionOptions_t *parameters, int timeoutMsecs)
BLPAPI_EXPORT int blpapi_SessionOptions_defaultKeepAliveResponseTimeout(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT void blpapi_SessionOptions_setAllowMultipleCorrelatorsPerMsg(blpapi_SessionOptions_t *parameters, int allowMultipleCorrelatorsPerMsg)
BLPAPI_EXPORT int blpapi_SessionOptions_removeServerAddress(blpapi_SessionOptions_t *parameters, size_t index)
BLPAPI_EXPORT int blpapi_SessionOptions_print(blpapi_SessionOptions_t *parameters, blpapi_StreamWriter_t streamWriter, void *stream, int indentLevel, int spacesPerLevel)
BLPAPI_EXPORT void blpapi_SessionOptions_setNumStartAttempts(blpapi_SessionOptions_t *parameters, int numStartAttempts)
BLPAPI_EXPORT int blpapi_SessionOptions_setDefaultKeepAliveInactivityTime(blpapi_SessionOptions_t *parameters, int inactivityMsecs)
BLPAPI_EXPORT int blpapi_SessionOptions_clientMode(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT float blpapi_SessionOptions_slowConsumerWarningLoWaterMark(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT void blpapi_SessionOptions_setDefaultTopicPrefix(blpapi_SessionOptions_t *parameters, const char *prefix)
BLPAPI_EXPORT int blpapi_SessionOptions_setDefaultServices(blpapi_SessionOptions_t *parameters, const char *defaultServices)
BLPAPI_EXPORT int blpapi_SessionOptions_bandwidthSaveModeDisabled(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT void blpapi_SessionOptions_setClientMode(blpapi_SessionOptions_t *parameters, int clientMode)
BLPAPI_EXPORT const char * blpapi_SessionOptions_serverHost(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int blpapi_SessionOptions_getServerAddress(blpapi_SessionOptions_t *parameters, const char **serverHost, unsigned short *serverPort, size_t index)
BLPAPI_EXPORT const char * blpapi_SessionOptions_defaultServices(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT unsigned int blpapi_SessionOptions_connectTimeout(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int blpapi_SessionOptions_setBandwidthSaveModeDisabled(blpapi_SessionOptions_t *parameters, int disableBandwidthSaveMode)
BLPAPI_EXPORT int blpapi_SessionOptions_setServerPort(blpapi_SessionOptions_t *parameters, unsigned short serverPort)
BLPAPI_EXPORT int blpapi_SessionOptions_autoRestartOnDisconnection(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT void blpapi_SessionOptions_setAutoRestart(blpapi_SessionOptions_t *parameters, int autoRestart)
BLPAPI_EXPORT int blpapi_SessionOptions_setServerAddress(blpapi_SessionOptions_t *parameters, const char *serverHost, unsigned short serverPort, size_t index)
BLPAPI_EXPORT int blpapi_SessionOptions_setSessionName(blpapi_SessionOptions_t *parameters, const char *sessionName, size_t size)
BLPAPI_EXPORT int blpapi_SessionOptions_serviceCheckTimeout(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int blpapi_SessionOptions_setSessionIdentityOptions(blpapi_SessionOptions_t *parameters, const blpapi_AuthOptions_t *authOptions, blpapi_CorrelationId_t *cid)
BLPAPI_EXPORT void blpapi_SessionOptions_destroy(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int blpapi_SessionOptions_allowMultipleCorrelatorsPerMsg(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int blpapi_SessionOptions_setFlushPublishedEventsTimeout(blpapi_SessionOptions_t *paramaters, int timeoutMsecs)
BLPAPI_EXPORT int blpapi_SessionOptions_setServiceDownloadTimeout(blpapi_SessionOptions_t *paramaters, int timeoutMsecs)
BLPAPI_EXPORT void blpapi_SessionOptions_setRecordSubscriptionDataReceiveTimes(blpapi_SessionOptions_t *parameters, int shouldRecord)
BLPAPI_EXPORT const char * blpapi_SessionOptions_defaultSubscriptionService(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT float blpapi_SessionOptions_slowConsumerWarningHiWaterMark(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int blpapi_SessionOptions_setSlowConsumerWarningLoWaterMark(blpapi_SessionOptions_t *parameters, float loWaterMark)
BLPAPI_EXPORT blpapi_SessionOptions_t * blpapi_SessionOptions_duplicate(const blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT const char * blpapi_SessionOptions_defaultTopicPrefix(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT blpapi_SessionOptions_t * blpapi_SessionOptions_create(void)
BLPAPI_EXPORT int blpapi_SessionOptions_setServiceCheckTimeout(blpapi_SessionOptions_t *paramaters, int timeoutMsecs)
BLPAPI_EXPORT void blpapi_SessionOptions_setTlsOptions(blpapi_SessionOptions_t *paramaters, const blpapi_TlsOptions_t *tlsOptions)
BLPAPI_EXPORT int blpapi_SessionOptions_setServerHost(blpapi_SessionOptions_t *parameters, const char *serverHost)
BLPAPI_EXPORT int blpapi_SessionOptions_setApplicationIdentityKey(blpapi_SessionOptions_t *parameters, const char *applicationIdentityKey, size_t size)
BLPAPI_EXPORT int blpapi_SessionOptions_numServerAddresses(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT void blpapi_SessionOptions_setMaxEventQueueSize(blpapi_SessionOptions_t *parameters, size_t maxEventQueueSize)
BLPAPI_EXPORT unsigned int blpapi_SessionOptions_serverPort(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT void blpapi_SessionOptions_setAuthenticationOptions(blpapi_SessionOptions_t *parameters, const char *authOptions)
BLPAPI_EXPORT int blpapi_SessionOptions_applicationIdentityKey(const char **applicationIdentityKey, size_t *size, blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT const char * blpapi_SessionOptions_authenticationOptions(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT void blpapi_SessionOptions_setAutoRestartOnDisconnection(blpapi_SessionOptions_t *parameters, int autoRestart)
BLPAPI_EXPORT int blpapi_SessionOptions_setConnectTimeout(blpapi_SessionOptions_t *parameters, unsigned int timeoutInMilliseconds)
BLPAPI_EXPORT int blpapi_SessionOptions_maxPendingRequests(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int blpapi_SessionOptions_setDefaultSubscriptionService(blpapi_SessionOptions_t *parameters, const char *serviceIdentifier)
BLPAPI_EXPORT int blpapi_SessionOptions_setKeepAliveEnabled(blpapi_SessionOptions_t *parameters, int isEnabled)
BLPAPI_EXPORT int blpapi_SessionOptions_getServerAddressWithProxy(blpapi_SessionOptions_t *parameters, const char **serverHost, unsigned short *serverPort, const char **socks5Host, unsigned short *sock5Port, size_t index)
BLPAPI_EXPORT int blpapi_SessionOptions_flushPublishedEventsTimeout(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT void blpapi_SessionOptions_setMaxPendingRequests(blpapi_SessionOptions_t *parameters, int maxPendingRequests)
BLPAPI_EXPORT int blpapi_SessionOptions_numStartAttempts(blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int blpapi_SessionOptions_setSlowConsumerWarningHiWaterMark(blpapi_SessionOptions_t *parameters, float hiWaterMark)
BLPAPI_EXPORT int blpapi_SessionOptions_autoRestart(blpapi_SessionOptions_t *parameters)
Provide description of Socks5 proxy.
A signature for callback on print and default C++ implementation.
int(* blpapi_StreamWriter_t)(const char *data, int length, void *stream)
Definition blpapi_streamproxy.h:53
Maintain client credentials and trust material.
Definition blpapi_authoptions.h:194
blpapi_AuthOptions_t * handle() const
Definition blpapi_authoptions.h:491
Definition blpapi_correlationid.h:201
static void throwOnError(int errorCode)
Definition blpapi_exception.h:526
Definition blpapi_sessionoptions.h:431
std::string applicationIdentityKey()
Definition blpapi_sessionoptions.h:1374
size_t numServerAddresses() const
Definition blpapi_sessionoptions.h:1210
void setNumStartAttempts(int numStartAttempts)
Definition blpapi_sessionoptions.h:1109
bool autoRestartOnDisconnection() const
Definition blpapi_sessionoptions.h:1283
void setDefaultSubscriptionService(const char *serviceIdentifier)
Definition blpapi_sessionoptions.h:1052
void setDefaultServices(const char *defaultServices)
Definition blpapi_sessionoptions.h:1047
int numStartAttempts() const
Definition blpapi_sessionoptions.h:1293
int setServerAddress(const char *serverHost, unsigned short serverPort, size_t index)
Definition blpapi_sessionoptions.h:1020
void setFlushPublishedEventsTimeout(int timeoutMsecs)
Definition blpapi_sessionoptions.h:1185
int getServerAddress(const char **serverHost, unsigned short *serverPort, size_t index) const
Definition blpapi_sessionoptions.h:1216
void setMaxPendingRequests(int maxPendingRequests)
Definition blpapi_sessionoptions.h:1080
std::string sessionName()
Definition blpapi_sessionoptions.h:1391
int serviceCheckTimeout() const
Definition blpapi_sessionoptions.h:1340
bool allowMultipleCorrelatorsPerMsg() const
Definition blpapi_sessionoptions.h:1266
void setBandwidthSaveModeDisabled(bool isDisabled)
Definition blpapi_sessionoptions.h:1192
const char * defaultServices() const
Definition blpapi_sessionoptions.h:1251
void setDefaultKeepAliveInactivityTime(int inactivityMsecs)
Definition blpapi_sessionoptions.h:1136
SessionOptions & operator=(const SessionOptions &rhs)
Definition blpapi_sessionoptions.h:1004
void setAuthenticationOptions(const char *authOptions)
Definition blpapi_sessionoptions.h:1104
bool keepAliveEnabled() const
Definition blpapi_sessionoptions.h:1325
SessionOptions()
Definition blpapi_sessionoptions.h:985
const char * serverHost() const
Definition blpapi_sessionoptions.h:1199
unsigned short serverPort() const
Definition blpapi_sessionoptions.h:1204
void setServiceCheckTimeout(int timeoutMsecs)
Definition blpapi_sessionoptions.h:1165
void setServerHost(const char *host)
Definition blpapi_sessionoptions.h:1010
float slowConsumerWarningHiWaterMark() const
Definition blpapi_sessionoptions.h:1303
~SessionOptions()
Definition blpapi_sessionoptions.h:999
void setAutoRestartOnDisconnection(bool autoRestart)
Definition blpapi_sessionoptions.h:1086
void setTlsOptions(const TlsOptions &tlsOptions)
Definition blpapi_sessionoptions.h:1179
ClientMode
Definition blpapi_sessionoptions.h:440
@ SAPI
Always connect to the server API.
Definition blpapi_sessionoptions.h:447
@ DAPI
Always connect to the desktop API.
Definition blpapi_sessionoptions.h:444
@ AUTO
Automatic (desktop if available otherwise server)
Definition blpapi_sessionoptions.h:441
int maxPendingRequests() const
Definition blpapi_sessionoptions.h:1278
const char * defaultTopicPrefix() const
Definition blpapi_sessionoptions.h:1261
int removeServerAddress(size_t index)
Definition blpapi_sessionoptions.h:1036
blpapi_SessionOptions_t * handle() const
Definition blpapi_sessionoptions.h:1400
void setRecordSubscriptionDataReceiveTimes(bool shouldRecord)
Definition blpapi_sessionoptions.h:1158
CorrelationId setSessionIdentityOptions(const AuthOptions &authOptions, const CorrelationId &correlationId=CorrelationId())
Definition blpapi_sessionoptions.h:1092
void setKeepAliveEnabled(bool isEnabled)
Definition blpapi_sessionoptions.h:1152
void setServerPort(unsigned short port)
Definition blpapi_sessionoptions.h:1015
bool bandwidthSaveModeDisabled() const
Definition blpapi_sessionoptions.h:1357
int clientMode() const
Definition blpapi_sessionoptions.h:1273
void setSlowConsumerWarningLoWaterMark(float loWaterMark)
Definition blpapi_sessionoptions.h:1128
void setAllowMultipleCorrelatorsPerMsg(bool allowMultipleCorrelatorsPerMsg)
Definition blpapi_sessionoptions.h:1064
int defaultKeepAliveResponseTimeout() const
Definition blpapi_sessionoptions.h:1319
unsigned int connectTimeout() const
Definition blpapi_sessionoptions.h:1246
float slowConsumerWarningLoWaterMark() const
Definition blpapi_sessionoptions.h:1308
std::ostream & print(std::ostream &stream, int indentLevel=0, int spacesPerLevel=4) const
Definition blpapi_sessionoptions.h:1405
void setSlowConsumerWarningHiWaterMark(float hiWaterMark)
Definition blpapi_sessionoptions.h:1120
size_t maxEventQueueSize() const
Definition blpapi_sessionoptions.h:1298
bool recordSubscriptionDataReceiveTimes() const
Definition blpapi_sessionoptions.h:1332
void setSessionName(const std::string &sessionName)
Definition blpapi_sessionoptions.h:1384
const char * defaultSubscriptionService() const
Definition blpapi_sessionoptions.h:1256
void setDefaultKeepAliveResponseTimeout(int timeoutMsecs)
Definition blpapi_sessionoptions.h:1144
int serviceDownloadTimeout() const
Definition blpapi_sessionoptions.h:1345
const char * authenticationOptions() const
Definition blpapi_sessionoptions.h:1288
void setApplicationIdentityKey(const std::string &applicationIdentityKey)
Definition blpapi_sessionoptions.h:1365
void setDefaultTopicPrefix(const char *prefix)
Definition blpapi_sessionoptions.h:1059
int flushPublishedEventsTimeout() const
Definition blpapi_sessionoptions.h:1351
int defaultKeepAliveInactivityTime() const
Definition blpapi_sessionoptions.h:1313
void setMaxEventQueueSize(size_t eventQueueSize)
Definition blpapi_sessionoptions.h:1114
void setServiceDownloadTimeout(int timeoutMsecs)
Definition blpapi_sessionoptions.h:1172
void setConnectTimeout(unsigned int timeoutMilliSeconds)
Definition blpapi_sessionoptions.h:1041
void setClientMode(int clientMode)
Definition blpapi_sessionoptions.h:1071
Definition blpapi_socks5config.h:112
Definition blpapi_tlsoptions.h:188
blpapi_TlsOptions_t * handle() const
Definition blpapi_tlsoptions.h:344
struct blpapi_Socks5Config blpapi_Socks5Config_t
Definition blpapi_types.h:175
struct blpapi_SessionOptions blpapi_SessionOptions_t
Definition blpapi_types.h:172
struct blpapi_AuthOptions blpapi_AuthOptions_t
Definition blpapi_types.h:203
struct blpapi_TlsOptions blpapi_TlsOptions_t
Definition blpapi_types.h:178
std::ostream & operator<<(std::ostream &os, const CorrelationId &correlator)
Definition blpapi_correlationid.h:592
Definition blpapi_abstractsession.h:195
static int writeToStream(const char *data, int length, void *stream)
Definition blpapi_streamproxy.h:93