active::event::Participant Class Reference

#include <Participant.h>

Inheritance diagram for active::event::Participant:

Collaboration diagram for active::event::Participant:

Public Member Functions
	Participant (const utility::NameID &identity=utility::NameID{})
virtual	~Participant ()=default
bool	operator== (const Participant &ref) const
bool	operator!= (const Participant &ref) const
Public Member Functions inherited from active::utility::NameID
	NameID ()
	NameID (const String &str, const Guid &guid=Guid{})
	NameID (const char *str, const Guid &guid=Guid{})
	NameID (const Guid &guid, const String &str=String{})
bool	operator== (const NameID &ref) const
bool	operator!= (const NameID &ref) const
bool	operator< (const NameID &ref) const
	operator bool () const
void	clear ()

Protected Member Functions
virtual bool	audit ()
virtual bool	attach ()
virtual bool	start ()
virtual void	stop ()

Additional Inherited Members
Public Types inherited from active::utility::NameID
using	Option = std::optional<NameID>
	Optional.
Public Attributes inherited from active::utility::NameID
String	name
Guid	id

Detailed Description

A base class for any object participating in Event management (publishing or subscribing)

Participants are asked to fullfil several tasks:

• Audit their environment to ensure normal function
• Attach any components relevant to the app, e.g. UI additions
• Initialise, e.g. allocate resources
• Shutdown (release resources etc)

Constructor & Destructor Documentation

Participant()

active::event::Participant::Participant ( const utility::NameID & identity = utility::NameID{} )

inline

Default constructor

Parameters

identity

Optional name/ID for the participant

~Participant()

virtual active::event::Participant::~Participant ( )

virtualdefault

Destructor

Member Function Documentation

attach()

virtual bool active::event::Participant::attach ( )

inlineprotectedvirtual

Attach participant components to the app (as required)

Returns

True if the participant is able to function

Reimplemented in active::event::Publisher.

audit()

virtual bool active::event::Participant::audit ( )

inlineprotectedvirtual

Audit the participant environment to ensure it can function

Returns

True if the participant is able to function

Reimplemented in active::event::Publisher.

operator!=()

bool active::event::Participant::operator!= ( const Participant & ref ) const

inline

Inequality operator

Parameters

ref	The object to compare with this

Returns

True if ref is not equal to this

operator==()

bool active::event::Participant::operator== ( const Participant & ref ) const

inline

Equality operator

Parameters

ref	The object to compare with this

Returns

True if ref is equal to this

Here is the caller graph for this function:

start()

virtual bool active::event::Participant::start ( )

inlineprotectedvirtual

Start the participant operation

Returns

True if the participant is able to continue

Reimplemented in active::event::Publisher.

stop()

virtual void active::event::Participant::stop ( )

inlineprotectedvirtual

Stop participation (release resources etc)

Reimplemented in active::event::Publisher.

---

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

• /Users/rwessel/Documents/Development/ActiveLib/Active/Event/Participant.h