38#ifndef INCLUDED_BLPAPI_PROVIDERSESSION
39#define INCLUDED_BLPAPI_PROVIDERSESSION
156#ifndef INCLUDED_BLPAPI_ABSTRACTSESSION
160#ifndef INCLUDED_BLPAPI_CALL
164#ifndef INCLUDED_BLPAPI_CORRELATIONID
168#ifndef INCLUDED_BLPAPI_DEFS
172#ifndef INCLUDED_BLPAPI_EVENT
176#ifndef INCLUDED_BLPAPI_EVENTDISPATCHER
180#ifndef INCLUDED_BLPAPI_IDENTITY
184#ifndef INCLUDED_BLPAPI_REQUEST
188#ifndef INCLUDED_BLPAPI_RESOLUTIONLIST
192#ifndef INCLUDED_BLPAPI_SERVICE
196#ifndef INCLUDED_BLPAPI_SESSIONOPTIONS
200#ifndef INCLUDED_BLPAPI_SUBSCRIPTIONLIST
204#ifndef INCLUDED_BLPAPI_TOPIC
208#ifndef INCLUDED_BLPAPI_TOPICLIST
212#ifndef INCLUDED_BLPAPI_TYPES
227struct blpapi_ServiceRegistrationOptions;
228typedef struct blpapi_ServiceRegistrationOptions
229 blpapi_ServiceRegistrationOptions_t;
238typedef void (*blpapi_ProviderEventHandler_t)(blpapi_Event_t *event,
239 blpapi_ProviderSession_t *session,
265blpapi_ProviderSession_t *blpapi_ProviderSession_create(
266 blpapi_SessionOptions_t *parameters,
267 blpapi_ProviderEventHandler_t handler,
268 blpapi_EventDispatcher_t *dispatcher,
281void blpapi_ProviderSession_destroy(blpapi_ProviderSession_t *session);
296int blpapi_ProviderSession_start(blpapi_ProviderSession_t *session);
309int blpapi_ProviderSession_startAsync(blpapi_ProviderSession_t *session);
325int blpapi_ProviderSession_stop(blpapi_ProviderSession_t *session);
340int blpapi_ProviderSession_stopAsync(blpapi_ProviderSession_t *session);
360int blpapi_ProviderSession_nextEvent(blpapi_ProviderSession_t *session,
361 blpapi_Event_t **eventPointer,
362 unsigned int timeoutInMilliseconds);
376int blpapi_ProviderSession_tryNextEvent(
377 blpapi_ProviderSession_t *session, blpapi_Event_t **eventPointer);
400int blpapi_ProviderSession_registerService(blpapi_ProviderSession_t *session,
401 const char *serviceName,
402 const blpapi_Identity_t *identity,
403 blpapi_ServiceRegistrationOptions_t *registrationOptions);
424int blpapi_ProviderSession_activateSubServiceCodeRange(
425 blpapi_ProviderSession_t *session,
426 const char *serviceName,
447int blpapi_ProviderSession_deactivateSubServiceCodeRange(
448 blpapi_ProviderSession_t *session,
449 const char *serviceName,
473int blpapi_ProviderSession_registerServiceAsync(
474 blpapi_ProviderSession_t *session,
475 const char *serviceName,
476 const blpapi_Identity_t *identity,
477 blpapi_CorrelationId_t *correlationId,
478 blpapi_ServiceRegistrationOptions_t *registrationOptions);
499int blpapi_ProviderSession_deregisterService(
500 blpapi_ProviderSession_t *session,
const char *serviceName);
523int blpapi_ProviderSession_resolve(blpapi_ProviderSession_t *session,
524 blpapi_ResolutionList_t *resolutionList,
526 const blpapi_Identity_t *identity);
547int blpapi_ProviderSession_resolveAsync(blpapi_ProviderSession_t *session,
548 const blpapi_ResolutionList_t *resolutionList,
550 const blpapi_Identity_t *identity);
572int blpapi_ProviderSession_createTopics(blpapi_ProviderSession_t *session,
573 blpapi_TopicList_t *topicList,
575 const blpapi_Identity_t *identity);
595int blpapi_ProviderSession_createTopicsAsync(blpapi_ProviderSession_t *session,
596 const blpapi_TopicList_t *topicList,
598 const blpapi_Identity_t *identity);
617int blpapi_ProviderSession_getTopic(blpapi_ProviderSession_t *session,
618 const blpapi_Message_t *message,
619 blpapi_Topic_t **topic);
639int blpapi_ProviderSession_createTopic(blpapi_ProviderSession_t *session,
640 const blpapi_Message_t *message,
641 blpapi_Topic_t **topic);
659int blpapi_ProviderSession_createServiceStatusTopic(
660 blpapi_ProviderSession_t *session,
661 const blpapi_Service_t *service,
662 blpapi_Topic_t **topic);
683int blpapi_ProviderSession_deleteTopics(blpapi_ProviderSession_t *session,
684 const blpapi_Topic_t **topics,
705int blpapi_ProviderSession_terminateSubscriptionsOnTopics(
706 blpapi_ProviderSession_t *session,
707 const blpapi_Topic_t **topics,
709 const char *message);
726int blpapi_ProviderSession_publish(
727 blpapi_ProviderSession_t *session, blpapi_Event_t *event);
746int blpapi_ProviderSession_sendResponse(blpapi_ProviderSession_t *session,
747 blpapi_Event_t *event,
748 int isPartialResponse);
760blpapi_AbstractSession_t *blpapi_ProviderSession_getAbstractSession(
761 blpapi_ProviderSession_t *session);
781int blpapi_ProviderSession_flushPublishedEvents(
782 blpapi_ProviderSession_t *session,
int *allFlushed,
int timeoutMsecs);
797blpapi_ServiceRegistrationOptions_t *blpapi_ServiceRegistrationOptions_create(
810blpapi_ServiceRegistrationOptions_t *
811blpapi_ServiceRegistrationOptions_duplicate(
812 const blpapi_ServiceRegistrationOptions_t *parameters);
822void blpapi_ServiceRegistrationOptions_destroy(
823 blpapi_ServiceRegistrationOptions_t *parameters);
834void blpapi_ServiceRegistrationOptions_copy(
835 blpapi_ServiceRegistrationOptions_t *lhs,
836 const blpapi_ServiceRegistrationOptions_t *rhs);
855int blpapi_ServiceRegistrationOptions_addActiveSubServiceCodeRange(
856 blpapi_ServiceRegistrationOptions_t *parameters,
868void blpapi_ServiceRegistrationOptions_removeAllActiveSubServiceCodeRanges(
869 blpapi_ServiceRegistrationOptions_t *parameters);
887void blpapi_ServiceRegistrationOptions_setGroupId(
888 blpapi_ServiceRegistrationOptions_t *parameters,
890 unsigned int groupIdLength);
906int blpapi_ServiceRegistrationOptions_setServicePriority(
907 blpapi_ServiceRegistrationOptions_t *parameters,
int priority);
919void blpapi_ServiceRegistrationOptions_setPartsToRegister(
920 blpapi_ServiceRegistrationOptions_t *parameters,
int parts);
938int blpapi_ServiceRegistrationOptions_getGroupId(
939 blpapi_ServiceRegistrationOptions_t *parameters,
940 char *groupdIdBuffer,
951int blpapi_ServiceRegistrationOptions_getServicePriority(
952 blpapi_ServiceRegistrationOptions_t *parameters);
963int blpapi_ServiceRegistrationOptions_getPartsToRegister(
964 blpapi_ServiceRegistrationOptions_t *parameters);
984extern "C" inline void blpapi_providerEventHandlerAdapter(
985 blpapi_Event_t *event,
986 blpapi_ProviderSession_t *session,
1025 blpapi_ServiceRegistrationOptions_t *d_handle_p;
1053 = BLPAPI_REGISTRATIONPARTS_SUBSCRIBER_RESOLUTION,
1058 = BLPAPI_REGISTRATIONPARTS_PUBLISHER_RESOLUTION,
1090 void setGroupId(
const char *groupId,
unsigned int groupIdLength);
1139 int getGroupId(
char *groupId,
int *groupIdLength)
const;
1164 blpapi_ServiceRegistrationOptions_t *handle()
const;
1197class ProviderSession :
public AbstractSession {
1203 blpapi_ProviderSession_t *d_handle_p;
1208 blpapi_ProviderSession_t *session,
1211 void dispatchEvent(
const Event& event);
1215 ProviderSession(
const ProviderSession&);
1216 ProviderSession& operator=(
const ProviderSession&);
1274 virtual bool start();
1284 virtual void stop();
1332 const char *serviceName,
int begin,
int end,
int priority);
1346 const char *serviceName,
int begin,
int end);
1477 const Event& event,
bool isPartialResponse =
false);
1538 virtual void deleteTopics(
const std::vector<Topic>& topics);
1552 const Topic& topic,
const char *message = 0);
1563 const std::vector<Topic>& topics,
const char *message = 0);
1573 const Topic *topics,
size_t numTopics,
const char *message = 0);
1597 blpapi_ProviderSession_t *handle()
const;
1627 : d_eventHandler_p(handler)
1629 if (dispatcher && !handler) {
1631 "Event dispatcher provided without handler.");
1633 d_handle_p = blpapi_ProviderSession_create(parameters.handle(),
1635 dispatcher ? dispatcher->impl() : 0,
1637 initAbstractSessionHandle(
1638 blpapi_ProviderSession_getAbstractSession(d_handle_p));
1642inline ProviderSession::ProviderSession(blpapi_ProviderSession_t *newHandle)
1643 : d_handle_p(newHandle)
1645 initAbstractSessionHandle(
1646 blpapi_ProviderSession_getAbstractSession(d_handle_p));
1652 blpapi_ProviderSession_destroy(d_handle_p);
1657 return blpapi_ProviderSession_start(d_handle_p) ? false :
true;
1662 return blpapi_ProviderSession_startAsync(d_handle_p) ? false :
true;
1667 blpapi_ProviderSession_stop(d_handle_p);
1672 blpapi_ProviderSession_stopAsync(d_handle_p);
1681 blpapi_Event_t *
event = 0;
1683 d_handle_p, &event,
static_cast<unsigned>(timeout)));
1684 return Event(event);
1691 blpapi_Event_t *impl = 0;
1692 int ret = blpapi_ProviderSession_tryNextEvent(d_handle_p, &impl);
1694 *
event =
Event(impl);
1703 return blpapi_ProviderSession_registerService(d_handle_p,
1706 registrationOptions.handle())
1712 const char *serviceName,
int begin,
int end,
int priority)
1715 BLPAPI_CALL_PROVIDERSESSION_ACTIVATESUBSERVICECODERANGE(
1716 d_handle_p, serviceName, begin, end, priority));
1720 const char *serviceName,
int begin,
int end)
1723 BLPAPI_CALL_PROVIDERSESSION_DEACTIVATESUBSERVICECODERANGE(
1724 d_handle_p, serviceName, begin, end));
1728 const char *serviceName,
1733 blpapi_CorrelationId_t retv = correlationId.impl();
1735 blpapi_ProviderSession_registerServiceAsync(d_handle_p,
1739 registrationOptions.handle()));
1746 return BLPAPI_CALL_PROVIDERSESSION_DEREGISTERSERVICE(
1747 d_handle_p, serviceName)
1757 assert(resolutionList);
1760 resolutionList->impl(),
1762 identity.handle()));
1771 resolutionList.impl(),
1773 identity.handle()));
1779 blpapi_Topic_t *topic = 0;
1781 d_handle_p, message.impl(), &topic));
1783 return Topic(topic);
1788 blpapi_Topic_t *topic = 0;
1790 d_handle_p, message.impl(), &topic));
1792 return Topic(topic);
1797 blpapi_Topic_t *topic = 0;
1799 blpapi_ProviderSession_createServiceStatusTopic(
1800 d_handle_p, service.handle(), &topic));
1802 return Topic(topic);
1812 d_handle_p, topicList->impl(), resolveMode, identity.handle()));
1821 d_handle_p, topicList.impl(), resolveMode, identity.handle()));
1827 const blpapi_Topic_t *topicImpl = topic.impl();
1829 d_handle_p, &topicImpl, 1));
1834 if (topics.size() == 0) {
1837 std::vector<const blpapi_Topic_t *> topicImplList;
1838 topicImplList.reserve(topics.size());
1839 for (std::vector<Topic>::const_iterator it = topics.begin();
1842 topicImplList.push_back(it->impl());
1845 d_handle_p, &topicImplList[0], topicImplList.size()));
1849 const Topic *topics,
size_t numTopics)
1851 if (numTopics == 0) {
1857 std::vector<const blpapi_Topic_t *> topicImplList;
1858 topicImplList.reserve(numTopics);
1859 for (
size_t i = 0; i < numTopics; ++i) {
1860 topicImplList.push_back(topics[i].impl());
1863 d_handle_p, &topicImplList[0], topicImplList.size()));
1867 const Topic& topic,
const char *message)
1869 const blpapi_Topic_t *topicImpl = topic.impl();
1871 BLPAPI_CALL_PROVIDERSESSION_TERMINATESUBSCRIPTIONSONTOPICS(
1872 d_handle_p, &topicImpl, 1, message));
1876 const std::vector<Topic>& topics,
const char *message)
1878 if (topics.empty()) {
1885 const Topic *topics,
size_t numTopics,
const char *message)
1887 if (numTopics == 0) {
1893 std::vector<const blpapi_Topic_t *> topicImplList;
1894 topicImplList.reserve(numTopics);
1895 for (
size_t i = 0; i < numTopics; ++i) {
1896 topicImplList.push_back(topics[i].impl());
1899 BLPAPI_CALL_PROVIDERSESSION_TERMINATESUBSCRIPTIONSONTOPICS(
1902 topicImplList.size(),
1909 blpapi_ProviderSession_publish(d_handle_p, event.impl()));
1914 const Event& event,
bool isPartialResponse)
1917 d_handle_p, event.impl(), isPartialResponse));
1922inline blpapi_ProviderSession_t *ProviderSession::handle()
const
1928inline void ProviderSession::dispatchEvent(
const Event& event)
1930 assert(d_eventHandler_p);
1938 int rc = BLPAPI_CALL(blpapi_ProviderSession_flushPublishedEvents)(
1939 d_handle_p, &allFlushed, timeoutMsecs);
1943 return allFlushed ? true :
false;
1952 d_handle_p = blpapi_ServiceRegistrationOptions_create();
1959 = blpapi_ServiceRegistrationOptions_duplicate(original.handle());
1964 blpapi_ServiceRegistrationOptions_destroy(d_handle_p);
1970 blpapi_ServiceRegistrationOptions_copy(this->handle(), rhs.handle());
1976 int begin,
int end,
int priority)
1979 BLPAPI_CALL_SERVICEREGISTRATIONOPTIONS_ADDACTIVATESUBSERVICECODERANGE(
1980 d_handle_p, begin, end, priority));
1985 BLPAPI_CALL_SERVICEREGISTRATIONOPTIONS_REMOVEALLACTIVESUBSERVICECODERANGES(
1990 const char *groupId,
unsigned int groupIdLength)
1992 blpapi_ServiceRegistrationOptions_setGroupId(
1993 d_handle_p, groupId, groupIdLength);
1998 return blpapi_ServiceRegistrationOptions_setServicePriority(
1999 d_handle_p, priority);
2004 BLPAPI_CALL_SERVICEREGISTRATIONOPTIONS_SETPARTSTOREGISTER(
2009 char *groupIdBuffer,
int *groupIdLength)
const
2011 return blpapi_ServiceRegistrationOptions_getGroupId(
2012 d_handle_p, groupIdBuffer, groupIdLength);
2017 return blpapi_ServiceRegistrationOptions_getServicePriority(d_handle_p);
2022 return BLPAPI_CALL_SERVICEREGISTRATIONOPTIONS_GETPARTSTOREGISTER(
2027inline blpapi_ServiceRegistrationOptions_t *
2028ServiceRegistrationOptions::handle()
const
2039extern "C" inline void blpapi_providerEventHandlerAdapter(
2040 blpapi_Event_t *event, blpapi_ProviderSession_t *,
void *userData)
2044 reinterpret_cast<ProviderSession *
>(userData)->dispatchEvent(Event(event));
A common interface shared between publisher and consumer sessions.
Provide functions for dispatchtbl.
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:306
Definition blpapi_eventdispatcher.h:184
Definition blpapi_session.h:840
Definition blpapi_event.h:325
static void throwOnError(int errorCode)
Definition blpapi_exception.h:556
Definition blpapi_identity.h:217
Definition blpapi_exception.h:268
Definition blpapi_message.h:344
Definition blpapi_providersession.h:995
virtual ~ProviderEventHandler()
Definition blpapi_providersession.h:997
virtual bool processEvent(const Event &event, ProviderSession *session)=0
Definition blpapi_providersession.h:1197
virtual void deleteTopic(const Topic &topic)
Definition blpapi_providersession.h:1825
virtual void deleteTopics(const std::vector< Topic > &topics)
Definition blpapi_providersession.h:1832
virtual void publish(const Event &event)
Definition blpapi_providersession.h:1906
virtual ~ProviderSession()
Definition blpapi_providersession.h:1650
virtual int tryNextEvent(Event *event)
Definition blpapi_providersession.h:1687
virtual void resolve(ResolutionList *resolutionList, ResolveMode resolveMode=DONT_REGISTER_SERVICES, const Identity &providerIdentity=Identity())
Definition blpapi_providersession.h:1753
virtual void activateSubServiceCodeRange(const char *serviceName, int begin, int end, int priority)
Definition blpapi_providersession.h:1711
virtual bool registerService(const char *serviceName, const Identity &providerIdentity=Identity(), const ServiceRegistrationOptions ®istrationOptions=ServiceRegistrationOptions())
Definition blpapi_providersession.h:1699
virtual bool startAsync()
Definition blpapi_providersession.h:1660
virtual Topic createServiceStatusTopic(const Service &service)
Definition blpapi_providersession.h:1795
virtual Topic createTopic(const Message &message)
Definition blpapi_providersession.h:1777
virtual void deactivateSubServiceCodeRange(const char *serviceName, int begin, int end)
Definition blpapi_providersession.h:1719
virtual Topic getTopic(const Message &message)
Definition blpapi_providersession.h:1786
virtual void sendResponse(const Event &event, bool isPartialResponse=false)
Definition blpapi_providersession.h:1913
virtual Event nextEvent(int timeout=0)
Definition blpapi_providersession.h:1675
ResolveMode
Definition blpapi_providersession.h:1219
@ DONT_REGISTER_SERVICES
Definition blpapi_providersession.h:1222
@ AUTO_REGISTER_SERVICES
Try to register services found in ResolutionList if necessary.
Definition blpapi_providersession.h:1220
virtual void stop()
Definition blpapi_providersession.h:1665
virtual void createTopics(TopicList *topicList, ResolveMode resolveMode=DONT_REGISTER_SERVICES, const Identity &providerIdentity=Identity())
Definition blpapi_providersession.h:1805
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:1816
::BloombergLP::blpapi::ProviderEventHandler EventHandler
Definition blpapi_providersession.h:1200
virtual void terminateSubscriptionsOnTopic(const Topic &topic, const char *message=0)
Definition blpapi_providersession.h:1866
virtual bool start()
Definition blpapi_providersession.h:1655
virtual bool flushPublishedEvents(int timeoutMsecs)
Definition blpapi_providersession.h:1935
virtual bool deregisterService(const char *serviceName)
Definition blpapi_providersession.h:1744
virtual void stopAsync()
Definition blpapi_providersession.h:1670
virtual CorrelationId registerServiceAsync(const char *serviceName, const Identity &providerIdentity=Identity(), const CorrelationId &correlationId=CorrelationId(), const ServiceRegistrationOptions ®istrationOptions=ServiceRegistrationOptions())
Definition blpapi_providersession.h:1727
virtual void resolveAsync(const ResolutionList &resolutionList, ResolveMode resolveMode=DONT_REGISTER_SERVICES, const Identity &providerIdentity=Identity())
Definition blpapi_providersession.h:1766
virtual void terminateSubscriptionsOnTopics(const std::vector< Topic > &topics, const char *message=0)
Definition blpapi_providersession.h:1875
Definition blpapi_resolutionlist.h:418
Definition blpapi_providersession.h:1023
int getGroupId(char *groupId, int *groupIdLength) const
Definition blpapi_providersession.h:2008
void removeAllActiveSubServiceCodeRanges()
Definition blpapi_providersession.h:1983
ServiceRegistrationOptions()
Definition blpapi_providersession.h:1950
void setGroupId(const char *groupId, unsigned int groupIdLength)
Definition blpapi_providersession.h:1989
ServiceRegistrationOptions & operator=(const ServiceRegistrationOptions &rhs)
Definition blpapi_providersession.h:1967
int getPartsToRegister() const
Definition blpapi_providersession.h:2020
int setServicePriority(int priority)
Definition blpapi_providersession.h:1996
~ServiceRegistrationOptions()
Definition blpapi_providersession.h:1962
int getServicePriority() const
Definition blpapi_providersession.h:2015
RegistrationParts
Definition blpapi_providersession.h:1043
@ PART_PUBLISHING
register to receive subscribe and unsubscribe messages
Definition blpapi_providersession.h:1045
@ PART_DEFAULT
Definition blpapi_providersession.h:1063
@ PART_OPERATIONS
Definition blpapi_providersession.h:1048
@ PART_PUBLISHER_RESOLUTION
Definition blpapi_providersession.h:1057
@ PART_SUBSCRIBER_RESOLUTION
Definition blpapi_providersession.h:1052
void setPartsToRegister(int parts)
Definition blpapi_providersession.h:2002
ServiceRegistrationPriority
Definition blpapi_providersession.h:1032
@ PRIORITY_MEDIUM
Medium priority (INT_MAX/2)
Definition blpapi_providersession.h:1035
@ PRIORITY_LOW
Low priority (0)
Definition blpapi_providersession.h:1033
@ PRIORITY_HIGH
High priority (INT_MAX)
Definition blpapi_providersession.h:1037
void addActiveSubServiceCodeRange(int begin, int end, int priority)
Definition blpapi_providersession.h:1975
Definition blpapi_service.h:619
Definition blpapi_sessionoptions.h:1141
Definition blpapi_topiclist.h:336
Definition blpapi_topic.h:177
Definition blpapi_abstractsession.h:452
Definition blpapi_abstractsession.h:451