ns3::TracedCallback< T1, T2, T3, T4 > Class Template Reference [Tracing]

forward calls to a chain of CallbackAn ns3::TracedCallback has almost exactly the same API as a normal ns3::Callback but instead of forwarding calls to a single function (as an ns3::Callback normally does), it forwards calls to a chain of ns3::Callback. TracedCallback::Connect adds a ns3::Callback at the end of the chain of callbacks. TracedCallback::Disconnect removes a ns3::Callback from the chain of callbacks. More...

#include <traced-callback.h>

List of all members.

Public Member Functions
void	ConnectWithoutContext (const CallbackBase &callback)
void	Connect (const CallbackBase &callback, std::string path)
void	DisconnectWithoutContext (const CallbackBase &callback)
void	Disconnect (const CallbackBase &callback, std::string path)

---

Detailed Description

template<typename T1 = empty, typename T2 = empty, typename T3 = empty, typename T4 = empty>
class ns3::TracedCallback< T1, T2, T3, T4 >

forward calls to a chain of Callback

An ns3::TracedCallback has almost exactly the same API as a normal ns3::Callback but instead of forwarding calls to a single function (as an ns3::Callback normally does), it forwards calls to a chain of ns3::Callback. TracedCallback::Connect adds a ns3::Callback at the end of the chain of callbacks. TracedCallback::Disconnect removes a ns3::Callback from the chain of callbacks.

---

Member Function Documentation

template<typename T1 , typename T2 , typename T3 , typename T4 >

void ns3::TracedCallback< T1, T2, T3, T4 >::Connect	(	const CallbackBase &	callback,
		std::string	path
	)

Parameters:

	callback	callback to add to chain of callbacks
	path	the path to send back to the user callback.

Append the input callback to the end of the internal list of ns3::Callback. This method also will make sure that the input path specified by the user will be give back to the user's callback as its first argument.

template<typename T1 , typename T2 , typename T3 , typename T4 >

void ns3::TracedCallback< T1, T2, T3, T4 >::ConnectWithoutContext

(

const CallbackBase &

callback

)

Parameters:

callback

callback to add to chain of callbacks

Append the input callback to the end of the internal list of ns3::Callback.

template<typename T1 , typename T2 , typename T3 , typename T4 >

void ns3::TracedCallback< T1, T2, T3, T4 >::Disconnect	(	const CallbackBase &	callback,
		std::string	path
	)

Parameters:

	callback	callback to remove from the chain of callbacks.
	path	the path which is sent back to the user callback.

Remove the input callback which has a matching path as first argument from the internal list of ns3::Callback. This method is really the symmetric of the TracedCallback::Connect method.

References ns3::TracedCallback< T1, T2, T3, T4 >::DisconnectWithoutContext().

template<typename T1 , typename T2 , typename T3 , typename T4 >

void ns3::TracedCallback< T1, T2, T3, T4 >::DisconnectWithoutContext

(

const CallbackBase &

callback

)

Parameters:

callback

callback to remove from the chain of callbacks.

Remove the input callback from the internal list of ns3::Callback. This method is really the symmetric of the TracedCallback::ConnectWithoutContext method.

Referenced by ns3::TracedCallback< T1, T2, T3, T4 >::Disconnect().

---

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

• src/core/traced-callback.h