36#ifndef INCLUDED_BLPAPI_PROVIDERSESSION
37#define INCLUDED_BLPAPI_PROVIDERSESSION
155#ifndef INCLUDED_BLPAPI_ABSTRACTSESSION
159#ifndef INCLUDED_BLPAPI_CALL
163#ifndef INCLUDED_BLPAPI_CORRELATIONID
167#ifndef INCLUDED_BLPAPI_DEFS
171#ifndef INCLUDED_BLPAPI_EVENT
175#ifndef INCLUDED_BLPAPI_EVENTDISPATCHER
179#ifndef INCLUDED_BLPAPI_IDENTITY
183#ifndef INCLUDED_BLPAPI_REQUEST
187#ifndef INCLUDED_BLPAPI_RESOLUTIONLIST
191#ifndef INCLUDED_BLPAPI_SERVICE
195#ifndef INCLUDED_BLPAPI_SESSIONOPTIONS
199#ifndef INCLUDED_BLPAPI_SUBSCRIPTIONLIST
203#ifndef INCLUDED_BLPAPI_TOPIC
207#ifndef INCLUDED_BLPAPI_TOPICLIST
211#ifndef INCLUDED_BLPAPI_TYPES
226struct blpapi_ServiceRegistrationOptions;
227typedef struct blpapi_ServiceRegistrationOptions
228 blpapi_ServiceRegistrationOptions_t;
230typedef void (*blpapi_ProviderEventHandler_t)(blpapi_Event_t *event,
231 blpapi_ProviderSession_t *session,
235blpapi_ProviderSession_t *blpapi_ProviderSession_create(
236 blpapi_SessionOptions_t *parameters,
237 blpapi_ProviderEventHandler_t handler,
238 blpapi_EventDispatcher_t *dispatcher,
242void blpapi_ProviderSession_destroy(blpapi_ProviderSession_t *session);
245int blpapi_ProviderSession_start(blpapi_ProviderSession_t *session);
248int blpapi_ProviderSession_startAsync(blpapi_ProviderSession_t *session);
251int blpapi_ProviderSession_stop(blpapi_ProviderSession_t *session);
254int blpapi_ProviderSession_stopAsync(blpapi_ProviderSession_t *session);
257int blpapi_ProviderSession_nextEvent(blpapi_ProviderSession_t *session,
258 blpapi_Event_t **eventPointer,
259 unsigned int timeoutInMilliseconds);
262int blpapi_ProviderSession_tryNextEvent(
263 blpapi_ProviderSession_t *session, blpapi_Event_t **eventPointer);
266int blpapi_ProviderSession_registerService(blpapi_ProviderSession_t *session,
267 const char *serviceName,
268 const blpapi_Identity_t *identity,
269 blpapi_ServiceRegistrationOptions_t *registrationOptions);
272int blpapi_ProviderSession_activateSubServiceCodeRange(
273 blpapi_ProviderSession_t *session,
274 const char *serviceName,
280int blpapi_ProviderSession_deactivateSubServiceCodeRange(
281 blpapi_ProviderSession_t *session,
282 const char *serviceName,
287int blpapi_ProviderSession_registerServiceAsync(
288 blpapi_ProviderSession_t *session,
289 const char *serviceName,
290 const blpapi_Identity_t *identity,
291 blpapi_CorrelationId_t *correlationId,
292 blpapi_ServiceRegistrationOptions_t *registrationOptions);
295int blpapi_ProviderSession_deregisterService(
296 blpapi_ProviderSession_t *session,
const char *serviceName);
299int blpapi_ProviderSession_resolve(blpapi_ProviderSession_t *session,
300 blpapi_ResolutionList_t *resolutionList,
302 const blpapi_Identity_t *identity);
305int blpapi_ProviderSession_resolveAsync(blpapi_ProviderSession_t *session,
306 const blpapi_ResolutionList_t *resolutionList,
308 const blpapi_Identity_t *identity);
311int blpapi_ProviderSession_createTopics(blpapi_ProviderSession_t *session,
312 blpapi_TopicList_t *topicList,
314 const blpapi_Identity_t *identity);
317int blpapi_ProviderSession_createTopicsAsync(blpapi_ProviderSession_t *session,
318 const blpapi_TopicList_t *topicList,
320 const blpapi_Identity_t *identity);
323int blpapi_ProviderSession_getTopic(blpapi_ProviderSession_t *session,
324 const blpapi_Message_t *message,
325 blpapi_Topic_t **topic);
328int blpapi_ProviderSession_createTopic(blpapi_ProviderSession_t *session,
329 const blpapi_Message_t *message,
330 blpapi_Topic_t **topic);
333int blpapi_ProviderSession_createServiceStatusTopic(
334 blpapi_ProviderSession_t *session,
335 const blpapi_Service_t *service,
336 blpapi_Topic_t **topic);
339int blpapi_ProviderSession_deleteTopics(blpapi_ProviderSession_t *session,
340 const blpapi_Topic_t **topics,
344int blpapi_ProviderSession_terminateSubscriptionsOnTopics(
345 blpapi_ProviderSession_t *session,
346 const blpapi_Topic_t **topics,
348 const char *message);
351int blpapi_ProviderSession_publish(
352 blpapi_ProviderSession_t *session, blpapi_Event_t *event);
355int blpapi_ProviderSession_sendResponse(blpapi_ProviderSession_t *session,
356 blpapi_Event_t *event,
357 int isPartialResponse);
360blpapi_AbstractSession_t *blpapi_ProviderSession_getAbstractSession(
361 blpapi_ProviderSession_t *session);
364int blpapi_ProviderSession_flushPublishedEvents(
365 blpapi_ProviderSession_t *session,
int *allFlushed,
int timeoutMsecs);
370blpapi_ServiceRegistrationOptions_t *blpapi_ServiceRegistrationOptions_create(
374blpapi_ServiceRegistrationOptions_t *
375blpapi_ServiceRegistrationOptions_duplicate(
376 const blpapi_ServiceRegistrationOptions_t *parameters);
379void blpapi_ServiceRegistrationOptions_destroy(
380 blpapi_ServiceRegistrationOptions_t *parameters);
383void blpapi_ServiceRegistrationOptions_copy(
384 blpapi_ServiceRegistrationOptions_t *lhs,
385 const blpapi_ServiceRegistrationOptions_t *rhs);
389int blpapi_ServiceRegistrationOptions_addActiveSubServiceCodeRange(
390 blpapi_ServiceRegistrationOptions_t *parameters,
396void blpapi_ServiceRegistrationOptions_removeAllActiveSubServiceCodeRanges(
397 blpapi_ServiceRegistrationOptions_t *parameters);
400void blpapi_ServiceRegistrationOptions_setGroupId(
401 blpapi_ServiceRegistrationOptions_t *parameters,
403 unsigned int groupIdLength);
406int blpapi_ServiceRegistrationOptions_setServicePriority(
407 blpapi_ServiceRegistrationOptions_t *parameters,
int priority);
410void blpapi_ServiceRegistrationOptions_setPartsToRegister(
411 blpapi_ServiceRegistrationOptions_t *parameters,
int parts);
414int blpapi_ServiceRegistrationOptions_getGroupId(
415 blpapi_ServiceRegistrationOptions_t *parameters,
416 char *groupdIdBuffer,
420int blpapi_ServiceRegistrationOptions_getServicePriority(
421 blpapi_ServiceRegistrationOptions_t *parameters);
424int blpapi_ServiceRegistrationOptions_getPartsToRegister(
425 blpapi_ServiceRegistrationOptions_t *parameters);
446extern "C" inline void blpapi_providerEventHandlerAdapter(
447 blpapi_Event_t *event,
448 blpapi_ProviderSession_t *session,
487 blpapi_ServiceRegistrationOptions_t *d_handle_p;
515 = BLPAPI_REGISTRATIONPARTS_SUBSCRIBER_RESOLUTION,
520 = BLPAPI_REGISTRATIONPARTS_PUBLISHER_RESOLUTION,
552 void setGroupId(
const char *groupId,
unsigned int groupIdLength);
601 int getGroupId(
char *groupId,
int *groupIdLength)
const;
626 blpapi_ServiceRegistrationOptions_t *handle()
const;
659class ProviderSession :
public AbstractSession {
665 blpapi_ProviderSession_t *d_handle_p;
670 blpapi_ProviderSession_t *session,
673 void dispatchEvent(
const Event& event);
677 ProviderSession(
const ProviderSession&);
678 ProviderSession& operator=(
const ProviderSession&);
736 virtual bool start();
794 const char *serviceName,
int begin,
int end,
int priority);
808 const char *serviceName,
int begin,
int end);
939 const Event& event,
bool isPartialResponse =
false);
1000 virtual void deleteTopics(
const std::vector<Topic>& topics);
1014 const Topic& topic,
const char *message = 0);
1026 const std::vector<Topic>& topics,
const char *message = 0);
1036 const Topic *topics,
size_t numTopics,
const char *message = 0);
1060 blpapi_ProviderSession_t *handle()
const;
1090 : d_eventHandler_p(handler)
1092 if (dispatcher && !handler) {
1094 "Event dispatcher provided without handler.");
1096 d_handle_p = blpapi_ProviderSession_create(parameters.
handle(),
1098 dispatcher ? dispatcher->
impl() : 0,
1100 initAbstractSessionHandle(
1101 blpapi_ProviderSession_getAbstractSession(d_handle_p));
1104inline ProviderSession::ProviderSession(blpapi_ProviderSession_t *newHandle)
1105 : d_handle_p(newHandle)
1107 initAbstractSessionHandle(
1108 blpapi_ProviderSession_getAbstractSession(d_handle_p));
1113 blpapi_ProviderSession_destroy(d_handle_p);
1118 return blpapi_ProviderSession_start(d_handle_p) ? false :
true;
1123 return blpapi_ProviderSession_startAsync(d_handle_p) ? false :
true;
1128 blpapi_ProviderSession_stop(d_handle_p);
1133 blpapi_ProviderSession_stopAsync(d_handle_p);
1142 blpapi_Event_t *
event = 0;
1144 d_handle_p, &event,
static_cast<unsigned>(timeout)));
1145 return Event(event);
1152 blpapi_Event_t *impl = 0;
1153 int ret = blpapi_ProviderSession_tryNextEvent(d_handle_p, &impl);
1155 *
event =
Event(impl);
1164 return blpapi_ProviderSession_registerService(d_handle_p,
1167 registrationOptions.handle())
1173 const char *serviceName,
int begin,
int end,
int priority)
1177 d_handle_p, serviceName, begin, end, priority));
1181 const char *serviceName,
int begin,
int end)
1185 d_handle_p, serviceName, begin, end));
1189 const char *serviceName,
1194 blpapi_CorrelationId_t retv = correlationId.impl();
1196 blpapi_ProviderSession_registerServiceAsync(d_handle_p,
1200 registrationOptions.handle()));
1208 d_handle_p, serviceName)
1218 assert(resolutionList);
1221 resolutionList->
impl(),
1232 resolutionList.
impl(),
1240 blpapi_Topic_t *topic = 0;
1242 d_handle_p, message.impl(), &topic));
1244 return Topic(topic);
1249 blpapi_Topic_t *topic = 0;
1251 d_handle_p, message.impl(), &topic));
1253 return Topic(topic);
1258 blpapi_Topic_t *topic = 0;
1260 blpapi_ProviderSession_createServiceStatusTopic(
1261 d_handle_p, service.
handle(), &topic));
1263 return Topic(topic);
1273 d_handle_p, topicList->
impl(), resolveMode, identity.
handle()));
1282 d_handle_p, topicList.
impl(), resolveMode, identity.
handle()));
1288 const blpapi_Topic_t *topicImpl = topic.
impl();
1290 d_handle_p, &topicImpl, 1));
1295 if (topics.size() == 0) {
1298 std::vector<const blpapi_Topic_t *> topicImplList;
1299 topicImplList.reserve(topics.size());
1300 for (std::vector<Topic>::const_iterator it = topics.begin();
1303 topicImplList.push_back(it->impl());
1306 d_handle_p, &topicImplList[0], topicImplList.size()));
1310 const Topic *topics,
size_t numTopics)
1312 if (numTopics == 0) {
1318 std::vector<const blpapi_Topic_t *> topicImplList;
1319 topicImplList.reserve(numTopics);
1320 for (
size_t i = 0; i < numTopics; ++i) {
1321 topicImplList.push_back(topics[i].impl());
1324 d_handle_p, &topicImplList[0], topicImplList.size()));
1328 const Topic& topic,
const char *message)
1330 const blpapi_Topic_t *topicImpl = topic.
impl();
1333 d_handle_p, &topicImpl, 1, message));
1337 const std::vector<Topic>& topics,
const char *message)
1339 if (topics.empty()) {
1346 const Topic *topics,
size_t numTopics,
const char *message)
1348 if (numTopics == 0) {
1354 std::vector<const blpapi_Topic_t *> topicImplList;
1355 topicImplList.reserve(numTopics);
1356 for (
size_t i = 0; i < numTopics; ++i) {
1357 topicImplList.push_back(topics[i].impl());
1363 topicImplList.size(),
1370 blpapi_ProviderSession_publish(d_handle_p, event.
impl()));
1375 const Event& event,
bool isPartialResponse)
1378 d_handle_p, event.
impl(), isPartialResponse));
1382inline blpapi_ProviderSession_t *ProviderSession::handle()
const
1387inline void ProviderSession::dispatchEvent(
const Event& event)
1389 assert(d_eventHandler_p);
1397 int rc =
BLPAPI_CALL(blpapi_ProviderSession_flushPublishedEvents)(
1398 d_handle_p, &allFlushed, timeoutMsecs);
1402 return allFlushed ? true :
false;
1411 d_handle_p = blpapi_ServiceRegistrationOptions_create();
1418 = blpapi_ServiceRegistrationOptions_duplicate(original.handle());
1423 blpapi_ServiceRegistrationOptions_destroy(d_handle_p);
1429 blpapi_ServiceRegistrationOptions_copy(this->handle(), rhs.handle());
1435 int begin,
int end,
int priority)
1439 d_handle_p, begin, end, priority));
1449 const char *groupId,
unsigned int groupIdLength)
1451 blpapi_ServiceRegistrationOptions_setGroupId(
1452 d_handle_p, groupId, groupIdLength);
1457 return blpapi_ServiceRegistrationOptions_setServicePriority(
1458 d_handle_p, priority);
1468 char *groupIdBuffer,
int *groupIdLength)
const
1470 return blpapi_ServiceRegistrationOptions_getGroupId(
1471 d_handle_p, groupIdBuffer, groupIdLength);
1476 return blpapi_ServiceRegistrationOptions_getServicePriority(d_handle_p);
1485inline blpapi_ServiceRegistrationOptions_t *
1486ServiceRegistrationOptions::handle()
const
1496extern "C" inline void blpapi_providerEventHandlerAdapter(
1497 blpapi_Event_t *event, blpapi_ProviderSession_t *,
void *userData)
1501 reinterpret_cast<ProviderSession *
>(userData)->dispatchEvent(Event(event));
A common interface shared between publisher and consumer sessions.
Provide functions for dispatchtbl.
#define BLPAPI_CALL_SERVICEREGISTRATIONOPTIONS_ADDACTIVATESUBSERVICECODERANGE(a1, a2, a3, a4)
Definition blpapi_call.h:452
#define BLPAPI_CALL_PROVIDERSESSION_DEACTIVATESUBSERVICECODERANGE( a1, a2, a3, a4)
Definition blpapi_call.h:448
#define BLPAPI_CALL_SERVICEREGISTRATIONOPTIONS_SETPARTSTOREGISTER(a1, a2)
Definition blpapi_call.h:431
#define BLPAPI_CALL_PROVIDERSESSION_DEREGISTERSERVICE(a1, a2)
Definition blpapi_call.h:428
#define BLPAPI_CALL_SERVICEREGISTRATIONOPTIONS_GETPARTSTOREGISTER(a1)
Definition blpapi_call.h:434
#define BLPAPI_CALL_SERVICEREGISTRATIONOPTIONS_REMOVEALLACTIVESUBSERVICECODERANGES(a1)
Definition blpapi_call.h:457
#define BLPAPI_CALL_PROVIDERSESSION_ACTIVATESUBSERVICECODERANGE( a1, a2, a3, a4, a5)
Definition blpapi_call.h:444
#define BLPAPI_CALL_PROVIDERSESSION_DELETETOPICS(a1, a2, a3)
Definition blpapi_call.h:437
#define BLPAPI_CALL(FUNCNAME)
Definition blpapi_call.h:361
#define BLPAPI_CALL_PROVIDERSESSION_TERMINATESUBSCRIPTIONSONTOPICS( a1, a2, a3, a4)
Definition blpapi_call.h:440
Provide a key to identify individual subscriptions or requests.
Common definitions used by the library.
A component which defines events related operations.
Provide a dispatcher to dispatch events.
Provide access to the entitlements for a user.
Defines a request which can be sent for a service.
Provide a representation of a list of topics.
A service which provides access to API data (provide or consume).
A common interface shared between publish and consumer sessions.
Provide a list of subscriptions.
Provide representation of a Topic.
Provide a representation of a list of topics.
Definition blpapi_correlationid.h:225
Definition blpapi_eventdispatcher.h:132
blpapi_EventDispatcher_t * impl() const
Definition blpapi_eventdispatcher.h:214
Definition blpapi_session.h:350
Definition blpapi_event.h:212
blpapi_Event_t * impl() const
Definition blpapi_event.h:569
static void throwOnError(int errorCode)
Definition blpapi_exception.h:541
Definition blpapi_identity.h:147
blpapi_Identity_t * handle() const
Definition blpapi_identity.h:396
Definition blpapi_exception.h:253
Definition blpapi_message.h:177
Definition blpapi_providersession.h:457
virtual ~ProviderEventHandler()
Definition blpapi_providersession.h:459
virtual bool processEvent(const Event &event, ProviderSession *session)=0
Definition blpapi_providersession.h:659
virtual void deleteTopic(const Topic &topic)
Definition blpapi_providersession.h:1286
virtual void deleteTopics(const std::vector< Topic > &topics)
Definition blpapi_providersession.h:1293
virtual void publish(const Event &event)
Definition blpapi_providersession.h:1367
virtual ~ProviderSession()
Definition blpapi_providersession.h:1111
virtual int tryNextEvent(Event *event)
Definition blpapi_providersession.h:1148
virtual void resolve(ResolutionList *resolutionList, ResolveMode resolveMode=DONT_REGISTER_SERVICES, const Identity &providerIdentity=Identity())
Definition blpapi_providersession.h:1214
virtual void activateSubServiceCodeRange(const char *serviceName, int begin, int end, int priority)
Definition blpapi_providersession.h:1172
virtual bool registerService(const char *serviceName, const Identity &providerIdentity=Identity(), const ServiceRegistrationOptions ®istrationOptions=ServiceRegistrationOptions())
Definition blpapi_providersession.h:1160
virtual bool startAsync()
Definition blpapi_providersession.h:1121
virtual Topic createServiceStatusTopic(const Service &service)
Definition blpapi_providersession.h:1256
virtual Topic createTopic(const Message &message)
Definition blpapi_providersession.h:1238
virtual void deactivateSubServiceCodeRange(const char *serviceName, int begin, int end)
Definition blpapi_providersession.h:1180
virtual Topic getTopic(const Message &message)
Definition blpapi_providersession.h:1247
virtual void sendResponse(const Event &event, bool isPartialResponse=false)
Definition blpapi_providersession.h:1374
virtual Event nextEvent(int timeout=0)
Definition blpapi_providersession.h:1136
ResolveMode
Definition blpapi_providersession.h:681
@ DONT_REGISTER_SERVICES
Definition blpapi_providersession.h:684
@ AUTO_REGISTER_SERVICES
Try to register services found in ResolutionList if necessary.
Definition blpapi_providersession.h:682
virtual void stop()
Definition blpapi_providersession.h:1126
virtual void createTopics(TopicList *topicList, ResolveMode resolveMode=DONT_REGISTER_SERVICES, const Identity &providerIdentity=Identity())
Definition blpapi_providersession.h:1266
friend void blpapi_providerEventHandlerAdapter(blpapi_Event_t *event, blpapi_ProviderSession_t *session, void *userData)
virtual void createTopicsAsync(const TopicList &topicList, ResolveMode resolveMode=DONT_REGISTER_SERVICES, const Identity &providerIdentity=Identity())
Definition blpapi_providersession.h:1277
::BloombergLP::blpapi::ProviderEventHandler EventHandler
Definition blpapi_providersession.h:662
virtual void terminateSubscriptionsOnTopic(const Topic &topic, const char *message=0)
Definition blpapi_providersession.h:1327
virtual bool start()
Definition blpapi_providersession.h:1116
virtual bool flushPublishedEvents(int timeoutMsecs)
Definition blpapi_providersession.h:1394
virtual bool deregisterService(const char *serviceName)
Definition blpapi_providersession.h:1205
virtual void stopAsync()
Definition blpapi_providersession.h:1131
virtual CorrelationId registerServiceAsync(const char *serviceName, const Identity &providerIdentity=Identity(), const CorrelationId &correlationId=CorrelationId(), const ServiceRegistrationOptions ®istrationOptions=ServiceRegistrationOptions())
Definition blpapi_providersession.h:1188
virtual void resolveAsync(const ResolutionList &resolutionList, ResolveMode resolveMode=DONT_REGISTER_SERVICES, const Identity &providerIdentity=Identity())
Definition blpapi_providersession.h:1227
virtual void terminateSubscriptionsOnTopics(const std::vector< Topic > &topics, const char *message=0)
Definition blpapi_providersession.h:1336
Definition blpapi_resolutionlist.h:211
const blpapi_ResolutionList_t * impl() const
Definition blpapi_resolutionlist.h:551
Definition blpapi_providersession.h:485
int getGroupId(char *groupId, int *groupIdLength) const
Definition blpapi_providersession.h:1467
void removeAllActiveSubServiceCodeRanges()
Definition blpapi_providersession.h:1442
ServiceRegistrationOptions()
Definition blpapi_providersession.h:1409
void setGroupId(const char *groupId, unsigned int groupIdLength)
Definition blpapi_providersession.h:1448
ServiceRegistrationOptions & operator=(const ServiceRegistrationOptions &rhs)
Definition blpapi_providersession.h:1426
int getPartsToRegister() const
Definition blpapi_providersession.h:1479
int setServicePriority(int priority)
Definition blpapi_providersession.h:1455
~ServiceRegistrationOptions()
Definition blpapi_providersession.h:1421
int getServicePriority() const
Definition blpapi_providersession.h:1474
RegistrationParts
Definition blpapi_providersession.h:505
@ PART_PUBLISHING
register to receive subscribe and unsubscribe messages
Definition blpapi_providersession.h:507
@ PART_DEFAULT
Definition blpapi_providersession.h:525
@ PART_OPERATIONS
Definition blpapi_providersession.h:510
@ PART_PUBLISHER_RESOLUTION
Definition blpapi_providersession.h:519
@ PART_SUBSCRIBER_RESOLUTION
Definition blpapi_providersession.h:514
void setPartsToRegister(int parts)
Definition blpapi_providersession.h:1461
ServiceRegistrationPriority
Definition blpapi_providersession.h:494
@ PRIORITY_MEDIUM
Medium priority (INT_MAX/2)
Definition blpapi_providersession.h:497
@ PRIORITY_LOW
Low priority (0)
Definition blpapi_providersession.h:495
@ PRIORITY_HIGH
High priority (INT_MAX)
Definition blpapi_providersession.h:499
void addActiveSubServiceCodeRange(int begin, int end, int priority)
Definition blpapi_providersession.h:1434
Definition blpapi_service.h:320
blpapi_Service_t * handle() const
Definition blpapi_service.h:722
Definition blpapi_sessionoptions.h:447
blpapi_SessionOptions_t * handle() const
Definition blpapi_sessionoptions.h:1416
Definition blpapi_topiclist.h:193
const blpapi_TopicList_t * impl() const
Definition blpapi_topiclist.h:426
Definition blpapi_topic.h:130
const blpapi_Topic_t * impl() const
Definition blpapi_topic.h:237
Definition blpapi_abstractsession.h:212
Definition blpapi_abstractsession.h:211