zserio::IPubsub Class Reference

#include <IPubsub.h>

Classes
class	OnTopicCallback

Public Types
using	SubscriptionId = size_t

Public Member Functions
virtual	~IPubsub ()=default
virtual void	publish (std::string_view topic, Span< const uint8_t > data, void *context)=0
virtual SubscriptionId	subscribe (std::string_view topic, const std::shared_ptr< OnTopicCallback > &callback, void *context)=0
virtual void	unsubscribe (SubscriptionId id)=0

Detailed Description

Interface for Pub/Sub client backends.

Definition at line 14 of file IPubsub.h.

Member Typedef Documentation

SubscriptionId

using zserio::IPubsub::SubscriptionId = size_t

Subscription ID which is unique for each single subscription.

Definition at line 22 of file IPubsub.h.

Constructor & Destructor Documentation

~IPubsub()

virtual zserio::IPubsub::~IPubsub ( )

virtualdefault

Member Function Documentation

publish()

virtual void zserio::IPubsub::publish ( std::string_view  topic, Span< const uint8_t >  data, void *  context  )

pure virtual

Publishes given data as a specified topic.

Parameters

topic	Topic definition.
data	Data to publish.
context	Context specific for a particular Pub/Sub implementation.

Exceptions

PubsubException

when publishing fails.

subscribe()

virtual SubscriptionId zserio::IPubsub::subscribe ( std::string_view  topic, const std::shared_ptr< OnTopicCallback > &  callback, void *  context  )

pure virtual

Subscribes a topic.

Parameters

topic	Topic definition to subscribe. Note that the definition format depends on the particular Pub/Sub backend implementation and therefore e.g. wildcards can be used only if they are supported by Pub/Sub backend.
callback	Callback to be called when a message with the specified topic arrives.
context	Context specific for a particular Pub/Sub implementation.

Returns

Subscription ID.

Exceptions

PubsubException

when subscribing fails.

unsubscribe()

virtual void zserio::IPubsub::unsubscribe ( SubscriptionId  id )

pure virtual

Unsubscribes the subscription with the given ID.

Parameters

id	ID of the subscription to be unsubscribed.

Exceptions

PubsubException

when unsubscribing fails.

---

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

• zserio/IPubsub.h