SPSP
Simple publish-subscribe protocol. Connects low power IoT clients to MQTT.
All Classes Files Functions Variables Typedefs Enumerations
Public Types | Public Member Functions | Protected Member Functions | List of all members
SPSP::Nodes::DummyLocalNode< TLocalLayer > Class Template Reference

Dummy local node for testing. More...

#include <nodes_dummy.hpp>

Inheritance diagram for SPSP::Nodes::DummyLocalNode< TLocalLayer >:
Inheritance graph
[legend]
Collaboration diagram for SPSP::Nodes::DummyLocalNode< TLocalLayer >:
Collaboration graph
[legend]

Public Types

using LocalAddrT = typename TLocalLayer::LocalAddrT
 
using LocalMessageT = typename TLocalLayer::LocalMessageT
 

Public Member Functions

virtual bool publish (const std::string &topic, const std::string &payload)
 
virtual bool subscribe (const std::string &topic, SubscribeCb cb)
 
virtual bool unsubscribe (const std::string &topic)
 
virtual void resubscribeAll ()
 
- Public Member Functions inherited from SPSP::ILocalNode< TLocalLayer >
 ILocalNode (TLocalLayer *ll)
 Constructs a new node. More...
 
void receiveLocal (const LocalMessageT &msg, int rssi=NODE_RSSI_UNKNOWN)
 Receives the message from local layer. More...
 
void setLocalRecvSendCb (LocalRecvSendCb cb)
 Sets local receive/send callback function. More...
 

Protected Member Functions

virtual bool processProbeReq (const LocalMessageT &req, int rssi=NODE_RSSI_UNKNOWN)
 Processes PROBE_REQ message. More...
 
virtual bool processProbeRes (const LocalMessageT &req, int rssi=NODE_RSSI_UNKNOWN)
 Processes PROBE_RES message. More...
 
virtual bool processPub (const LocalMessageT &req, int rssi=NODE_RSSI_UNKNOWN)
 Processes PUB message. More...
 
virtual bool processSubReq (const LocalMessageT &req, int rssi=NODE_RSSI_UNKNOWN)
 Processes SUB_REQ message. More...
 
virtual bool processSubData (const LocalMessageT &req, int rssi=NODE_RSSI_UNKNOWN)
 Processes SUB_DATA message. More...
 
virtual bool processUnsub (const LocalMessageT &req, int rssi=NODE_RSSI_UNKNOWN)
 Processes UNSUB message. More...
 
virtual bool processTimeReq (const LocalMessageT &req, int rssi=NODE_RSSI_UNKNOWN)
 Processes TIME_REQ message. More...
 
virtual bool processTimeRes (const LocalMessageT &req, int rssi=NODE_RSSI_UNKNOWN)
 Processes TIME_RES message. More...
 
- Protected Member Functions inherited from SPSP::ILocalNode< TLocalLayer >
TLocalLayer * getLocalLayer () const
 Gets the far layer object. More...
 
bool sendLocal (const LocalMessageT &msg)
 Sends the message to local layer. More...
 
void publishRssi (const LocalAddrT &addr, int rssi)
 Publishes RSSI of received message from addr More...
 

Detailed Description

template<typename TLocalLayer>
class SPSP::Nodes::DummyLocalNode< TLocalLayer >

Dummy local node for testing.

Template Parameters
TLocalLayerType of local layer

Definition at line 22 of file nodes_dummy.hpp.

Member Function Documentation

◆ processProbeReq()

template<typename TLocalLayer >
virtual bool SPSP::Nodes::DummyLocalNode< TLocalLayer >::processProbeReq ( const LocalMessageT &  req,
int  rssi = NODE_RSSI_UNKNOWN 
)
inlineprotectedvirtual

Processes PROBE_REQ message.

Parameters
reqRequest message
rssiReceived signal strength indicator (in dBm)
Returns
true Message delivery successful
false Message delivery failed

Implements SPSP::ILocalNode< TLocalLayer >.

Definition at line 40 of file nodes_dummy.hpp.

◆ processProbeRes()

template<typename TLocalLayer >
virtual bool SPSP::Nodes::DummyLocalNode< TLocalLayer >::processProbeRes ( const LocalMessageT &  req,
int  rssi = NODE_RSSI_UNKNOWN 
)
inlineprotectedvirtual

Processes PROBE_RES message.

Parameters
reqRequest message
rssiReceived signal strength indicator (in dBm)
Returns
true Message delivery successful
false Message delivery failed

Implements SPSP::ILocalNode< TLocalLayer >.

Definition at line 43 of file nodes_dummy.hpp.

◆ processPub()

template<typename TLocalLayer >
virtual bool SPSP::Nodes::DummyLocalNode< TLocalLayer >::processPub ( const LocalMessageT &  req,
int  rssi = NODE_RSSI_UNKNOWN 
)
inlineprotectedvirtual

Processes PUB message.

Parameters
reqRequest message
rssiReceived signal strength indicator (in dBm)
Returns
true Message delivery successful
false Message delivery failed

Implements SPSP::ILocalNode< TLocalLayer >.

Definition at line 46 of file nodes_dummy.hpp.

◆ processSubData()

template<typename TLocalLayer >
virtual bool SPSP::Nodes::DummyLocalNode< TLocalLayer >::processSubData ( const LocalMessageT &  req,
int  rssi = NODE_RSSI_UNKNOWN 
)
inlineprotectedvirtual

Processes SUB_DATA message.

Parameters
reqRequest message
rssiReceived signal strength indicator (in dBm)
Returns
true Message delivery successful
false Message delivery failed

Implements SPSP::ILocalNode< TLocalLayer >.

Definition at line 52 of file nodes_dummy.hpp.

◆ processSubReq()

template<typename TLocalLayer >
virtual bool SPSP::Nodes::DummyLocalNode< TLocalLayer >::processSubReq ( const LocalMessageT &  req,
int  rssi = NODE_RSSI_UNKNOWN 
)
inlineprotectedvirtual

Processes SUB_REQ message.

Parameters
reqRequest message
rssiReceived signal strength indicator (in dBm)
Returns
true Message delivery successful
false Message delivery failed

Implements SPSP::ILocalNode< TLocalLayer >.

Definition at line 49 of file nodes_dummy.hpp.

◆ processTimeReq()

template<typename TLocalLayer >
virtual bool SPSP::Nodes::DummyLocalNode< TLocalLayer >::processTimeReq ( const LocalMessageT &  req,
int  rssi = NODE_RSSI_UNKNOWN 
)
inlineprotectedvirtual

Processes TIME_REQ message.

Parameters
reqRequest message
rssiReceived signal strength indicator (in dBm)
Returns
true Message delivery successful
false Message delivery failed

Implements SPSP::ILocalNode< TLocalLayer >.

Definition at line 58 of file nodes_dummy.hpp.

◆ processTimeRes()

template<typename TLocalLayer >
virtual bool SPSP::Nodes::DummyLocalNode< TLocalLayer >::processTimeRes ( const LocalMessageT &  req,
int  rssi = NODE_RSSI_UNKNOWN 
)
inlineprotectedvirtual

Processes TIME_RES message.

Parameters
reqRequest message
rssiReceived signal strength indicator (in dBm)
Returns
true Message delivery successful
false Message delivery failed

Implements SPSP::ILocalNode< TLocalLayer >.

Definition at line 61 of file nodes_dummy.hpp.

◆ processUnsub()

template<typename TLocalLayer >
virtual bool SPSP::Nodes::DummyLocalNode< TLocalLayer >::processUnsub ( const LocalMessageT &  req,
int  rssi = NODE_RSSI_UNKNOWN 
)
inlineprotectedvirtual

Processes UNSUB message.

Parameters
reqRequest message
rssiReceived signal strength indicator (in dBm)
Returns
true Message delivery successful
false Message delivery failed

Implements SPSP::ILocalNode< TLocalLayer >.

Definition at line 55 of file nodes_dummy.hpp.


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