BLPAPI C++ 3.25.8
Loading...
Searching...
No Matches
blpapi_sessionoptions.h
Go to the documentation of this file.
1/* Copyright 2012. Bloomberg Finance L.P.
2 *
3 * Permission is hereby granted, free of charge, to any person obtaining a copy
4 * of this software and associated documentation files (the "Software"), to
5 * deal in the Software without restriction, including without limitation the
6 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
7 * sell copies of the Software, and to permit persons to whom the Software is
8 * furnished to do so, subject to the following conditions: The above
9 * copyright notice and this permission notice shall be included in all copies
10 * or substantial portions of the Software.
11 *
12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
13 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
14 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
15 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
16 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
17 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
18 * IN THE SOFTWARE.
19 */
20
28#ifndef INCLUDED_BLPAPI_SESSIONOPTIONS
29#define INCLUDED_BLPAPI_SESSIONOPTIONS
30
90#ifndef INCLUDED_BLPAPI_CALL
91#include <blpapi_call.h>
92#endif
93
94#ifndef INCLUDED_BLPAPI_CORRELATIONID
96#endif
97
98#ifndef INCLUDED_BLPAPI_DEFS
99#include <blpapi_defs.h>
100#endif
101
102#ifndef INCLUDED_BLPAPI_EXCEPTION
103#include <blpapi_exception.h>
104#endif
105
106#ifndef INCLUDED_BLPAPI_STREAMPROXY
107#include <blpapi_streamproxy.h>
108#endif
109
110#ifndef INCLUDED_BLPAPI_TLSOPTIONS
111#include <blpapi_tlsoptions.h>
112#endif
113
114#ifndef INCLUDED_BLPAPI_TYPES
115#include <blpapi_types.h>
116#endif
117
118#include <blpapi_authoptions.h>
119#include <blpapi_error.h>
120#include <blpapi_socks5config.h>
121
122#include <stddef.h>
123
124#ifdef __cplusplus
125
126extern "C" {
127#endif
128
131
134 const blpapi_SessionOptions_t *parameters);
135
139
142
145 blpapi_SessionOptions_t *parameters, const char *serverHost);
146
149 blpapi_SessionOptions_t *parameters, unsigned short serverPort);
150
153 const char *serverHost,
154 unsigned short serverPort,
155 size_t index);
156
159 blpapi_SessionOptions_t *parameters,
160 const char *serverHost,
161 unsigned short serverPort,
162 const blpapi_Socks5Config_t *socks5Config,
163 size_t index);
164
167 blpapi_SessionOptions_t *parameters, size_t index);
168
171 blpapi_SessionOptions_t *parameters,
172 unsigned int timeoutInMilliseconds);
173
176 blpapi_SessionOptions_t *parameters, const char *defaultServices);
177
180 blpapi_SessionOptions_t *parameters, const char *serviceIdentifier);
181
184 blpapi_SessionOptions_t *parameters, const char *prefix);
185
188 blpapi_SessionOptions_t *parameters,
189 int allowMultipleCorrelatorsPerMsg);
190
193 blpapi_SessionOptions_t *parameters, int clientMode);
194
197 blpapi_SessionOptions_t *parameters, int maxPendingRequests);
198
201 blpapi_SessionOptions_t *parameters, int autoRestart);
202
205 blpapi_SessionOptions_t *parameters, int autoRestart);
208 blpapi_SessionOptions_t *parameters,
209 const blpapi_AuthOptions_t *authOptions,
210 blpapi_CorrelationId_t *cid);
211
214 blpapi_SessionOptions_t *parameters, const char *authOptions);
215
218 blpapi_SessionOptions_t *parameters, int numStartAttempts);
219
222 blpapi_SessionOptions_t *parameters, size_t maxEventQueueSize);
223
226 blpapi_SessionOptions_t *parameters, float hiWaterMark);
227
230 blpapi_SessionOptions_t *parameters, float loWaterMark);
231
234 blpapi_SessionOptions_t *parameters, int inactivityMsecs);
235
238 blpapi_SessionOptions_t *parameters, int timeoutMsecs);
239
242 blpapi_SessionOptions_t *parameters, int isEnabled);
243
246 blpapi_SessionOptions_t *parameters, int shouldRecord);
247
250 blpapi_SessionOptions_t *paramaters, int timeoutMsecs);
251
254 blpapi_SessionOptions_t *paramaters, int timeoutMsecs);
255
258 const blpapi_TlsOptions_t *tlsOptions);
259
262 blpapi_SessionOptions_t *paramaters, int timeoutMsecs);
263
266 blpapi_SessionOptions_t *parameters, int disableBandwidthSaveMode);
267
270 blpapi_SessionOptions_t *parameters);
271
274 blpapi_SessionOptions_t *parameters);
275
278 blpapi_SessionOptions_t *parameters);
279
282 const char **serverHost,
283 unsigned short *serverPort,
284 size_t index);
285
288 blpapi_SessionOptions_t *parameters,
289 const char **serverHost,
290 unsigned short *serverPort,
291 const char **socks5Host,
292 unsigned short *sock5Port,
293 size_t index);
294
297 blpapi_SessionOptions_t *parameters);
298
301 blpapi_SessionOptions_t *parameters);
302
305 blpapi_SessionOptions_t *parameters);
306
309 blpapi_SessionOptions_t *parameters);
310
313 blpapi_SessionOptions_t *parameters);
314
317
320 blpapi_SessionOptions_t *parameters);
321
324 blpapi_SessionOptions_t *parameters);
325
328
331 blpapi_SessionOptions_t *parameters);
332
335 blpapi_SessionOptions_t *parameters);
336
339 blpapi_SessionOptions_t *parameters);
340
343 blpapi_SessionOptions_t *parameters);
344
347 blpapi_SessionOptions_t *parameters);
348
351 blpapi_SessionOptions_t *parameters);
352
355 blpapi_SessionOptions_t *parameters);
356
359 blpapi_SessionOptions_t *parameters);
360
363 blpapi_SessionOptions_t *parameters);
364
367 blpapi_SessionOptions_t *parameters);
368
371 blpapi_SessionOptions_t *parameters);
372
375 blpapi_StreamWriter_t streamWriter,
376 void *stream,
377 int indentLevel,
378 int spacesPerLevel);
379
382 blpapi_SessionOptions_t *parameters);
383
386 blpapi_SessionOptions_t *parameters);
387
390 blpapi_SessionOptions_t *parameters,
391 const char *applicationIdentityKey,
392 size_t size);
395 const char **applicationIdentityKey,
396 size_t *size,
397 blpapi_SessionOptions_t *parameters);
398
401 const char *sessionName,
402 size_t size);
403
405int blpapi_SessionOptions_sessionName(const char **sessionName,
406 size_t *size,
407 blpapi_SessionOptions_t *parameters);
408
409#ifdef __cplusplus
410}
411
419namespace BloombergLP {
420namespace blpapi {
421
432
433 blpapi_SessionOptions_t *d_handle_p;
434
435 public:
436 /*
437 * The possible options for how to connect to the API
438 */
439
450
456 SessionOptions(const SessionOptions& original);
466 // MANIPULATORS
467
474 void setServerHost(const char *host);
484 void setServerPort(unsigned short port);
492 const char *serverHost, unsigned short serverPort, size_t index);
501 int setServerAddress(const char *serverHost,
502 unsigned short serverPort,
503 const Socks5Config& socks5Config,
504 size_t index);
513 int removeServerAddress(size_t index);
518 void setConnectTimeout(unsigned int timeoutMilliSeconds);
526 void setDefaultServices(const char *defaultServices);
534 void setDefaultSubscriptionService(const char *serviceIdentifier);
546 void setDefaultTopicPrefix(const char *prefix);
569 void setClientMode(int clientMode);
585 const CorrelationId& correlationId = CorrelationId());
608 void setAuthenticationOptions(const char *authOptions);
620 void setAutoRestartOnDisconnection(bool autoRestart);
627 void setMaxEventQueueSize(size_t eventQueueSize);
636 void setSlowConsumerWarningHiWaterMark(float hiWaterMark);
650 void setSlowConsumerWarningLoWaterMark(float loWaterMark);
664 void setDefaultKeepAliveInactivityTime(int inactivityMsecs);
677 void setDefaultKeepAliveResponseTimeout(int timeoutMsecs);
690 void setKeepAliveEnabled(bool isEnabled);
702 void setRecordSubscriptionDataReceiveTimes(bool shouldRecord);
710 void setServiceCheckTimeout(int timeoutMsecs);
718 void setServiceDownloadTimeout(int timeoutMsecs);
726 void setTlsOptions(const TlsOptions& tlsOptions);
731 void setFlushPublishedEventsTimeout(int timeoutMsecs);
739 void setBandwidthSaveModeDisabled(bool isDisabled);
746 void setApplicationIdentityKey(const std::string& applicationIdentityKey);
752 void setSessionName(const std::string& sessionName);
760 // ACCESSORS
761 const char *serverHost() const;
768 unsigned short serverPort() const;
775 size_t numServerAddresses() const;
780 int getServerAddress(const char **serverHost,
781 unsigned short *serverPort,
782 size_t index) const;
789 int getServerAddress(const char **serverHost,
790 unsigned short *serverPort,
791 Socks5Config *socksConfig,
792 size_t index) const;
800 unsigned int connectTimeout() const;
806 const char *defaultServices() const;
811 const char *defaultSubscriptionService() const;
819 const char *defaultTopicPrefix() const;
832 int clientMode() const;
838 int maxPendingRequests() const;
849 bool autoRestartOnDisconnection() const;
854 const char *authenticationOptions() const;
859 int numStartAttempts() const;
865 size_t maxEventQueueSize() const;
871 float slowConsumerWarningHiWaterMark() const;
877 float slowConsumerWarningLoWaterMark() const;
895 bool keepAliveEnabled() const;
908 int serviceCheckTimeout() const;
914 int serviceDownloadTimeout() const;
920 int flushPublishedEventsTimeout() const;
926 bool bandwidthSaveModeDisabled() const;
932 std::string applicationIdentityKey();
938 std::string sessionName();
943 std::ostream& print(std::ostream& stream,
944 int indentLevel = 0,
945 int spacesPerLevel = 4) const;
958};
959
963// FREE OPERATORS
964std::ostream& operator<<(
965 std::ostream& stream, const SessionOptions& sessionOptions);
978// ============================================================================
979// INLINE FUNCTION DEFINITIONS
980// ============================================================================
981
982// --------------------
983// class SessionOptions
984// --------------------
986{
987 d_handle_p = blpapi_SessionOptions_create();
988#if BLPAPI_COMPAT_33X
991#endif
992}
993
995{
996 d_handle_p = blpapi_SessionOptions_duplicate(options.handle());
997}
998
1003
1005{
1007 return *this;
1008}
1009
1010inline void SessionOptions::setServerHost(const char *newServerHost)
1011{
1012 blpapi_SessionOptions_setServerHost(d_handle_p, newServerHost);
1013}
1014
1015inline void SessionOptions::setServerPort(unsigned short newServerPort)
1016{
1017 blpapi_SessionOptions_setServerPort(d_handle_p, newServerPort);
1018}
1019
1021 const char *serverHost, unsigned short serverPort, size_t index)
1022{
1024 d_handle_p, serverHost, serverPort, index);
1025}
1026
1027inline int SessionOptions::setServerAddress(const char *serverHost,
1028 unsigned short serverPort,
1029 const Socks5Config& socks5Config,
1030 size_t index)
1031{
1033 d_handle_p, serverHost, serverPort, socks5Config.impl(), index);
1034}
1035
1037{
1038 return blpapi_SessionOptions_removeServerAddress(d_handle_p, index);
1039}
1040
1041inline void SessionOptions::setConnectTimeout(unsigned int timeoutMilliSeconds)
1042{
1044 d_handle_p, timeoutMilliSeconds));
1045}
1046
1047inline void SessionOptions::setDefaultServices(const char *newDefaultServices)
1048{
1049 blpapi_SessionOptions_setDefaultServices(d_handle_p, newDefaultServices);
1050}
1051
1053 const char *serviceIdentifier)
1054{
1056 d_handle_p, serviceIdentifier);
1057}
1058
1059inline void SessionOptions::setDefaultTopicPrefix(const char *prefix)
1060{
1062}
1063
1065 bool newAllowMultipleCorrelatorsPerMsg)
1066{
1068 d_handle_p, newAllowMultipleCorrelatorsPerMsg);
1069}
1070
1071inline void SessionOptions::setClientMode(int newClientMode)
1072{
1073#if BLPAPI_COMPAT_33X
1074 newClientMode |= BLPAPI_CLIENTMODE_COMPAT_33X;
1075#endif
1076
1077 blpapi_SessionOptions_setClientMode(d_handle_p, newClientMode);
1078}
1079
1080inline void SessionOptions::setMaxPendingRequests(int newMaxPendingRequests)
1081{
1083 d_handle_p, newMaxPendingRequests);
1084}
1085
1087{
1089 d_handle_p, autoRestart ? 1 : 0);
1090}
1091
1093 const AuthOptions& authOptions, const CorrelationId& cid)
1094{
1095 blpapi_CorrelationId_t cidHandle = cid.impl();
1096
1099 d_handle_p, authOptions.handle(), &cidHandle));
1100
1101 return CorrelationId(cidHandle);
1102}
1103
1104inline void SessionOptions::setAuthenticationOptions(const char *authOptions)
1105{
1106 blpapi_SessionOptions_setAuthenticationOptions(d_handle_p, authOptions);
1107}
1108
1109inline void SessionOptions::setNumStartAttempts(int newNumStartAttempts)
1110{
1111 blpapi_SessionOptions_setNumStartAttempts(d_handle_p, newNumStartAttempts);
1112}
1113
1114inline void SessionOptions::setMaxEventQueueSize(size_t eventQueueSize)
1115{
1117 d_handle_p, eventQueueSize);
1118}
1119
1121 float hiWaterMark)
1122{
1125 d_handle_p, hiWaterMark));
1126}
1127
1129 float loWaterMark)
1130{
1133 d_handle_p, loWaterMark));
1134}
1135
1137 int inactivityTime)
1138{
1141 d_handle_p, inactivityTime));
1142}
1143
1145 int responseTimeout)
1146{
1149 d_handle_p, responseTimeout));
1150}
1151
1152inline void SessionOptions::setKeepAliveEnabled(bool isEnabled)
1153{
1155 d_handle_p, isEnabled));
1156}
1157
1159 bool shouldRecrod)
1160{
1162 d_handle_p, shouldRecrod);
1163}
1164
1165inline void SessionOptions::setServiceCheckTimeout(int timeoutMsecs)
1166{
1169 d_handle_p, timeoutMsecs));
1170}
1171
1173{
1176 d_handle_p, timeoutMsecs));
1177}
1178
1179inline void SessionOptions::setTlsOptions(const TlsOptions& tlsOptions)
1180{
1182 (d_handle_p, tlsOptions.handle());
1183}
1184
1191
1198
1199inline const char *SessionOptions::serverHost() const
1200{
1201 return blpapi_SessionOptions_serverHost(d_handle_p);
1202}
1203
1204inline unsigned short SessionOptions::serverPort() const
1205{
1206 return static_cast<unsigned short>(
1208}
1209
1211{
1212 return static_cast<size_t>(
1214}
1215
1216inline int SessionOptions::getServerAddress(const char **serverHostOut,
1217 unsigned short *serverPortOut,
1218 size_t index) const
1219{
1221 d_handle_p, serverHostOut, serverPortOut, index);
1222}
1223
1224inline int SessionOptions::getServerAddress(const char **serverHostOut,
1225 unsigned short *serverPortOut,
1226 Socks5Config *socksConfig,
1227 size_t index) const
1228{
1229 const char *socks5ConfigHost = 0;
1230 unsigned short socks5ConfigPort = 0;
1233 serverHostOut,
1234 serverPortOut,
1235 &socks5ConfigHost,
1236 &socks5ConfigPort,
1237 index));
1238
1239 if (socks5ConfigHost) {
1240 *socksConfig = Socks5Config(socks5ConfigHost, socks5ConfigPort);
1241 }
1242
1243 return 0;
1244}
1245
1246inline unsigned int SessionOptions::connectTimeout() const
1247{
1248 return blpapi_SessionOptions_connectTimeout(d_handle_p);
1249}
1250
1251inline const char *SessionOptions::defaultServices() const
1252{
1253 return blpapi_SessionOptions_defaultServices(d_handle_p);
1254}
1255
1257{
1259}
1260
1261inline const char *SessionOptions::defaultTopicPrefix() const
1262{
1264}
1265
1267{
1269 ? true
1270 : false;
1271}
1272
1274{
1275 return blpapi_SessionOptions_clientMode(d_handle_p);
1276}
1277
1279{
1281}
1282
1284{
1286}
1287
1289{
1291}
1292
1294{
1295 return blpapi_SessionOptions_numStartAttempts(d_handle_p);
1296}
1297
1299{
1301}
1302
1307
1312
1318
1324
1326{
1327 return BLPAPI_CALL_SESSIONOPTIONS_KEEPALIVEENABLED(d_handle_p) != 0
1328 ? true
1329 : false;
1330}
1331
1333{
1335 d_handle_p)
1336 ? true
1337 : false;
1338}
1339
1344
1346{
1348 d_handle_p);
1349}
1350
1356
1358{
1360 != 0
1361 ? true
1362 : false;
1363}
1364
1366 const std::string& applicationIdentityKey)
1367{
1371 static_cast<int>(applicationIdentityKey.size())));
1372}
1373
1375{
1376 const char *aik;
1377 size_t size;
1380 &aik, &size, d_handle_p));
1381 return std::string(aik, size);
1382}
1383
1384inline void SessionOptions::setSessionName(const std::string& sessionName)
1385{
1388 d_handle_p, sessionName.data(), sessionName.size()));
1389}
1390
1392{
1393 const char *sessionName = nullptr;
1394 size_t size = 0;
1396 &sessionName, &size, d_handle_p));
1397 return std::string(sessionName, size);
1398}
1399
1401{
1402 return d_handle_p;
1403}
1404
1405inline std::ostream& SessionOptions::print(
1406 std::ostream& stream, int indentLevel, int spacesPerLevel) const
1407{
1410 (d_handle_p,
1412 &stream,
1413 indentLevel,
1414 spacesPerLevel);
1415 }
1416 return stream;
1417}
1418
1419inline std::ostream& operator<<(
1420 std::ostream& stream, const SessionOptions& sessionOptions)
1421{
1422 return sessionOptions.print(stream, 0, -1);
1423}
1424
1425} // close namespace blpapi
1426} // close namespace BloombergLP
1427
1428#endif // #ifdef __cplusplus
1429#endif // #ifndef INCLUDED_BLPAPI_SESSIONOPTIONS
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.
Provide BLPAPI types.
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