RSB  0.9.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
rsb::Participant Class Reference

Objects of this class participate in the exchange of notifications on one channel of the bus. More...

#include <Participant.h>

Inheritance diagram for rsb::Participant:
Inheritance graph
Collaboration diagram for rsb::Participant:
Collaboration graph

Classes

class  Impl
 

Public Member Functions

virtual ~Participant ()
 
void printContents (std::ostream &stream) const
 
rsc::misc::UUID getId () const
 Returns the unique id of the participant. More...
 
ScopePtr getScope () const
 Returns the scope of this participant. More...
 
ParticipantConfig getConfig () const
 Returns a copy of the participant's configuration. More...
 

Protected Member Functions

 Participant (const Scope &scope, const ParticipantConfig &config)
 

Private Attributes

boost::scoped_ptr< Impld
 

Detailed Description

Objects of this class participate in the exchange of notifications on one channel of the bus.

Since each channel is identified by scope, each rsb::Participant has an associated scope. On the other hand, scopes do not uniquely identify rsb::Participant s since zero, one or more of these can participate in the exchange of any given scope. For this reason, each rsb::Participant has a unique id.

Author
jmoringe

Definition at line 57 of file Participant.h.

Constructor & Destructor Documentation

rsb::Participant::~Participant ( )
virtual

Definition at line 49 of file Participant.cpp.

rsb::Participant::Participant ( const Scope scope,
const ParticipantConfig config 
)
protected

Definition at line 43 of file Participant.cpp.

References d.

Member Function Documentation

ParticipantConfig rsb::Participant::getConfig ( ) const

Returns a copy of the participant's configuration.

Returns
copy of this participant's config

Definition at line 60 of file Participant.cpp.

References d.

Referenced by rsb::Listener::initialize().

Here is the caller graph for this function:

rsc::misc::UUID rsb::Participant::getId ( ) const

Returns the unique id of the participant.

Returns
unique id

Definition at line 52 of file Participant.cpp.

References d.

Referenced by rsb::InformerBase::uncheckedPublish().

Here is the caller graph for this function:

ScopePtr rsb::Participant::getScope ( ) const

Returns the scope of this participant.

Returns
scope

Definition at line 56 of file Participant.cpp.

References d.

Referenced by rsb::LocalService::addParticipant(), rsb::patterns::RemoteServer::callAsync(), rsb::InformerBase::checkedPublish(), and rsb::InformerBase::createEvent().

Here is the caller graph for this function:

void rsb::Participant::printContents ( std::ostream &  stream) const

Definition at line 64 of file Participant.cpp.

References d.

Referenced by rsb::Service::printContents(), and rsb::InformerBase::printContents().

Here is the caller graph for this function:

Member Data Documentation

boost::scoped_ptr<Impl> rsb::Participant::d
private

Definition at line 92 of file Participant.h.

Referenced by getConfig(), getId(), getScope(), Participant(), and printContents().


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