blpapi_session.h File Reference

Provide consumer session to get Bloomberg Service. More...

Go to the source code of this file.

Classes
class	blpapi::EventHandler
class	blpapi::Session
class	blpapi::SubscriptionIterator
Namespaces
namespace	blpapi
Defines
#define	INCLUDED_CSTRING
Typedefs
typedef void(*	blpapi_EventHandler_t )(blpapi_Event_t *event, blpapi_Session_t *session, void *userData)
Functions
BLPAPI_EXPORT blpapi_Session_t *	blpapi_Session_create (blpapi_SessionOptions_t *parameters, blpapi_EventHandler_t handler, blpapi_EventDispatcher_t *dispatcher, void *userData)
BLPAPI_EXPORT void	blpapi_Session_destroy (blpapi_Session_t *session)
BLPAPI_EXPORT int	blpapi_Session_start (blpapi_Session_t *session)
BLPAPI_EXPORT int	blpapi_Session_startAsync (blpapi_Session_t *session)
BLPAPI_EXPORT int	blpapi_Session_stop (blpapi_Session_t *session)
BLPAPI_EXPORT int	blpapi_Session_stopAsync (blpapi_Session_t *session)
BLPAPI_EXPORT int	blpapi_Session_nextEvent (blpapi_Session_t *session, blpapi_Event_t **eventPointer, unsigned int timeoutInMilliseconds)
BLPAPI_EXPORT int	blpapi_Session_tryNextEvent (blpapi_Session_t *session, blpapi_Event_t **eventPointer)
BLPAPI_EXPORT int	blpapi_Session_subscribe (blpapi_Session_t *session, const blpapi_SubscriptionList_t *subscriptionList, const blpapi_Identity_t *handle, const char *requestLabel, int requestLabelLen)
BLPAPI_EXPORT int	blpapi_Session_resubscribe (blpapi_Session_t *session, const blpapi_SubscriptionList_t *resubscriptionList, const char *requestLabel, int requestLabelLen)
BLPAPI_EXPORT int	blpapi_Session_resubscribeWithId (blpapi_Session_t *session, const blpapi_SubscriptionList_t *resubscriptionList, int resubscriptionId, const char *requestLabel, int requestLabelLen)
BLPAPI_EXPORT int	blpapi_Session_unsubscribe (blpapi_Session_t *session, const blpapi_SubscriptionList_t *unsubscriptionList, const char *requestLabel, int requestLabelLen)
BLPAPI_EXPORT int	blpapi_Session_cancel (blpapi_Session_t *session, const blpapi_CorrelationId_t *correlationIds, size_t numCorrelationIds, const char *requestLabel, int requestLabelLen)
BLPAPI_EXPORT int	blpapi_Session_setStatusCorrelationId (blpapi_Session_t *session, const blpapi_Service_t *service, const blpapi_Identity_t *identity, const blpapi_CorrelationId_t *correlationId)
BLPAPI_EXPORT int	blpapi_Session_sendRequest (blpapi_Session_t *session, const blpapi_Request_t *request, blpapi_CorrelationId_t *correlationId, blpapi_Identity_t *identity, blpapi_EventQueue_t *eventQueue, const char *requestLabel, int requestLabelLen)
BLPAPI_EXPORT int	blpapi_Session_sendRequestTemplate (blpapi_Session_t *session, const blpapi_RequestTemplate_t *requestTemplate, blpapi_CorrelationId_t *correlationId)
BLPAPI_EXPORT int	blpapi_Session_createSnapshotRequestTemplate (blpapi_RequestTemplate_t **requestTemplate, blpapi_Session_t *session, const char *subscriptionString, const blpapi_Identity_t *identity, blpapi_CorrelationId_t *correlationId)
BLPAPI_EXPORT int	blpapi_Session_sendAuthorizationRequest (blpapi_Session_t *session, const blpapi_Request_t *request, blpapi_Identity_t *identity, blpapi_CorrelationId_t *correlationId, blpapi_EventQueue_t *eventQueue, const char *requestLabel, int requestLabelLen)
BLPAPI_EXPORT int	blpapi_Session_openService (blpapi_Session_t *session, const char *serviceName)
BLPAPI_EXPORT int	blpapi_Session_openServiceAsync (blpapi_Session_t *session, const char *serviceName, blpapi_CorrelationId_t *correlationId)
BLPAPI_EXPORT int	blpapi_Session_generateToken (blpapi_Session_t *session, blpapi_CorrelationId_t *correlationId, blpapi_EventQueue_t *eventQueue)
BLPAPI_EXPORT int	blpapi_Session_getService (blpapi_Session_t *session, blpapi_Service_t **service, const char *serviceName)
BLPAPI_EXPORT blpapi_UserHandle_t *	blpapi_Session_createUserHandle (blpapi_Session_t *session)
BLPAPI_EXPORT blpapi_Identity_t *	blpapi_Session_createIdentity (blpapi_Session_t *session)
BLPAPI_EXPORT blpapi_AbstractSession_t *	blpapi_Session_getAbstractSession (blpapi_Session_t *session)
BLPAPI_EXPORT blpapi_SubscriptionIterator_t *	blpapi_SubscriptionItr_create (blpapi_Session_t *session)
BLPAPI_EXPORT void	blpapi_SubscriptionItr_destroy (blpapi_SubscriptionIterator_t *iterator)
BLPAPI_EXPORT int	blpapi_SubscriptionItr_next (blpapi_SubscriptionIterator_t *iterator, const char **subscriptionString, blpapi_CorrelationId_t *correlationId, int *status)
BLPAPI_EXPORT int	blpapi_SubscriptionItr_isValid (const blpapi_SubscriptionIterator_t *iterator)
void	blpapi::blpapi_eventHandlerAdapter (blpapi_Event_t *event, blpapi_Session_t *, void *userData)

---

Detailed Description

Provide consumer session to get Bloomberg Service.

---

Define Documentation

#define INCLUDED_CSTRING

---

Typedef Documentation

typedef void(* blpapi_EventHandler_t)(blpapi_Event_t *event, blpapi_Session_t *session, void *userData)

---

Function Documentation

BLPAPI_EXPORT blpapi_Session_t* blpapi_Session_create	(	blpapi_SessionOptions_t *	parameters,
		blpapi_EventHandler_t	handler,
		blpapi_EventDispatcher_t *	dispatcher,
		void *	userData
	)

BLPAPI_EXPORT void blpapi_Session_destroy

(

blpapi_Session_t *

session

)

BLPAPI_EXPORT int blpapi_Session_start

(

blpapi_Session_t *

session

)

BLPAPI_EXPORT int blpapi_Session_startAsync

(

blpapi_Session_t *

session

)

BLPAPI_EXPORT int blpapi_Session_stop

(

blpapi_Session_t *

session

)

BLPAPI_EXPORT int blpapi_Session_stopAsync

(

blpapi_Session_t *

session

)

BLPAPI_EXPORT int blpapi_Session_nextEvent	(	blpapi_Session_t *	session,
		blpapi_Event_t **	eventPointer,
		unsigned int	timeoutInMilliseconds
	)

BLPAPI_EXPORT int blpapi_Session_tryNextEvent	(	blpapi_Session_t *	session,
		blpapi_Event_t **	eventPointer
	)

BLPAPI_EXPORT int blpapi_Session_subscribe	(	blpapi_Session_t *	session,
		const blpapi_SubscriptionList_t *	subscriptionList,
		const blpapi_Identity_t *	handle,
		const char *	requestLabel,
		int	requestLabelLen
	)

BLPAPI_EXPORT int blpapi_Session_resubscribe	(	blpapi_Session_t *	session,
		const blpapi_SubscriptionList_t *	resubscriptionList,
		const char *	requestLabel,
		int	requestLabelLen
	)

BLPAPI_EXPORT int blpapi_Session_resubscribeWithId	(	blpapi_Session_t *	session,
		const blpapi_SubscriptionList_t *	resubscriptionList,
		int	resubscriptionId,
		const char *	requestLabel,
		int	requestLabelLen
	)

BLPAPI_EXPORT int blpapi_Session_unsubscribe	(	blpapi_Session_t *	session,
		const blpapi_SubscriptionList_t *	unsubscriptionList,
		const char *	requestLabel,
		int	requestLabelLen
	)

BLPAPI_EXPORT int blpapi_Session_cancel	(	blpapi_Session_t *	session,
		const blpapi_CorrelationId_t *	correlationIds,
		size_t	numCorrelationIds,
		const char *	requestLabel,
		int	requestLabelLen
	)

BLPAPI_EXPORT int blpapi_Session_setStatusCorrelationId	(	blpapi_Session_t *	session,
		const blpapi_Service_t *	service,
		const blpapi_Identity_t *	identity,
		const blpapi_CorrelationId_t *	correlationId
	)

BLPAPI_EXPORT int blpapi_Session_sendRequest	(	blpapi_Session_t *	session,
		const blpapi_Request_t *	request,
		blpapi_CorrelationId_t *	correlationId,
		blpapi_Identity_t *	identity,
		blpapi_EventQueue_t *	eventQueue,
		const char *	requestLabel,
		int	requestLabelLen
	)

BLPAPI_EXPORT int blpapi_Session_sendRequestTemplate	(	blpapi_Session_t *	session,
		const blpapi_RequestTemplate_t *	requestTemplate,
		blpapi_CorrelationId_t *	correlationId
	)

BLPAPI_EXPORT int blpapi_Session_createSnapshotRequestTemplate	(	blpapi_RequestTemplate_t **	requestTemplate,
		blpapi_Session_t *	session,
		const char *	subscriptionString,
		const blpapi_Identity_t *	identity,
		blpapi_CorrelationId_t *	correlationId
	)

BLPAPI_EXPORT int blpapi_Session_sendAuthorizationRequest	(	blpapi_Session_t *	session,
		const blpapi_Request_t *	request,
		blpapi_Identity_t *	identity,
		blpapi_CorrelationId_t *	correlationId,
		blpapi_EventQueue_t *	eventQueue,
		const char *	requestLabel,
		int	requestLabelLen
	)

BLPAPI_EXPORT int blpapi_Session_openService	(	blpapi_Session_t *	session,
		const char *	serviceName
	)

BLPAPI_EXPORT int blpapi_Session_openServiceAsync	(	blpapi_Session_t *	session,
		const char *	serviceName,
		blpapi_CorrelationId_t *	correlationId
	)

BLPAPI_EXPORT int blpapi_Session_generateToken	(	blpapi_Session_t *	session,
		blpapi_CorrelationId_t *	correlationId,
		blpapi_EventQueue_t *	eventQueue
	)

BLPAPI_EXPORT int blpapi_Session_getService	(	blpapi_Session_t *	session,
		blpapi_Service_t **	service,
		const char *	serviceName
	)

BLPAPI_EXPORT blpapi_UserHandle_t* blpapi_Session_createUserHandle

(

blpapi_Session_t *

session

)

BLPAPI_EXPORT blpapi_Identity_t* blpapi_Session_createIdentity

(

blpapi_Session_t *

session

)

BLPAPI_EXPORT blpapi_AbstractSession_t* blpapi_Session_getAbstractSession

(

blpapi_Session_t *

session

)

BLPAPI_EXPORT blpapi_SubscriptionIterator_t* blpapi_SubscriptionItr_create

(

blpapi_Session_t *

session

)

BLPAPI_EXPORT void blpapi_SubscriptionItr_destroy

(

blpapi_SubscriptionIterator_t *

iterator

)

BLPAPI_EXPORT int blpapi_SubscriptionItr_next	(	blpapi_SubscriptionIterator_t *	iterator,
		const char **	subscriptionString,
		blpapi_CorrelationId_t *	correlationId,
		int *	status
	)

BLPAPI_EXPORT int blpapi_SubscriptionItr_isValid

(

const blpapi_SubscriptionIterator_t *

iterator

)