blpapi_abstractsession.h File Reference

A common interface shared between publish and consumer sessions. More...

Go to the source code of this file.

Classes
class	blpapi::AbstractSession
Namespaces
namespace	blpapi
Defines
#define	INCLUDED_VECTOR
Typedefs
typedef Identity	blpapi::UserHandle
Functions
BLPAPI_EXPORT void	blpapi_UserHandle_release (blpapi_UserHandle_t *handle)
BLPAPI_EXPORT int	blpapi_UserHandle_addRef (blpapi_UserHandle_t *handle)
BLPAPI_EXPORT int	blpapi_UserHandle_hasEntitlements (const blpapi_UserHandle_t *handle, const blpapi_Service_t *service, const blpapi_Element_t *eidElement, const int *entitlementIds, size_t numEntitlements, int *failedEntitlements, int *failedEntitlementsCount)
BLPAPI_EXPORT int	blpapi_AbstractSession_cancel (blpapi_AbstractSession_t *session, const blpapi_CorrelationId_t *correlationIds, size_t numCorrelationIds, const char *requestLabel, int requestLabelLen)
BLPAPI_EXPORT int	blpapi_AbstractSession_sendAuthorizationRequest (blpapi_AbstractSession_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_AbstractSession_openService (blpapi_AbstractSession_t *session, const char *serviceIdentifier)
BLPAPI_EXPORT int	blpapi_AbstractSession_openServiceAsync (blpapi_AbstractSession_t *session, const char *serviceIdentifier, blpapi_CorrelationId_t *correlationId)
BLPAPI_EXPORT int	blpapi_AbstractSession_generateToken (blpapi_AbstractSession_t *session, blpapi_CorrelationId_t *correlationId, blpapi_EventQueue_t *eventQueue)
BLPAPI_EXPORT int	blpapi_AbstractSession_generateManualToken (blpapi_AbstractSession_t *session, blpapi_CorrelationId_t *correlationId, const char *user, const char *manualIp, blpapi_EventQueue_t *eventQueue)
BLPAPI_EXPORT int	blpapi_AbstractSession_getService (blpapi_AbstractSession_t *session, blpapi_Service_t **service, const char *serviceIdentifier)
BLPAPI_EXPORT blpapi_Identity_t *	blpapi_AbstractSession_createIdentity (blpapi_AbstractSession_t *session)

---

Detailed Description

A common interface shared between publish and consumer sessions.

---

Define Documentation

#define INCLUDED_VECTOR

---

Function Documentation

BLPAPI_EXPORT void blpapi_UserHandle_release

(

blpapi_UserHandle_t *

handle

)

BLPAPI_EXPORT int blpapi_UserHandle_addRef

(

blpapi_UserHandle_t *

handle

)

BLPAPI_EXPORT int blpapi_UserHandle_hasEntitlements	(	const blpapi_UserHandle_t *	handle,
		const blpapi_Service_t *	service,
		const blpapi_Element_t *	eidElement,
		const int *	entitlementIds,
		size_t	numEntitlements,
		int *	failedEntitlements,
		int *	failedEntitlementsCount
	)

BLPAPI_EXPORT int blpapi_AbstractSession_cancel	(	blpapi_AbstractSession_t *	session,
		const blpapi_CorrelationId_t *	correlationIds,
		size_t	numCorrelationIds,
		const char *	requestLabel,
		int	requestLabelLen
	)

BLPAPI_EXPORT int blpapi_AbstractSession_sendAuthorizationRequest	(	blpapi_AbstractSession_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_AbstractSession_openService	(	blpapi_AbstractSession_t *	session,
		const char *	serviceIdentifier
	)

BLPAPI_EXPORT int blpapi_AbstractSession_openServiceAsync	(	blpapi_AbstractSession_t *	session,
		const char *	serviceIdentifier,
		blpapi_CorrelationId_t *	correlationId
	)

BLPAPI_EXPORT int blpapi_AbstractSession_generateToken	(	blpapi_AbstractSession_t *	session,
		blpapi_CorrelationId_t *	correlationId,
		blpapi_EventQueue_t *	eventQueue
	)

BLPAPI_EXPORT int blpapi_AbstractSession_generateManualToken	(	blpapi_AbstractSession_t *	session,
		blpapi_CorrelationId_t *	correlationId,
		const char *	user,
		const char *	manualIp,
		blpapi_EventQueue_t *	eventQueue
	)

BLPAPI_EXPORT int blpapi_AbstractSession_getService	(	blpapi_AbstractSession_t *	session,
		blpapi_Service_t **	service,
		const char *	serviceIdentifier
	)

BLPAPI_EXPORT blpapi_Identity_t* blpapi_AbstractSession_createIdentity

(

blpapi_AbstractSession_t *

session

)