blpapi_providersession.h File Reference

Provide a session that can be used for providing services. More...

Go to the source code of this file.

Classes
class	blpapi::ProviderEventHandler
class	blpapi::ServiceRegistrationOptions
class	blpapi::ProviderSession
Namespaces
namespace	blpapi
Typedefs
typedef struct blpapi_ServiceRegistrationOptions	blpapi_ServiceRegistrationOptions_t
typedef void(*	blpapi_ProviderEventHandler_t )(blpapi_Event_t *event, blpapi_ProviderSession_t *session, void *userData)
Functions
BLPAPI_EXPORT blpapi_ProviderSession_t *	blpapi_ProviderSession_create (blpapi_SessionOptions_t *parameters, blpapi_ProviderEventHandler_t handler, blpapi_EventDispatcher_t *dispatcher, void *userData)
BLPAPI_EXPORT void	blpapi_ProviderSession_destroy (blpapi_ProviderSession_t *session)
BLPAPI_EXPORT int	blpapi_ProviderSession_start (blpapi_ProviderSession_t *session)
BLPAPI_EXPORT int	blpapi_ProviderSession_startAsync (blpapi_ProviderSession_t *session)
BLPAPI_EXPORT int	blpapi_ProviderSession_stop (blpapi_ProviderSession_t *session)
BLPAPI_EXPORT int	blpapi_ProviderSession_stopAsync (blpapi_ProviderSession_t *session)
BLPAPI_EXPORT int	blpapi_ProviderSession_nextEvent (blpapi_ProviderSession_t *session, blpapi_Event_t **eventPointer, unsigned int timeoutInMilliseconds)
BLPAPI_EXPORT int	blpapi_ProviderSession_tryNextEvent (blpapi_ProviderSession_t *session, blpapi_Event_t **eventPointer)
BLPAPI_EXPORT int	blpapi_ProviderSession_registerService (blpapi_ProviderSession_t *session, const char *serviceName, const blpapi_Identity_t *identity, blpapi_ServiceRegistrationOptions_t *registrationOptions)
BLPAPI_EXPORT int	blpapi_ProviderSession_activateSubServiceCodeRange (blpapi_ProviderSession_t *session, const char *serviceName, int begin, int end, int priority)
BLPAPI_EXPORT int	blpapi_ProviderSession_deactivateSubServiceCodeRange (blpapi_ProviderSession_t *session, const char *serviceName, int begin, int end)
BLPAPI_EXPORT int	blpapi_ProviderSession_registerServiceAsync (blpapi_ProviderSession_t *session, const char *serviceName, const blpapi_Identity_t *identity, blpapi_CorrelationId_t *correlationId, blpapi_ServiceRegistrationOptions_t *registrationOptions)
BLPAPI_EXPORT int	blpapi_ProviderSession_deregisterService (blpapi_ProviderSession_t *session, const char *serviceName)
BLPAPI_EXPORT int	blpapi_ProviderSession_resolve (blpapi_ProviderSession_t *session, blpapi_ResolutionList_t *resolutionList, int resolveMode, const blpapi_Identity_t *identity)
BLPAPI_EXPORT int	blpapi_ProviderSession_resolveAsync (blpapi_ProviderSession_t *session, const blpapi_ResolutionList_t *resolutionList, int resolveMode, const blpapi_Identity_t *identity)
BLPAPI_EXPORT int	blpapi_ProviderSession_createTopics (blpapi_ProviderSession_t *session, blpapi_TopicList_t *topicList, int resolveMode, const blpapi_Identity_t *identity)
BLPAPI_EXPORT int	blpapi_ProviderSession_createTopicsAsync (blpapi_ProviderSession_t *session, const blpapi_TopicList_t *topicList, int resolveMode, const blpapi_Identity_t *identity)
BLPAPI_EXPORT int	blpapi_ProviderSession_getTopic (blpapi_ProviderSession_t *session, const blpapi_Message_t *message, blpapi_Topic_t **topic)
BLPAPI_EXPORT int	blpapi_ProviderSession_createTopic (blpapi_ProviderSession_t *session, const blpapi_Message_t *message, blpapi_Topic_t **topic)
BLPAPI_EXPORT int	blpapi_ProviderSession_createServiceStatusTopic (blpapi_ProviderSession_t *session, const blpapi_Service_t *service, blpapi_Topic_t **topic)
BLPAPI_EXPORT int	blpapi_ProviderSession_deleteTopics (blpapi_ProviderSession_t *session, const blpapi_Topic_t **topics, size_t numTopics)
BLPAPI_EXPORT int	blpapi_ProviderSession_terminateSubscriptionsOnTopics (blpapi_ProviderSession_t *session, const blpapi_Topic_t **topics, size_t numTopics, const char *message)
BLPAPI_EXPORT int	blpapi_ProviderSession_publish (blpapi_ProviderSession_t *session, blpapi_Event_t *event)
BLPAPI_EXPORT int	blpapi_ProviderSession_sendResponse (blpapi_ProviderSession_t *session, blpapi_Event_t *event, int isPartialResponse)
BLPAPI_EXPORT blpapi_AbstractSession_t *	blpapi_ProviderSession_getAbstractSession (blpapi_ProviderSession_t *session)
BLPAPI_EXPORT int	blpapi_ProviderSession_flushPublishedEvents (blpapi_ProviderSession_t *session, int *allFlushed, int timeoutMsecs)
BLPAPI_EXPORT blpapi_ServiceRegistrationOptions_t *	blpapi_ServiceRegistrationOptions_create (void)
BLPAPI_EXPORT blpapi_ServiceRegistrationOptions_t *	blpapi_ServiceRegistrationOptions_duplicate (const blpapi_ServiceRegistrationOptions_t *parameters)
BLPAPI_EXPORT void	blpapi_ServiceRegistrationOptions_destroy (blpapi_ServiceRegistrationOptions_t *parameters)
BLPAPI_EXPORT void	blpapi_ServiceRegistrationOptions_copy (blpapi_ServiceRegistrationOptions_t *lhs, const blpapi_ServiceRegistrationOptions_t *rhs)
BLPAPI_EXPORT int	blpapi_ServiceRegistrationOptions_addActiveSubServiceCodeRange (blpapi_ServiceRegistrationOptions_t *parameters, int start, int end, int priority)
BLPAPI_EXPORT void	blpapi_ServiceRegistrationOptions_removeAllActiveSubServiceCodeRanges (blpapi_ServiceRegistrationOptions_t *parameters)
BLPAPI_EXPORT void	blpapi_ServiceRegistrationOptions_setGroupId (blpapi_ServiceRegistrationOptions_t *parameters, const char *groupId, unsigned int groupIdLength)
BLPAPI_EXPORT int	blpapi_ServiceRegistrationOptions_setServicePriority (blpapi_ServiceRegistrationOptions_t *parameters, int priority)
BLPAPI_EXPORT void	blpapi_ServiceRegistrationOptions_setPartsToRegister (blpapi_ServiceRegistrationOptions_t *parameters, int parts)
BLPAPI_EXPORT int	blpapi_ServiceRegistrationOptions_getGroupId (blpapi_ServiceRegistrationOptions_t *parameters, char *groupdIdBuffer, int *groupIdLength)
BLPAPI_EXPORT int	blpapi_ServiceRegistrationOptions_getServicePriority (blpapi_ServiceRegistrationOptions_t *parameters)
BLPAPI_EXPORT int	blpapi_ServiceRegistrationOptions_getPartsToRegister (blpapi_ServiceRegistrationOptions_t *parameters)
void	blpapi::blpapi_providerEventHandlerAdapter (blpapi_Event_t *event, blpapi_ProviderSession_t *session, void *userData)

---

Detailed Description

Provide a session that can be used for providing services.

---

Typedef Documentation

typedef struct blpapi_ServiceRegistrationOptions blpapi_ServiceRegistrationOptions_t

typedef void(* blpapi_ProviderEventHandler_t)(blpapi_Event_t *event, blpapi_ProviderSession_t *session, void *userData)

---

Function Documentation

BLPAPI_EXPORT blpapi_ProviderSession_t* blpapi_ProviderSession_create	(	blpapi_SessionOptions_t *	parameters,
		blpapi_ProviderEventHandler_t	handler,
		blpapi_EventDispatcher_t *	dispatcher,
		void *	userData
	)

BLPAPI_EXPORT void blpapi_ProviderSession_destroy

(

blpapi_ProviderSession_t *

session

)

BLPAPI_EXPORT int blpapi_ProviderSession_start

(

blpapi_ProviderSession_t *

session

)

BLPAPI_EXPORT int blpapi_ProviderSession_startAsync

(

blpapi_ProviderSession_t *

session

)

BLPAPI_EXPORT int blpapi_ProviderSession_stop

(

blpapi_ProviderSession_t *

session

)

BLPAPI_EXPORT int blpapi_ProviderSession_stopAsync

(

blpapi_ProviderSession_t *

session

)

BLPAPI_EXPORT int blpapi_ProviderSession_nextEvent	(	blpapi_ProviderSession_t *	session,
		blpapi_Event_t **	eventPointer,
		unsigned int	timeoutInMilliseconds
	)

BLPAPI_EXPORT int blpapi_ProviderSession_tryNextEvent	(	blpapi_ProviderSession_t *	session,
		blpapi_Event_t **	eventPointer
	)

BLPAPI_EXPORT int blpapi_ProviderSession_registerService	(	blpapi_ProviderSession_t *	session,
		const char *	serviceName,
		const blpapi_Identity_t *	identity,
		blpapi_ServiceRegistrationOptions_t *	registrationOptions
	)

BLPAPI_EXPORT int blpapi_ProviderSession_activateSubServiceCodeRange	(	blpapi_ProviderSession_t *	session,
		const char *	serviceName,
		int	begin,
		int	end,
		int	priority
	)

BLPAPI_EXPORT int blpapi_ProviderSession_deactivateSubServiceCodeRange	(	blpapi_ProviderSession_t *	session,
		const char *	serviceName,
		int	begin,
		int	end
	)

BLPAPI_EXPORT int blpapi_ProviderSession_registerServiceAsync	(	blpapi_ProviderSession_t *	session,
		const char *	serviceName,
		const blpapi_Identity_t *	identity,
		blpapi_CorrelationId_t *	correlationId,
		blpapi_ServiceRegistrationOptions_t *	registrationOptions
	)

BLPAPI_EXPORT int blpapi_ProviderSession_deregisterService	(	blpapi_ProviderSession_t *	session,
		const char *	serviceName
	)

BLPAPI_EXPORT int blpapi_ProviderSession_resolve	(	blpapi_ProviderSession_t *	session,
		blpapi_ResolutionList_t *	resolutionList,
		int	resolveMode,
		const blpapi_Identity_t *	identity
	)

BLPAPI_EXPORT int blpapi_ProviderSession_resolveAsync	(	blpapi_ProviderSession_t *	session,
		const blpapi_ResolutionList_t *	resolutionList,
		int	resolveMode,
		const blpapi_Identity_t *	identity
	)

BLPAPI_EXPORT int blpapi_ProviderSession_createTopics	(	blpapi_ProviderSession_t *	session,
		blpapi_TopicList_t *	topicList,
		int	resolveMode,
		const blpapi_Identity_t *	identity
	)

BLPAPI_EXPORT int blpapi_ProviderSession_createTopicsAsync	(	blpapi_ProviderSession_t *	session,
		const blpapi_TopicList_t *	topicList,
		int	resolveMode,
		const blpapi_Identity_t *	identity
	)

BLPAPI_EXPORT int blpapi_ProviderSession_getTopic	(	blpapi_ProviderSession_t *	session,
		const blpapi_Message_t *	message,
		blpapi_Topic_t **	topic
	)

BLPAPI_EXPORT int blpapi_ProviderSession_createTopic	(	blpapi_ProviderSession_t *	session,
		const blpapi_Message_t *	message,
		blpapi_Topic_t **	topic
	)

BLPAPI_EXPORT int blpapi_ProviderSession_createServiceStatusTopic	(	blpapi_ProviderSession_t *	session,
		const blpapi_Service_t *	service,
		blpapi_Topic_t **	topic
	)

BLPAPI_EXPORT int blpapi_ProviderSession_deleteTopics	(	blpapi_ProviderSession_t *	session,
		const blpapi_Topic_t **	topics,
		size_t	numTopics
	)

BLPAPI_EXPORT int blpapi_ProviderSession_terminateSubscriptionsOnTopics	(	blpapi_ProviderSession_t *	session,
		const blpapi_Topic_t **	topics,
		size_t	numTopics,
		const char *	message
	)

BLPAPI_EXPORT int blpapi_ProviderSession_publish	(	blpapi_ProviderSession_t *	session,
		blpapi_Event_t *	event
	)

BLPAPI_EXPORT int blpapi_ProviderSession_sendResponse	(	blpapi_ProviderSession_t *	session,
		blpapi_Event_t *	event,
		int	isPartialResponse
	)

BLPAPI_EXPORT blpapi_AbstractSession_t* blpapi_ProviderSession_getAbstractSession

(

blpapi_ProviderSession_t *

session

)

BLPAPI_EXPORT int blpapi_ProviderSession_flushPublishedEvents	(	blpapi_ProviderSession_t *	session,
		int *	allFlushed,
		int	timeoutMsecs
	)

BLPAPI_EXPORT blpapi_ServiceRegistrationOptions_t* blpapi_ServiceRegistrationOptions_create

(

void

)

BLPAPI_EXPORT blpapi_ServiceRegistrationOptions_t* blpapi_ServiceRegistrationOptions_duplicate

(

const blpapi_ServiceRegistrationOptions_t *

parameters

)

BLPAPI_EXPORT void blpapi_ServiceRegistrationOptions_destroy

(

blpapi_ServiceRegistrationOptions_t *

parameters

)

BLPAPI_EXPORT void blpapi_ServiceRegistrationOptions_copy	(	blpapi_ServiceRegistrationOptions_t *	lhs,
		const blpapi_ServiceRegistrationOptions_t *	rhs
	)

BLPAPI_EXPORT int blpapi_ServiceRegistrationOptions_addActiveSubServiceCodeRange	(	blpapi_ServiceRegistrationOptions_t *	parameters,
		int	start,
		int	end,
		int	priority
	)

BLPAPI_EXPORT void blpapi_ServiceRegistrationOptions_removeAllActiveSubServiceCodeRanges

(

blpapi_ServiceRegistrationOptions_t *

parameters

)

BLPAPI_EXPORT void blpapi_ServiceRegistrationOptions_setGroupId	(	blpapi_ServiceRegistrationOptions_t *	parameters,
		const char *	groupId,
		unsigned int	groupIdLength
	)

BLPAPI_EXPORT int blpapi_ServiceRegistrationOptions_setServicePriority	(	blpapi_ServiceRegistrationOptions_t *	parameters,
		int	priority
	)

BLPAPI_EXPORT void blpapi_ServiceRegistrationOptions_setPartsToRegister	(	blpapi_ServiceRegistrationOptions_t *	parameters,
		int	parts
	)

BLPAPI_EXPORT int blpapi_ServiceRegistrationOptions_getGroupId	(	blpapi_ServiceRegistrationOptions_t *	parameters,
		char *	groupdIdBuffer,
		int *	groupIdLength
	)

BLPAPI_EXPORT int blpapi_ServiceRegistrationOptions_getServicePriority

(

blpapi_ServiceRegistrationOptions_t *

parameters

)

BLPAPI_EXPORT int blpapi_ServiceRegistrationOptions_getPartsToRegister

(

blpapi_ServiceRegistrationOptions_t *

parameters

)