SignalHandler Class Reference

#include <SignalHandler.hpp>

Inherited by Component, EventHandler, NetworkThread, and ServerNetworkComm.

Public Types
typedef std::vector< SignalPtr >	storage_t
	storage type for signals More...

Public Member Functions
	~SignalHandler ()
const storage_t &	signal_list () const
SignalPtr	signal (const SignalID &sname)
SignalCPtr	signal (const SignalID &sname) const
SignalRet	call_signal (const SignalID &sname, SignalArgs &sinput)
	Calls the signal by providing its name and input. More...
SignalRet	call_signal (const SignalID &sname, std::vector< std::string > &sinput)
	Calls the signal by providing its name and input. More...
bool	signal_exists (const SignalID &sname) const
	Checks if a signal exists or not. More...
Signal &	regist_signal (const SignalID &sname)
	Regist signal. More...
void	unregist_signal (const SignalID &sname)
	Unregist signal. More...

Public Attributes
storage_t	m_signals
	storage of the signals More...

Detailed Description

SignalHandler executes calls received as string by issuing signals to the slots Slots may be:

• its own derived classes that regist member functions to be called dynamically
• other classes that regist themselves to be notified when a signal is issued

Author

Tiago Quintino

Definition at line 41 of file SignalHandler.hpp.

Member Typedef Documentation

typedef std::vector< SignalPtr > storage_t

storage type for signals

Definition at line 46 of file SignalHandler.hpp.

Constructor & Destructor Documentation

~SignalHandler

(

)

Definition at line 36 of file SignalHandler.cpp.

Member Function Documentation

SignalRet call_signal	(	const SignalID &	sname,
		SignalArgs &	sinput
	)

Calls the signal by providing its name and input.

Definition at line 49 of file SignalHandler.cpp.

SignalRet call_signal	(	const SignalID &	sname,
		std::vector< std::string > &	sinput
	)

Calls the signal by providing its name and input.

Definition at line 54 of file SignalHandler.cpp.

Signal & regist_signal

(

const SignalID &

sname

)

Regist signal.

Definition at line 90 of file SignalHandler.cpp.

SignalPtr signal

(

const SignalID &

sname

)

Access to signal by providing its name

Exceptions

SignalError

if signal with name does not exist

Definition at line 64 of file SignalHandler.cpp.

SignalCPtr signal

(

const SignalID &

sname

)

const

Const access to a signal by providing its name

Exceptions

SignalError

if signal with name does not exist

Definition at line 73 of file SignalHandler.cpp.

bool signal_exists

(

const SignalID &

sname

)

const

Checks if a signal exists or not.

Definition at line 83 of file SignalHandler.cpp.

const SignalHandler::storage_t & signal_list

(

)

const

Returns

the signals

Definition at line 44 of file SignalHandler.cpp.

void unregist_signal

(

const SignalID &

sname

)

Unregist signal.

Definition at line 114 of file SignalHandler.cpp.

Member Data Documentation

storage_t m_signals

storage of the signals

Definition at line 81 of file SignalHandler.hpp.

---

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

• cf3/common/SignalHandler.hpp
• cf3/common/SignalHandler.cpp