SPSP::FarLayers::MQTT::IAdapter Class Reference

Interface for platform-dependent MQTT adapter. More...

#include <mqtt_adapter_if.hpp>

Inheritance diagram for SPSP::FarLayers::MQTT::IAdapter:

Public Member Functions
virtual bool	publish (const std::string &topic, const std::string &payload)=0
	Publishes message coming from node. More...
virtual bool	subscribe (const std::string &topic)=0
	Subscribes to given topic. More...
virtual bool	unsubscribe (const std::string &topic)=0
	Unsubscribes from given topic. More...
virtual void	setSubDataCb (AdapterSubDataCb cb)=0
	Sets callback for incoming subscription data. More...
virtual void	setConnectedCb (AdapterConnectedCb cb)=0
	Sets connected callback. More...

Detailed Description

Interface for platform-dependent MQTT adapter.

Adapter doesn't have to check connection timeout.

Definition at line 37 of file mqtt_adapter_if.hpp.

Member Function Documentation

publish()

virtual bool SPSP::FarLayers::MQTT::IAdapter::publish ( const std::string &  topic, const std::string &  payload  )

pure virtual

Publishes message coming from node.

This should not block (publish is very time sensitive).

Parameters

topic	Topic
payload	Payload (data)

Returns

true Delivery successful

false Delivery failed

Implemented in SPSP::FarLayers::MQTT::Adapter, SPSP::FarLayers::MQTT::Adapter, and SPSP::FarLayers::MQTT::Adapter.

setConnectedCb()

virtual void SPSP::FarLayers::MQTT::IAdapter::setConnectedCb ( AdapterConnectedCb  cb )

pure virtual

Sets connected callback.

Should be called on successful connection and reconnection.

Parameters

cb

Callback

Implemented in SPSP::FarLayers::MQTT::Adapter, SPSP::FarLayers::MQTT::Adapter, and SPSP::FarLayers::MQTT::Adapter.

setSubDataCb()

virtual void SPSP::FarLayers::MQTT::IAdapter::setSubDataCb ( AdapterSubDataCb  cb )

pure virtual

Sets callback for incoming subscription data.

Parameters

cb

Callback

Implemented in SPSP::FarLayers::MQTT::Adapter, SPSP::FarLayers::MQTT::Adapter, and SPSP::FarLayers::MQTT::Adapter.

subscribe()

virtual bool SPSP::FarLayers::MQTT::IAdapter::subscribe ( const std::string &  topic )

pure virtual

Subscribes to given topic.

This should block (subscribe is usually not very time sensitive).

Parameters

topic

Topic

Returns

true Subscribe successful

false Subscribe failed

Implemented in SPSP::FarLayers::MQTT::Adapter, SPSP::FarLayers::MQTT::Adapter, and SPSP::FarLayers::MQTT::Adapter.

unsubscribe()

virtual bool SPSP::FarLayers::MQTT::IAdapter::unsubscribe ( const std::string &  topic )

pure virtual

Unsubscribes from given topic.

This should block (unsubscribe is usually not very time sensitive).

Parameters

topic

Topic

Returns

true Unsubscribe successful

false Unsubscribe failed

Implemented in SPSP::FarLayers::MQTT::Adapter, SPSP::FarLayers::MQTT::Adapter, and SPSP::FarLayers::MQTT::Adapter.

---

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

• mqtt_adapter_if.hpp