BLPAPI C++  3.24.11
blpapi_session.h File Reference

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

#include <blpapi_abstractsession.h>
#include <blpapi_call.h>
#include <blpapi_correlationid.h>
#include <blpapi_defs.h>
#include <blpapi_event.h>
#include <blpapi_eventdispatcher.h>
#include <blpapi_identity.h>
#include <blpapi_request.h>
#include <blpapi_requesttemplate.h>
#include <blpapi_service.h>
#include <blpapi_sessionoptions.h>
#include <blpapi_subscriptionlist.h>
#include <blpapi_types.h>
#include <stddef.h>
#include <cassert>

Go to the source code of this file.

Classes

class  EventHandler
 
struct  SubscriptionPreprocessError
 
struct  SubscriptionPreprocessMode
 
class  Session
 
class  SubscriptionIterator
 

Namespaces

 BloombergLP
 
 BloombergLP::blpapi
 

Typedefs

typedef void(* blpapi_EventHandler_t) (blpapi_Event_t *event, blpapi_Session_t *session, void *userData)
 
typedef void(* blpapi_SubscriptionPreprocessErrorHandler_t) (const blpapi_CorrelationId_t *correlationId, const char *subscriptionString, int errorCode, const char *errorDescription, void *userData)
 
typedef std::vector< SubscriptionPreprocessError > SubscriptionPreprocessErrors
 

Functions

blpapi_Session_tblpapi_Session_create (blpapi_SessionOptions_t *parameters, blpapi_EventHandler_t handler, blpapi_EventDispatcher_t *dispatcher, void *userData)
 
void blpapi_Session_destroy (blpapi_Session_t *session)
 
int blpapi_Session_start (blpapi_Session_t *session)
 
int blpapi_Session_startAsync (blpapi_Session_t *session)
 
int blpapi_Session_stop (blpapi_Session_t *session)
 
int blpapi_Session_stopAsync (blpapi_Session_t *session)
 
int blpapi_Session_nextEvent (blpapi_Session_t *session, blpapi_Event_t **eventPointer, unsigned int timeoutInMilliseconds)
 
int blpapi_Session_tryNextEvent (blpapi_Session_t *session, blpapi_Event_t **eventPointer)
 
int blpapi_Session_subscribe (blpapi_Session_t *session, const blpapi_SubscriptionList_t *subscriptionList, const blpapi_Identity_t *handle, const char *requestLabel, int requestLabelLen)
 
int blpapi_Session_subscribeEx (blpapi_Session_t *session, const blpapi_SubscriptionList_t *subscriptionList, const blpapi_Identity_t *handle, const char *requestLabel, int requestLabelLen, blpapi_SubscriptionPreprocessErrorHandler_t errorHandler, void *userData)
 
int blpapi_Session_resubscribe (blpapi_Session_t *session, const blpapi_SubscriptionList_t *resubscriptionList, const char *requestLabel, int requestLabelLen)
 
int blpapi_Session_resubscribeEx (blpapi_Session_t *session, const blpapi_SubscriptionList_t *resubscriptionList, const char *requestLabel, int requestLabelLen, blpapi_SubscriptionPreprocessErrorHandler_t errorHandler, void *userData)
 
int blpapi_Session_resubscribeWithId (blpapi_Session_t *session, const blpapi_SubscriptionList_t *resubscriptionList, int resubscriptionId, const char *requestLabel, int requestLabelLen)
 
int blpapi_Session_resubscribeWithIdEx (blpapi_Session_t *session, const blpapi_SubscriptionList_t *resubscriptionList, int resubscriptionId, const char *requestLabel, int requestLabelLen, blpapi_SubscriptionPreprocessErrorHandler_t errorHandler, void *userData)
 
int blpapi_Session_unsubscribe (blpapi_Session_t *session, const blpapi_SubscriptionList_t *unsubscriptionList, const char *requestLabel, int requestLabelLen)
 
int blpapi_Session_cancel (blpapi_Session_t *session, const blpapi_CorrelationId_t *correlationIds, size_t numCorrelationIds, const char *requestLabel, int requestLabelLen)
 
int blpapi_Session_setStatusCorrelationId (blpapi_Session_t *session, const blpapi_Service_t *service, const blpapi_Identity_t *identity, const blpapi_CorrelationId_t *correlationId)
 
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)
 
int blpapi_Session_sendRequestTemplate (blpapi_Session_t *session, const blpapi_RequestTemplate_t *requestTemplate, blpapi_CorrelationId_t *correlationId)
 
int blpapi_Session_createSnapshotRequestTemplate (blpapi_RequestTemplate_t **requestTemplate, blpapi_Session_t *session, const char *subscriptionString, const blpapi_Identity_t *identity, blpapi_CorrelationId_t *correlationId)
 
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)
 
int blpapi_Session_openService (blpapi_Session_t *session, const char *serviceName)
 
int blpapi_Session_openServiceAsync (blpapi_Session_t *session, const char *serviceName, blpapi_CorrelationId_t *correlationId)
 
int blpapi_Session_generateToken (blpapi_Session_t *session, blpapi_CorrelationId_t *correlationId, blpapi_EventQueue_t *eventQueue)
 
int blpapi_Session_getService (blpapi_Session_t *session, blpapi_Service_t **service, const char *serviceName)
 
blpapi_UserHandle_tblpapi_Session_createUserHandle (blpapi_Session_t *session)
 
blpapi_Identity_tblpapi_Session_createIdentity (blpapi_Session_t *session)
 
blpapi_AbstractSession_tblpapi_Session_getAbstractSession (blpapi_Session_t *session)
 
blpapi_SubscriptionIterator_tblpapi_SubscriptionItr_create (blpapi_Session_t *session)
 
void blpapi_SubscriptionItr_destroy (blpapi_SubscriptionIterator_t *iterator)
 
int blpapi_SubscriptionItr_next (blpapi_SubscriptionIterator_t *iterator, const char **subscriptionString, blpapi_CorrelationId_t *correlationId, int *status)
 
int blpapi_SubscriptionItr_isValid (const blpapi_SubscriptionIterator_t *iterator)
 
void blpapi_eventHandlerAdapter (blpapi_Event_t *event, blpapi_Session_t *, void *userData)
 
std::ostream & operator<< (std::ostream &os, const SubscriptionPreprocessError &error)
 
void blpapi_SubscriptionPreprocess_handleError (const blpapi_CorrelationId_t *correlationId, const char *subscriptionString, int errorCode, const char *description, void *userData)
 

Detailed Description

Provide consumer session to get Bloomberg Service.

Typedef Documentation

◆ blpapi_EventHandler_t

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

◆ blpapi_SubscriptionPreprocessErrorHandler_t

typedef void(* blpapi_SubscriptionPreprocessErrorHandler_t) (const blpapi_CorrelationId_t *correlationId, const char *subscriptionString, int errorCode, const char *errorDescription, void *userData)

Function Documentation

◆ blpapi_Session_cancel()

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

◆ blpapi_Session_create()

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

◆ blpapi_Session_createIdentity()

blpapi_Identity_t* blpapi_Session_createIdentity ( blpapi_Session_t session)

◆ blpapi_Session_createSnapshotRequestTemplate()

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_Session_createUserHandle()

blpapi_UserHandle_t* blpapi_Session_createUserHandle ( blpapi_Session_t session)

◆ blpapi_Session_destroy()

void blpapi_Session_destroy ( blpapi_Session_t session)

◆ blpapi_Session_generateToken()

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

◆ blpapi_Session_getAbstractSession()

blpapi_AbstractSession_t* blpapi_Session_getAbstractSession ( blpapi_Session_t session)

◆ blpapi_Session_getService()

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

◆ blpapi_Session_nextEvent()

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

◆ blpapi_Session_openService()

int blpapi_Session_openService ( blpapi_Session_t session,
const char *  serviceName 
)

◆ blpapi_Session_openServiceAsync()

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

◆ blpapi_Session_resubscribe()

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

◆ blpapi_Session_resubscribeEx()

int blpapi_Session_resubscribeEx ( blpapi_Session_t session,
const blpapi_SubscriptionList_t resubscriptionList,
const char *  requestLabel,
int  requestLabelLen,
blpapi_SubscriptionPreprocessErrorHandler_t  errorHandler,
void *  userData 
)

◆ blpapi_Session_resubscribeWithId()

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

◆ blpapi_Session_resubscribeWithIdEx()

int blpapi_Session_resubscribeWithIdEx ( blpapi_Session_t session,
const blpapi_SubscriptionList_t resubscriptionList,
int  resubscriptionId,
const char *  requestLabel,
int  requestLabelLen,
blpapi_SubscriptionPreprocessErrorHandler_t  errorHandler,
void *  userData 
)

◆ blpapi_Session_sendAuthorizationRequest()

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_Session_sendRequest()

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_Session_sendRequestTemplate()

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

◆ blpapi_Session_setStatusCorrelationId()

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

◆ blpapi_Session_start()

int blpapi_Session_start ( blpapi_Session_t session)

◆ blpapi_Session_startAsync()

int blpapi_Session_startAsync ( blpapi_Session_t session)

◆ blpapi_Session_stop()

int blpapi_Session_stop ( blpapi_Session_t session)

◆ blpapi_Session_stopAsync()

int blpapi_Session_stopAsync ( blpapi_Session_t session)

◆ blpapi_Session_subscribe()

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

◆ blpapi_Session_subscribeEx()

int blpapi_Session_subscribeEx ( blpapi_Session_t session,
const blpapi_SubscriptionList_t subscriptionList,
const blpapi_Identity_t handle,
const char *  requestLabel,
int  requestLabelLen,
blpapi_SubscriptionPreprocessErrorHandler_t  errorHandler,
void *  userData 
)

◆ blpapi_Session_tryNextEvent()

int blpapi_Session_tryNextEvent ( blpapi_Session_t session,
blpapi_Event_t **  eventPointer 
)

◆ blpapi_Session_unsubscribe()

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

◆ blpapi_SubscriptionItr_create()

blpapi_SubscriptionIterator_t* blpapi_SubscriptionItr_create ( blpapi_Session_t session)

◆ blpapi_SubscriptionItr_destroy()

void blpapi_SubscriptionItr_destroy ( blpapi_SubscriptionIterator_t iterator)

◆ blpapi_SubscriptionItr_isValid()

int blpapi_SubscriptionItr_isValid ( const blpapi_SubscriptionIterator_t iterator)

◆ blpapi_SubscriptionItr_next()

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