swarmio::services::event::Handler Class Reference

Abstract base class for Event handlers. More...

#include <Handler.h>

Inheritance diagram for swarmio::services::event::Handler:

Public Member Functions
virtual data::discovery::Schema	DescribeEvent (const std::string &name)=0
	Handlers may add parameter descriptors to the event descriptor when asked to do so by overriding this method. More...
virtual void	EventWasTriggered (const Node *node, const data::event::Notification &event)=0
	Handlers are notified using this method when an event has been triggered. More...

Detailed Description

Abstract base class for Event handlers.

Definition at line 13 of file Handler.h.

Member Function Documentation

virtual data::discovery::Schema swarmio::services::event::Handler::DescribeEvent ( const std::string &  name )

pure virtual

Handlers may add parameter descriptors to the event descriptor when asked to do so by overriding this method.

Parameters

name	Event name

Returns

data::discovery::Schema

Implemented in swarmio::simulator::FauxEventHandler, and swarmros::bridge::EventPublisher.

virtual void swarmio::services::event::Handler::EventWasTriggered ( const Node *  node, const data::event::Notification &  event  )

pure virtual

Handlers are notified using this method when an event has been triggered.

Parameters

node	Source node
event	Event

Implemented in swarmio::simulator::FauxEventHandler.

---

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

• Handler.h