BLPAPI C++  3.23.2
Topic Class Reference

#include <blpapi_topic.h>

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.

See Component blpapi_topic

Constructor & Destructor Documentation

◆ Topic() [1/3]

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.

◆ Topic() [2/3]

Topic ( blpapi_Topic_t handle)
explicit

Create a Topic object from a handle (main constructor)

◆ Topic() [3/3]

Topic ( const Topic original)

Create a copy of the specified original Topic.

◆ ~Topic()

~Topic ( )

Destroy this Topic object.

Member Function Documentation

◆ impl() [1/2]

const blpapi_Topic_t * impl ( ) const

◆ impl() [2/2]

blpapi_Topic_t * impl ( )

◆ isActive()

bool isActive ( ) const

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

◆ isValid()

bool isValid ( ) const

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

◆ operator=()

Topic & operator= ( const Topic rhs)

◆ service()

Service service ( ) const

Returns the service for which this topic was created.


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