#include <blpapi_abstractsession.h>
Public Member Functions | |
| virtual | ~AbstractSession () |
| virtual bool | start ()=0 |
| virtual bool | startAsync ()=0 |
| virtual void | stop ()=0 |
| virtual void | stopAsync ()=0 |
| virtual Event | nextEvent (int timeout=0)=0 |
| virtual int | tryNextEvent (Event *event)=0 |
| virtual bool | openService (const char *serviceIdentifier) |
| virtual CorrelationId | openServiceAsync (const char *serviceIdentifier, const CorrelationId &correlationId=CorrelationId()) |
| virtual CorrelationId | sendAuthorizationRequest (const Request &authorizationRequest, Identity *identity, const CorrelationId &correlationId=CorrelationId(), EventQueue *eventQueue=0) |
| virtual void | cancel (const CorrelationId &correlationId) |
| virtual void | cancel (const std::vector< CorrelationId > &correlationIds) |
| virtual void | cancel (const CorrelationId *correlationIds, size_t numCorrelationIds) |
| virtual CorrelationId | generateToken (const CorrelationId &correlationId=CorrelationId(), EventQueue *eventQueue=0) |
| virtual CorrelationId | generateToken (const char *userId, const char *ipAddress, const CorrelationId &correlationId=CorrelationId(), EventQueue *eventQueue=0) |
| virtual Service | getService (const char *serviceIdentifier) const |
| virtual Identity | createIdentity () |
| CorrelationId | generateAuthorizedIdentity (const AuthOptions &authOptions, const CorrelationId &cid=CorrelationId()) |
| Identity | getAuthorizedIdentity (const CorrelationId &correlationId=CorrelationId()) |
| std::string | sessionName () |
DEPRECATED | |
| BLPAPI_DEPRECATE_ABSTRACT_SESSION_CREATE_USER_HANDLE UserHandle | createUserHandle () |
Detailed Description
This class provides an abstract session which defines a shared interface between publisher and consumer requests for Bloomberg.
Sessions manage access to services either by requests and responses or subscriptions. A Session can dispatch events and replies in either a synchronous or asynchronous mode. The mode of a Session is determined when it is constructed and cannot be changed subsequently.
A Session is asynchronous if an EventHandler object is supplied when it is constructed. The setEventHandler() method may be called to adjust the way events are handled subsequently and the nextEvent() method may not be called. All incoming events are delivered to the EventHandler(s) supplied on construction or subsequently using setEventHandler().
A Session is synchronous if an EventHandler object is not supplied when it is constructed. The nextEvent() method must be called to read incoming events and the setEventHandler() method may not be called.
Several methods in Session take a CorrelationId parameter. The application may choose to supply its own CorrelationId values or allow the Session to create values. If the application supplies its own CorrelationId values it must manage their lifetime such that the same value is not reused for more than one operation at a time. The lifetime of a CorrelationId begins when it is supplied in a method invoked on a Session and ends either when it is explicitly cancelled using cancel() or unsubscribe(), when a RESPONSE Event (not a PARTIAL_RESPONSE) containing it is received or when a SUBSCRIPTION_STATUS Event which indicates that the subscription it refers to has been terminated is received.
When using an asynchronous Session the application must be aware that because the callbacks are generated from another thread they may be processed before the call which generates them has returned. For example, the SESSION_STATUS Event generated by a startAsync() may be processed before startAsync() has returned (even though startAsync() itself will not block).
This becomes more significant when Session generated CorrelationIds are in use. For example, if a call to subscribe() which returns a Session generated CorrelationId has not completed before the first Events which contain that CorrelationId arrive the application may not be able to interpret those events correctly. For this reason, it is preferable to use user generated CorrelationIds when using asynchronous Sessions. This issue does not arise when using a synchronous Session as long as the calls to subscribe() etc are made on the same thread as the calls to nextEvent().
Constructor & Destructor Documentation
◆ ~AbstractSession()
|
virtual |
Destructor.
Member Function Documentation
◆ cancel() [1/3]
|
virtual |
If the specified correlationId identifies a current request then cancel that request.
Once this call returns the specified correlationId will not be seen in any subsequent Message obtained from a MessageIterator by calling next(). However, any Message currently pointed to by a MessageIterator when cancel() is called is not affected even if it has the specified correlationId. Also any Message where a reference has been retained by the application may still contain the correlationId. For these reasons, although technically an application is free to re-use correlationId as soon as this method returns it is preferable not to aggressively re-use correlation IDs, particularly with an asynchronous Session.
◆ cancel() [2/3]
|
virtual |
For each value in the specified correlationIds which identifies a current request then cancel that request. Any values in the specified correlationIds which do not identify a current request are ignored.
Once this call returns the specified correlationIds will not be seen in any subsequent Message obtained from a MessageIterator by calling next(). However, any Message currently pointed to by a MessageIterator when cancel() is called is not affected even if it has one of the specified correlationIds. Also any Message where a reference has been retained by the application may still contain one of the correlationIds. For these reasons, although technically an application is free to re-use any of the correlationIds as soon as this method returns it is preferable not to aggressively re-use correlation IDs, particularly with an asynchronous Session.
◆ cancel() [3/3]
|
virtual |
For each value specified correlationIds and numCorrelationIds which identifies a current request then cancel that request. Any specified CorrelationId's which do not identify a current request are ignored.
Once this call returns the specified correlationIds will not be seen in any subsequent Message obtained from a MessageIterator by calling next(). However, any Message currently pointed to by a MessageIterator when cancel() is called is not affected even if it has one of the specified correlationIds. Also any Message where a reference has been retained by the application may still contain one of the correlationIds. For these reasons, although technically an application is free to re-use any of the correlationIds as soon as this method returns it is preferable not to aggressively re-use correlation IDs, particularly with an asynchronous Session.
◆ createIdentity()
◆ createUserHandle()
| UserHandle createUserHandle | ( | ) |
- Deprecated:
- Use createIdentity() instead.
Return a UserHandle which is valid but has not been authorized.
◆ generateAuthorizedIdentity()
| CorrelationId generateAuthorizedIdentity | ( | const AuthOptions & | authOptions, |
| const CorrelationId & | cid = CorrelationId() |
||
| ) |
Generates an authorized Identity with the specified AuthOptions and optionally specified cid.
The optionally specified cid is used to track Event objects generated as a result of this call. Return the actual CorrelationId object that will identify the messages associated with the generated identity.
One or more AUTHORIZATION_STATUS events, zero or more TOKEN_STATUS events and zero or more SERVICE_STATUS events are generated. If this is an asynchronous session then these Events may be processed by the registered EventHandler before generateAuthorizedIdentity() has returned.
◆ generateToken() [1/2]
|
virtual |
Generate a token to be used for authorization. If an invalid authentication option is specified in session option or there is a failure to get authentication information based on authentication option, or if the authentication mode is MANUAL for a user or user and application authentication, then an InvalidArgumentException is thrown.
◆ generateToken() [2/2]
|
virtual |
Generate a token to be used for authorization, using the specified userId and ipAddress. If the authentication mode is not MANUAL, if the userId or ipAddress are not valid or if there's a problem obtaining the authentication information based on the authentication options in SessionOptions, then an InvalidArgumentException is thrown.
◆ getAuthorizedIdentity()
| Identity getAuthorizedIdentity | ( | const CorrelationId & | correlationId = CorrelationId() | ) |
Returns the authorized Identity associated with correlationId
A NotFoundException is thrown if there is no Identity associated with correlationId, if the associated Identity is not authorized, or if correlationId is not given and the session Identity is not authorized.
◆ getService()
|
virtual |
Return a Service object representing the service identified by the specified serviceIdentifier
The serviceIdentifier must contain a fully qualified service name. That is, it must be of the form //<namespace>/<local-name>.
If the service identified by serviceIdentifier is not open or registered already then a NotFoundException is thrown.
◆ nextEvent()
|
pure virtual |
Return the next available Event for this session. If there is no event available this will block for up to the specified timeout in milliseconds for an Event to arrive. A value of 0 for timeout (the default) indicates nextEvent() should not timeout and will not return until the next Event is available.
If nextEvent() returns due to a timeout it will return an event of type EventType::TIMEOUT.
If this is invoked on a Session which was created in asynchronous mode an InvalidStateException is thrown.
Implemented in ProviderSession, and Session.
◆ openService()
|
virtual |
Attempt to open the service identified by the specified serviceIdentifier and block until the service is either opened successfully or has failed to be opened. Return true if the service is opened successfully and false if the service cannot be successfully opened.
The serviceIdentifier must contain a fully qualified service name. That is, it must be of the form //<namespace>/<local-name>.
Before openService() returns a SERVICE_STATUS Event is generated. If this is an asynchronous Session then this Event may be processed by the registered EventHandler before openService() has returned.
◆ openServiceAsync()
|
virtual |
Begin the process to open the service identified by the specified serviceIdentifier and return immediately. The optional specified correlationId is used to track Events generated as a result of this call. The actual correlationId which will identify Events generated as a result of this call is returned.
The serviceIdentifier must contain a fully qualified service name. That is, it must be of the form //<namespace>/<local-name>.
The application must monitor events for a SERVICE_STATUS Event which will be generated once the service has been successfully opened or the opening has failed.
◆ sendAuthorizationRequest()
|
virtual |
Send the specified authorizationRequest and update the specified identity with the results. If the optionally specified correlationId is supplied, it is used; otherwise create a CorrelationId. The actual CorrelationId used is returned. If the optionally specified eventQueue is supplied all Events relating to this Request will arrive on that EventQueue.
A successful request will generate zero or more PARTIAL_RESPONSE Messages followed by exactly one RESPONSE Message. Once the final RESPONSE Message has been received the specified identity will have been updated to contain the users entitlement information and the CorrelationId associated with the request may be re-used. If the request fails at any stage a REQUEST_STATUS will be generated, the specified identity will not be modified and the CorrelationId may be re-used.
The identity supplied must have been returned from this Session's createIdentity() method. For example
◆ sessionName()
| std::string sessionName | ( | ) |
Returns the session name.
◆ start()
|
pure virtual |
Attempt to start this Session and blocks until the Session has started or failed to start. If the Session is started successfully true is returned, otherwise false is returned. Before start() returns a SESSION_STATUS Event is generated. If this is an asynchronous Session then the SESSION_STATUS may be processed by the registered EventHandler before start() has returned. A Session may only be started once.
Implemented in ProviderSession, and Session.
◆ startAsync()
|
pure virtual |
Attempt to begin the process to start this Session and return true if successful, otherwise return false. The application must monitor events for a SESSION_STATUS Event which will be generated once the Session has started or if it fails to start. If this is an asynchronous Session then the SESSION_STATUS Event may be processed by the registered EventHandler before startAsync() has returned. A Session may only be started once.
Implemented in ProviderSession, and Session.
◆ stop()
|
pure virtual |
Stop operation of this session and block until all callbacks to EventHandler objects relating to this Session which are currently in progress have completed (including the callback to handle the SESSION_STATUS Event with SessionTerminated message this call generates). Once this returns no further callbacks to EventHandlers will occur. If stop() is called from within an EventHandler callback the behavior is undefined and may result in a deadlock. Once a Session has been stopped it can only be destroyed.
Implemented in ProviderSession, and Session.
◆ stopAsync()
|
pure virtual |
Begin the process to stop this Session and return immediately. The application must monitor events for a SESSION_STATUS Event with SessionTerminated message which will be generated once the Session has been stopped. After this SESSION_STATUS Event no further callbacks to EventHandlers will occur. This method can be called from within an EventHandler callback to stop Sessions using non-default (external) EventDispatcher. Once a Session has been stopped it can only be destroyed.
Implemented in ProviderSession, and Session.
◆ tryNextEvent()
|
pure virtual |
If there are Events available for the session, load the next Event into event and return 0 indicating success. If there is no event available for the session, return a non-zero value with no effect on event. This method never blocks.
Implemented in ProviderSession, and Session.
The documentation for this class was generated from the following file:
