swarmio::Mailbox Class Reference

Abstract base class for Mailbox implementations. More...

#include <Mailbox.h>

Inheritance diagram for swarmio::Mailbox:

Public Member Functions
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
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...

Private Attributes
Endpoint *	_endpoint
	Associated endpoint. More...

Detailed Description

Abstract base class for Mailbox implementations.

Definition at line 13 of file Mailbox.h.

Constructor & Destructor Documentation

swarmio::Mailbox::Mailbox ( )

inlineprotected

Construct a disconnected Mailbox.

Definition at line 29 of file Mailbox.h.

swarmio::Mailbox::Mailbox ( Endpoint *  endpoint )

inlineprotected

Construct a new Mailbox object.

Parameters

endpoint

Endpoint

Definition at line 37 of file Mailbox.h.

swarmio::Mailbox::Mailbox ( Mailbox &&  other )

inlineprotected

Move a Mailbox object.

Definition at line 58 of file Mailbox.h.

swarmio::Mailbox::Mailbox ( const Mailbox &  )

delete

Remove copy constructor.

virtual swarmio::Mailbox::~Mailbox ( )

inlinevirtual

Destroy the Mailbox object.

Definition at line 165 of file Mailbox.h.

Member Function Documentation

virtual void swarmio::Mailbox::Disconnect ( )

inlinevirtual

Disconnect this Mailbox from the Endpoint.

Definition at line 153 of file Mailbox.h.

void swarmio::Mailbox::FinishConstruction ( )

inlineprotected

Called when the last constructor has finished its job.

Definition at line 46 of file Mailbox.h.

void swarmio::Mailbox::FinishMovingTo ( Mailbox *  other )

inlineprotected

Called when message handling should be passed onto the new instance.

Parameters

other

New Mailbox

Definition at line 70 of file Mailbox.h.

Endpoint* swarmio::Mailbox::GetEndpoint ( )

inline

Get the associated Endpoint.

Returns

Endpoint*

Definition at line 144 of file Mailbox.h.

virtual void swarmio::Mailbox::MailboxWasConnected ( )

inlinevirtualnoexcept

Called when the mailbox is attached to an already running endpoint or if the attached endpoint has just started.

Reimplemented in swarmio::services::PeriodicService.

Definition at line 130 of file Mailbox.h.

virtual void swarmio::Mailbox::MailboxWillBeDisconnected ( )

inlinevirtualnoexcept

Called right before the mailbox is disconnected from its endpoint or if the attached endpoint is about to stop.

Reimplemented in swarmio::services::telemetry::UpdateAwaiter, and swarmio::services::PeriodicService.

Definition at line 137 of file Mailbox.h.

virtual void swarmio::Mailbox::NodeDidJoin ( const Node *  node )

inlinevirtualnoexcept

Called when a new Node has joined the group.

Parameters

node	The node that has been discovered

Reimplemented in swarmio::services::discovery::Service, and swarmros::bridge::Node.

Definition at line 116 of file Mailbox.h.

virtual void swarmio::Mailbox::NodeWasDiscovered ( const Node *  node )

inlinevirtualnoexcept

Called when a new Node has been discovered.

Parameters

node	The node that has been discovered

Reimplemented in swarmros::bridge::Node, and swarmio::tool::Loop.

Definition at line 109 of file Mailbox.h.

virtual void swarmio::Mailbox::NodeWillLeave ( const Node *  node )

inlinevirtualnoexcept

Called when a Node signals that it will leave.

Parameters

node	The node that has left

Reimplemented in swarmio::services::discovery::Service, and swarmros::bridge::Node.

Definition at line 123 of file Mailbox.h.

Mailbox& swarmio::Mailbox::operator= ( const Mailbox &  )

delete

Remove assignment operator.

Returns

Awaiter&

virtual bool swarmio::Mailbox::ReceiveMessage ( const Node *  sender, const data::Message *  message  )

inlinevirtual

Delivery point of all messages.

Parameters

sender	The node that has sent the message
message	The message itself

Returns

True if the message had been processed and should not be forwarded to other mailboxes

Reimplemented in swarmio::services::telemetry::Service, swarmio::services::discovery::Service, swarmio::services::Awaiter< T >, swarmio::services::Awaiter< std::chrono::nanoseconds >, swarmio::services::Awaiter< data::discovery::Response >, swarmio::services::Awaiter< bool >, swarmio::services::Awaiter< data::Variant >, swarmio::services::Awaiter< data::telemetry::Update >, swarmio::services::keyvalue::Service, swarmio::simulator::ExampleDevice, swarmio::services::event::Service, and swarmio::services::ping::Service.

Definition at line 102 of file Mailbox.h.

Member Data Documentation

Endpoint* swarmio::Mailbox::_endpoint

private

Associated endpoint.

Definition at line 21 of file Mailbox.h.

---

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

• Mailbox.h