Class CSubscriber

Class Documentation

class CSubscriber

eCAL subscriber class.

Public Functions

ECAL_API_EXPORTED_MEMBER CSubscriber(const std::string &topic_name_, const SDataTypeInformation &data_type_info_ = SDataTypeInformation(), const Subscriber::Configuration &config_ = GetSubscriberConfiguration())

Constructor.

Parameters:

  • topic_name_ – Unique topic name.

  • data_type_info_ – Topic data type information (encoding, type, descriptor).

  • config_ – Optional configuration parameters.

ECAL_API_EXPORTED_MEMBER CSubscriber(const std::string &topic_name_, const SDataTypeInformation &data_type_info_, const SubEventCallbackT &event_callback_, const Subscriber::Configuration &config_ = GetSubscriberConfiguration())

Constructor with event callback registration.

Parameters:

  • topic_name_ – Unique topic name.

  • data_type_info_ – Topic data type information (encoding, type, descriptor).

  • event_callback_ – Callback for subscriber events.

  • config_ – Configuration parameters.

virtual ECAL_API_EXPORTED_MEMBER ~CSubscriber()

Destructor.

CSubscriber(const CSubscriber&) = delete

CSubscribers are non-copyable.

CSubscriber &operator=(const CSubscriber&) = delete

CSubscribers are non-copyable.

ECAL_API_EXPORTED_MEMBER CSubscriber(CSubscriber &&rhs) noexcept

CSubscribers are move-enabled.

ECAL_API_EXPORTED_MEMBER CSubscriber & operator= (CSubscriber &&rhs) noexcept

CSubscribers are move-enabled.

ECAL_API_EXPORTED_MEMBER bool SetReceiveCallback (ReceiveCallbackT callback_)

Set/overwrite callback function for incoming receives.

Parameters:

callback_ – The callback function to set.

Returns:

True if succeeded, false if not.

ECAL_API_EXPORTED_MEMBER bool RemoveReceiveCallback ()

Remove callback function for incoming receives.

Returns:

True if succeeded, false if not.

ECAL_API_EXPORTED_MEMBER size_t GetPublisherCount () const

Query the number of connected publishers.

Returns:

Number of publishers.

ECAL_API_EXPORTED_MEMBER const std::string & GetTopicName () const

Retrieve the topic name.

Returns:

The topic name.

ECAL_API_EXPORTED_MEMBER const STopicId & GetTopicId () const

Retrieve the topic id.

Returns:

The topic id.

ECAL_API_EXPORTED_MEMBER const SDataTypeInformation & GetDataTypeInformation () const

Retrieve the topic information.

Returns:

The topic information.