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

PortConnectRetListener holder class. More...

#include <PortConnectListener.h>

Public Member Functions

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

Private Types

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

Private Attributes

std::vector< Entrym_listeners
 
coil::Mutex m_mutex
 

Detailed Description

PortConnectRetListener holder class.

This class manages one ore more instances of PortConnectRetListener class.

Definition at line 382 of file PortConnectListener.h.

Member Typedef Documentation

◆ Entry

Definition at line 384 of file PortConnectListener.h.

◆ Guard

Definition at line 385 of file PortConnectListener.h.

Constructor & Destructor Documentation

◆ PortConnectRetListenerHolder()

RTC::PortConnectRetListenerHolder::PortConnectRetListenerHolder ( )

Constructor.

Definition at line 162 of file PortConnectListener.cpp.

◆ ~PortConnectRetListenerHolder()

RTC::PortConnectRetListenerHolder::~PortConnectRetListenerHolder ( )
virtual

Destructor.

Definition at line 167 of file PortConnectListener.cpp.

Member Function Documentation

◆ addListener()

void RTC::PortConnectRetListenerHolder::addListener ( PortConnectRetListener 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 181 of file PortConnectListener.cpp.

◆ notify()

void RTC::PortConnectRetListenerHolder::notify ( const char *  portname,
RTC::ConnectorProfile &  profile,
ReturnCode_t  ret 
)

Notify listeners.

This calls the Callback method of the registered listener.

Parameters
infoConnectorInfo
cdrdataData

Definition at line 209 of file PortConnectListener.cpp.

◆ removeListener()

void RTC::PortConnectRetListenerHolder::removeListener ( PortConnectRetListener listener)

Remove the listener.

This method removes the listener.

Parameters
listenerRemoved listener

Definition at line 189 of file PortConnectListener.cpp.

Member Data Documentation

◆ m_listeners

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

Definition at line 470 of file PortConnectListener.h.

◆ m_mutex

coil::Mutex RTC::PortConnectRetListenerHolder::m_mutex
private

Definition at line 471 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