makVrv::DtDisconnectable Class Reference

Functionality for disconnecting the various references that objects make to each other. More...

Inheritance diagram for makVrv::DtDisconnectable:

Public Member Functions
	DtDisconnectable ()
	Default constructor. More...
virtual	~DtDisconnectable ()
	Destructor. More...
virtual boost::signals2::connection	addDisconnectFunction (const boost::function< void()> &callback)
	Add a function to be called when callDisconnectFunctions is called. More...
virtual bool	callDisconnectFunctions ()
	Atomically call all the disconnect functions and mark this object as disconnected. More...

Protected Types
enum	State { NotUsed, InUse, Disconnected }
typedef tbb::spin_mutex	Mutex

Protected Attributes
Mutex	myMutex
State	myDisconnectedState
boost::signals2::signal< void()>	myDisconnectSignal

Detailed Description

Functionality for disconnecting the various references that objects make to each other.

This class is a wrapper around a boost::signal2 which guarantees that each attached function is run once and only once.

Member Typedef Documentation

typedef tbb::spin_mutex makVrv::DtDisconnectable::Mutex

protected

Member Enumeration Documentation

enum makVrv::DtDisconnectable::State

protected

Enumerator
NotUsed
InUse
Disconnected

Constructor & Destructor Documentation

makVrv::DtDisconnectable::DtDisconnectable

(

)

Default constructor.

virtual makVrv::DtDisconnectable::~DtDisconnectable ( )

virtual

Destructor.

callDisconnectFunctions is not called in the destructor, it is up to to the caller to call it when it is necessary.

Member Function Documentation

virtual boost::signals2::connection makVrv::DtDisconnectable::addDisconnectFunction ( const boost::function< void()> &  callback )

virtual

Add a function to be called when callDisconnectFunctions is called.

If it has already been called, then the callback will be called during this call.

virtual bool makVrv::DtDisconnectable::callDisconnectFunctions ( )

virtual

Atomically call all the disconnect functions and mark this object as disconnected.

If callDisconnectFunctions has already been called or is currently being called, this call will do nothing.

Member Data Documentation

Mutex makVrv::DtDisconnectable::myMutex

mutableprotected

State makVrv::DtDisconnectable::myDisconnectedState

protected

boost::signals2::signal<void ()> makVrv::DtDisconnectable::myDisconnectSignal

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvUtil/DtDisconnectable.h