Public Member Functions

blpapi::Topic Class Reference

#include <blpapi_topic.h>

List of all members.

Public Member Functions

 Topic ()
 Topic (blpapi_Topic_t *handle)
 Topic (const Topic &original)
 ~Topic ()
Topicoperator= (const Topic &rhs)
bool isValid () const
bool isActive () const
Service service () const
const blpapi_Topic_timpl () const
blpapi_Topic_timpl ()

Detailed Description

Used to identify the stream on which a message is published.

Topic objects are obtained from createTopic() on ProviderSession. They are used when adding a message to an Event for publishing using appendMessage() on EventFormatter.


Constructor & Destructor Documentation

blpapi::Topic::Topic (  ) 

Create a Topic object. A Topic created from the default constructor is not a valid topic and must be assigned to from a valid topic before it can be used.

blpapi::Topic::Topic ( blpapi_Topic_t handle  ) 

Create a Topic object from a handle (main constructor)

blpapi::Topic::Topic ( const Topic original  ) 

Create a copy of the specified original Topic.

blpapi::Topic::~Topic (  ) 

Destroy this Topic object.


Member Function Documentation

Topic& blpapi::Topic::operator= ( const Topic rhs  ) 
bool blpapi::Topic::isValid (  )  const

Returns true if this Topic is valid and can be used to publish a message on.

bool blpapi::Topic::isActive (  )  const

Returns true if this topic was elected by the platform to become the primary publisher.

Service blpapi::Topic::service (  )  const

Returns the service for which this topic was created.

const blpapi_Topic_t* blpapi::Topic::impl (  )  const
blpapi_Topic_t* blpapi::Topic::impl (  ) 

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