RSB  0.19.0
Classes | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
rsb::Participant Class Referenceabstract

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
 
virtual std::string getKind () const =0
 Return the kind of the participant. More...
 
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...
 
virtual const std::set< std::string > getTransportURLs () const =0
 TODO. More...
 

Protected Member Functions

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

Private Member Functions

void setSignalParticipantDestroyed (SignalParticipantDestroyedPtr signal)
 

Private Attributes

boost::scoped_ptr< Impl > d
 

Friends

class Factory
 

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 65 of file Participant.h.

Constructor & Destructor Documentation

rsb::Participant::~Participant ( )
virtual

Definition at line 53 of file Participant.cpp.

References d.

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

Definition at line 45 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 68 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 60 of file Participant.cpp.

References d.

Referenced by rsb::introspection::IntrospectionSender::removeParticipant(), and rsb::InformerBase::uncheckedPublish().

Here is the caller graph for this function:

virtual std::string rsb::Participant::getKind ( ) const
pure virtual

Return the kind of the participant.

Examples include "informer", "listener" and "reader".

Returns
a string describing the kind of the participant.

Implemented in rsb::patterns::LocalServer<>, rsb::patterns::LocalServer<>::LocalMethod, rsb::patterns::RemoteServer, rsb::InformerBase, rsb::Listener, rsb::patterns::RemoteServer::RemoteMethod, and rsb::Reader.

ScopePtr rsb::Participant::getScope ( ) const

Returns the scope of this participant.

Returns
scope

Definition at line 64 of file Participant.cpp.

References d.

Referenced by rsb::patterns::RemoteServer::RemoteMethod::call(), rsb::InformerBase::checkedPublish(), rsb::InformerBase::createEvent(), rsb::patterns::RemoteServer::getMethod(), rsb::patterns::LocalServer<>::LocalMethod::handle(), rsb::patterns::Method::makeInformer(), rsb::patterns::Method::makeListener(), and rsb::patterns::LocalServer<>::registerMethod().

Here is the caller graph for this function:

virtual const std::set<std::string> rsb::Participant::getTransportURLs ( ) const
pure virtual

TODO.

Implemented in rsb::patterns::LocalServer<>, rsb::patterns::RemoteServer, rsb::InformerBase, rsb::Listener, rsb::Reader, and rsb::patterns::Method.

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

Definition at line 72 of file Participant.cpp.

References d.

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

Here is the caller graph for this function:

void rsb::Participant::setSignalParticipantDestroyed ( SignalParticipantDestroyedPtr  signal)
private

Definition at line 76 of file Participant.cpp.

References d.

Friends And Related Function Documentation

friend class Factory
friend

Definition at line 67 of file Participant.h.

Member Data Documentation

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

Definition at line 115 of file Participant.h.

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

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