BLPAPI C++  3.24.11
Event Class Reference

#include <blpapi_event.h>

Classes

class  iterator
 

Public Types

enum  EventType {
  ADMIN = 1,
  SESSION_STATUS = 2,
  SUBSCRIPTION_STATUS = 3,
  REQUEST_STATUS = 4,
  RESPONSE = 5,
  PARTIAL_RESPONSE = 6,
  SUBSCRIPTION_DATA = 8,
  SERVICE_STATUS = 9,
  TIMEOUT = 10,
  AUTHORIZATION_STATUS = 11,
  RESOLUTION_STATUS = 12,
  TOPIC_STATUS = 13,
  TOKEN_STATUS = 14,
  REQUEST = 15,
  UNKNOWN = -1
}
 The possible types of event. More...
 

Public Member Functions

 Event ()
 
 Event (blpapi_Event_t *handle)
 
 Event (const Event &original)
 
 ~Event ()
 
Eventoperator= (const Event &rhs)
 
EventType eventType () const
 
bool isValid () const
 
blpapi_Event_timpl () const
 
iterator begin () const
 
iterator end () const
 

Detailed Description

A single event resulting from a subscription or a request.

Event objects are created by the API and passed to the application either through a registered EventHandler or EventQueue or returned from the Session::nextEvent() method. Event objects contain Message objects which can be accessed using a MessageIterator.

The Event object is a handle to an event. The event is the basic unit of work provided to applications. Each Event object consists of an EventType attribute and zero or more Message objects. The underlying event data including the messages is reference counted - as long as at least one Event object still exists then the underlying data will not be freed.

See Component blpapi_event

Member Enumeration Documentation

◆ EventType

enum EventType

The possible types of event.

Enumerator
ADMIN 

Admin event.

SESSION_STATUS 

Status updates for a session.

SUBSCRIPTION_STATUS 

Status updates for a subscription.

REQUEST_STATUS 

Status updates for a request.

RESPONSE 

The final (possibly only) response to a request.

PARTIAL_RESPONSE 

A partial response to a request.

SUBSCRIPTION_DATA 

Data updates resulting from a subscription.

SERVICE_STATUS 

Status updates for a service.

TIMEOUT 

An Event returned from Session::nextEvent() if it timed out.

AUTHORIZATION_STATUS 

Status updates for user authorization.

RESOLUTION_STATUS 

Status updates for a resolution operation.

TOPIC_STATUS 

Status updates about topics for service providers.

TOKEN_STATUS 

Status updates for a generate token request.

REQUEST 

Request event. Provided to ProviderSession only.

UNKNOWN 

Constructor & Destructor Documentation

◆ Event() [1/3]

Event ( )

Construct an uninitialized Event. The only valid operations on an uninitialized Event are assignment, isValid() and destruction.

◆ Event() [2/3]

Event ( blpapi_Event_t handle)

◆ Event() [3/3]

Event ( const Event original)

Copy constructor. This performs a shallow copy, increasing the reference count on the actual data underlying this handle.

◆ ~Event()

~Event ( )

Destructor. If this is the last reference to this Event then the underlying data and Iterators into the Event are invalidated, but Message objects remain valid.

Member Function Documentation

◆ begin()

Event::iterator begin ( ) const

◆ end()

Event::iterator end ( ) const

◆ eventType()

Event::EventType eventType ( ) const

Return the type of messages contained by this Event.

◆ impl()

blpapi_Event_t * impl ( ) const

◆ isValid()

bool isValid ( ) const

Return true if this Event is a valid event.

◆ operator=()

Event & operator= ( const Event rhs)

Assignment operator. This performs a shallow assignment, increasing the reference count on the actual data underlying this handle.


The documentation for this class was generated from the following file: