ns3::TracedCallback< Ts > Class Template Reference

Forward calls to a chain of Callback. More...

#include "traced-callback.h"

Collaboration diagram for ns3::TracedCallback< Ts >:

Public Types
typedef void(*	Uint32Callback) (const uint32_t value)
	TracedCallback signature for POD. More...

Public Member Functions
	TracedCallback ()
	Constructor. More...
void	Connect (const CallbackBase &callback, std::string path)
	Append a Callback to the chain with a context. More...
void	ConnectWithoutContext (const CallbackBase &callback)
	Append a Callback to the chain (without a context). More...
void	Disconnect (const CallbackBase &callback, std::string path)
	Remove from the chain a Callback which was connected with a context. More...
void	DisconnectWithoutContext (const CallbackBase &callback)
	Remove from the chain a Callback which was connected without a context. More...
bool	IsEmpty () const
	Checks if the Callbacks list is empty. More...
void	operator() (Ts... args) const
	Functor which invokes the chain of Callbacks. More...

Private Types
typedef std::list< Callback< void, Ts... > >	CallbackList
	Container type for holding the chain of Callbacks. More...

Private Attributes
CallbackList	m_callbackList
	The chain of Callbacks. More...

Detailed Description

template<typename... Ts>
class ns3::TracedCallback< Ts >

Forward calls to a chain of Callback.

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

This is a functor: the chain of Callbacks is invoked by calling the operator() form with the appropriate number of arguments.

Template Parameters

Ts	[explicit] Types of the functor arguments.

Definition at line 53 of file traced-callback.h.

Member Typedef Documentation

CallbackList

template<typename... Ts>

typedef std::list<Callback<void, Ts...> > ns3::TracedCallback< Ts >::CallbackList

private

Container type for holding the chain of Callbacks.

Template Parameters

Ts	[deduced] Types of the functor arguments.

Definition at line 116 of file traced-callback.h.

Uint32Callback

template<typename... Ts>

typedef void(* ns3::TracedCallback< Ts >::Uint32Callback) (const uint32_t value)

TracedCallback signature for POD.

Parameters

[in]

value

Value of the traced variable.

Definition at line 107 of file traced-callback.h.

Constructor & Destructor Documentation

TracedCallback()

template<typename... Ts>

ns3::TracedCallback< Ts >::TracedCallback

Constructor.

Definition at line 131 of file traced-callback.h.

Member Function Documentation

Connect()

template<typename... Ts>

void ns3::TracedCallback< Ts >::Connect	(	const CallbackBase &	callback,
		std::string	path
	)

Append a Callback to the chain with a context.

The context string will be provided as the first argument to the Callback.

Parameters

[in]	callback	Callback to add to chain.
[in]	path	Context string to provide when invoking the Callback.

Definition at line 150 of file traced-callback.h.

References ns3::Callback< R, UArgs >::Bind(), and NS_FATAL_ERROR.

Referenced by ns3::TracedValue< T >::Connect().

Here is the call graph for this function:

Here is the caller graph for this function:

ConnectWithoutContext()

template<typename... Ts>

void ns3::TracedCallback< Ts >::ConnectWithoutContext

(

const CallbackBase &

callback

)

Append a Callback to the chain (without a context).

Parameters

[in]

callback

Callback to add to chain.

Definition at line 138 of file traced-callback.h.

References NS_FATAL_ERROR_NO_MSG.

Referenced by ns3::CsmaNetDevice::AddLinkChangeCallback(), ns3::FdNetDevice::AddLinkChangeCallback(), ns3::LrWpanNetDevice::AddLinkChangeCallback(), ns3::LteNetDevice::AddLinkChangeCallback(), ns3::SimpleNetDevice::AddLinkChangeCallback(), ns3::PointToPointNetDevice::AddLinkChangeCallback(), ns3::MockNetDevice::AddLinkChangeCallback(), ns3::AlohaNoackNetDevice::AddLinkChangeCallback(), ns3::TapBridge::AddLinkChangeCallback(), ns3::UanNetDevice::AddLinkChangeCallback(), ns3::WifiNetDevice::AddLinkChangeCallback(), and ns3::TracedValue< T >::ConnectWithoutContext().

Here is the caller graph for this function:

Disconnect()

template<typename... Ts>

void ns3::TracedCallback< Ts >::Disconnect	(	const CallbackBase &	callback,
		std::string	path
	)

Remove from the chain a Callback which was connected with a context.

Parameters

[in]	callback	Callback to remove from the chain.
[in]	path	Context path which was used to connect the Callback.

Definition at line 180 of file traced-callback.h.

References ns3::Callback< R, UArgs >::Bind(), ns3::Config::DisconnectWithoutContext(), and NS_FATAL_ERROR.

Referenced by ns3::TracedValue< T >::Disconnect().

Here is the call graph for this function:

Here is the caller graph for this function:

DisconnectWithoutContext()

template<typename... Ts>

void ns3::TracedCallback< Ts >::DisconnectWithoutContext

(

const CallbackBase &

callback

)

Remove from the chain a Callback which was connected without a context.

Parameters

[in]

callback

Callback to remove from the chain.

Definition at line 163 of file traced-callback.h.

Referenced by ns3::TracedValue< T >::DisconnectWithoutContext().

Here is the caller graph for this function:

IsEmpty()

template<typename... Ts>

bool ns3::TracedCallback< Ts >::IsEmpty

Checks if the Callbacks list is empty.

Returns

true if the Callbacks list is empty.

Definition at line 203 of file traced-callback.h.

Referenced by ns3::WifiPhy::NotifyRxEnd(), ns3::WifiPhy::NotifyTxDrop(), and ns3::WifiPhy::NotifyTxEnd().

Here is the caller graph for this function:

operator()()

template<typename... Ts>

void ns3::TracedCallback< Ts >::operator()

(

Ts...

args

)

const

Functor which invokes the chain of Callbacks.

Template Parameters

Ts	[deduced] Types of the functor arguments.

Parameters

[in]

args

The arguments to the functor

Definition at line 193 of file traced-callback.h.

References check-style-clang-format::args.

Member Data Documentation

m_callbackList

template<typename... Ts>

CallbackList ns3::TracedCallback< Ts >::m_callbackList

private

The chain of Callbacks.

Definition at line 118 of file traced-callback.h.

---

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

• src/core/model/traced-callback.h