swarmio::profiles::Profile Class Reference

Base class for profiles. More...

#include <Profile.h>

Inheritance diagram for swarmio::profiles::Profile:

Public Member Functions
swarmio::services::discovery::Service &	GetDiscoveryService ()
	Get a reference for the Discovery service. More...
swarmio::services::ping::Service &	GetPingService ()
	Get a reference for the Ping service. More...
swarmio::services::telemetry::Service &	GetTelemetryService ()
	Get a reference for the Telemetry service. More...
virtual	~Profile ()
	Destroy the Profile object. More...
Public Member Functions inherited from swarmio::Mailbox
virtual void	Disconnect ()
	Disconnect this Mailbox from the Endpoint. More...
Endpoint *	GetEndpoint ()
	Get the associated Endpoint. More...
	Mailbox (const Mailbox &)=delete
	Remove copy constructor. More...
virtual void	MailboxWasConnected () noexcept
	Called when the mailbox is attached to an already running endpoint or if the attached endpoint has just started. More...
virtual void	MailboxWillBeDisconnected () noexcept
	Called right before the mailbox is disconnected from its endpoint or if the attached endpoint is about to stop. More...
virtual void	NodeDidJoin (const Node *node) noexcept
	Called when a new Node has joined the group. More...
virtual void	NodeWasDiscovered (const Node *node) noexcept
	Called when a new Node has been discovered. More...
virtual void	NodeWillLeave (const Node *node) noexcept
	Called when a Node signals that it will leave. More...
Mailbox &	operator= (const Mailbox &)=delete
	Remove assignment operator. More...
virtual bool	ReceiveMessage (const Node *sender, const data::Message *message)
	Delivery point of all messages. More...
virtual	~Mailbox ()
	Destroy the Mailbox object. More...

Protected Member Functions
	Profile (Endpoint *endpoint, bool performActiveDiscovery)
	Construct a new Profile. More...
Protected Member Functions inherited from swarmio::Mailbox
void	FinishConstruction ()
	Called when the last constructor has finished its job. More...
void	FinishMovingTo (Mailbox *other)
	Called when message handling should be passed onto the new instance. More...
	Mailbox ()
	Construct a disconnected Mailbox. More...
	Mailbox (Endpoint *endpoint)
	Construct a new Mailbox object. More...
	Mailbox (Mailbox &&other)
	Move a Mailbox object. More...

Protected Attributes
swarmio::services::discovery::Service	_discoveryService
	Discovery service. More...
swarmio::services::ping::Service	_pingService
	Ping service. More...
swarmio::services::telemetry::Service	_telemetryService
	Telemetry service. More...

Detailed Description

Base class for profiles.

Definition at line 16 of file Profile.h.

Constructor & Destructor Documentation

swarmio::profiles::Profile::Profile ( Endpoint *  endpoint, bool  performActiveDiscovery  )

inlineprotected

Construct a new Profile.

Parameters

endpoint	Endpoint to use
performActiveDiscovery	Enable active discovery for the Discovery service

Definition at line 45 of file Profile.h.

virtual swarmio::profiles::Profile::~Profile ( )

inlinevirtual

Destroy the Profile object.

Definition at line 90 of file Profile.h.

Member Function Documentation

swarmio::services::discovery::Service& swarmio::profiles::Profile::GetDiscoveryService ( )

inline

Get a reference for the Discovery service.

Returns

swarmio::services::discovery::Service&

Definition at line 61 of file Profile.h.

swarmio::services::ping::Service& swarmio::profiles::Profile::GetPingService ( )

inline

Get a reference for the Ping service.

Returns

swarmio::services::ping::Service&

Definition at line 71 of file Profile.h.

swarmio::services::telemetry::Service& swarmio::profiles::Profile::GetTelemetryService ( )

inline

Get a reference for the Telemetry service.

Returns

swarmio::services::telemetry::Service&

Definition at line 81 of file Profile.h.

Member Data Documentation

swarmio::services::discovery::Service swarmio::profiles::Profile::_discoveryService

protected

Discovery service.

Definition at line 24 of file Profile.h.

swarmio::services::ping::Service swarmio::profiles::Profile::_pingService

protected

Ping service.

Definition at line 30 of file Profile.h.

swarmio::services::telemetry::Service swarmio::profiles::Profile::_telemetryService

protected

Telemetry service.

Definition at line 36 of file Profile.h.

---

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

• Profile.h