Public Member Functions | Private Types | Private Attributes | List of all members
RTC::PortConnectListenerHolder Class Reference

PortConnectListener holder class. More...

#include <PortConnectListener.h>

Public Member Functions

void addListener (PortConnectListener *listener, bool autoclean)
 Add the listener. More...
 
void notify (const char *portname, RTC::ConnectorProfile &profile)
 Notify listeners. More...
 
 PortConnectListenerHolder ()
 Constructor. More...
 
void removeListener (PortConnectListener *listener)
 Remove the listener. More...
 
virtual ~PortConnectListenerHolder ()
 Destructor. More...
 

Private Types

typedef std::pair< PortConnectListener *, bool > Entry
 
typedef coil::Guard< coil::MutexGuard
 

Private Attributes

std::vector< Entrym_listeners
 
coil::Mutex m_mutex
 

Detailed Description

PortConnectListener holder class.

This class manages one ore more instances of PortConnectListener class.

Definition at line 276 of file PortConnectListener.h.

Member Typedef Documentation

◆ Entry

Definition at line 278 of file PortConnectListener.h.

◆ Guard

Definition at line 279 of file PortConnectListener.h.

Constructor & Destructor Documentation

◆ PortConnectListenerHolder()

RTC::PortConnectListenerHolder::PortConnectListenerHolder ( )

Constructor.

Definition at line 97 of file PortConnectListener.cpp.

◆ ~PortConnectListenerHolder()

RTC::PortConnectListenerHolder::~PortConnectListenerHolder ( )
virtual

Destructor.

Definition at line 102 of file PortConnectListener.cpp.

Member Function Documentation

◆ addListener()

void RTC::PortConnectListenerHolder::addListener ( PortConnectListener listener,
bool  autoclean 
)

Add the listener.

This method adds the listener.

Parameters
listenerAdded listener
autocleantrue:The listener is deleted at the destructor., false:The listener is not deleted at the destructor.

Definition at line 115 of file PortConnectListener.cpp.

◆ notify()

void RTC::PortConnectListenerHolder::notify ( const char *  portname,
RTC::ConnectorProfile &  profile 
)

Notify listeners.

This calls the Callback method of the registered listener.

Parameters
infoConnectorInfo

Definition at line 144 of file PortConnectListener.cpp.

◆ removeListener()

void RTC::PortConnectListenerHolder::removeListener ( PortConnectListener listener)

Remove the listener.

This method removes the listener.

Parameters
listenerRemoved listener

Definition at line 123 of file PortConnectListener.cpp.

Member Data Documentation

◆ m_listeners

std::vector<Entry> RTC::PortConnectListenerHolder::m_listeners
private

Definition at line 361 of file PortConnectListener.h.

◆ m_mutex

coil::Mutex RTC::PortConnectListenerHolder::m_mutex
private

Definition at line 362 of file PortConnectListener.h.


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


openrtm_aist
Author(s): Noriaki Ando
autogenerated on Mon Feb 28 2022 23:00:48