Detailed Description

This class provides simple critical sections functionality.

See also:: CCriticalSectionLocker

#include <mrpt/synch/CCriticalSection.h>

List of all members.

Public Member Functions

CCriticalSection (const char *name=NULL)

Constructor.

~CCriticalSection ()

Destructor.

void enter () const

Enter.

void leave () const

Leave

Exceptions:

If	the calling thread is not the current owener of the critical section.

std::string getName () const

Returns the name used in the constructor.

Public Attributes

utils::CStream * m_debugOut

If set to a non-NULL value, debug messages regarding the calling threads IDs will be output.

Private Attributes

utils::CReferencedMemBlock

m_data

The OS-dependent descriptors.

std::string

m_name

Constructor & Destructor Documentation

mrpt::synch::CCriticalSection::CCriticalSection ( const char * name = NULL )

Constructor.

mrpt::synch::CCriticalSection::~CCriticalSection ( )

Destructor.

Member Function Documentation

void mrpt::synch::CCriticalSection::enter ( ) const

Enter.

Exceptions:

If	the calling thread already possesses this critical section (it would be a dead-lock).

Referenced by mrpt::utils::CConsoleRedirector::overflow(), mrpt::utils::CConsoleRedirector::sync(), mrpt::synch::MT_buffer::clear(), mrpt::synch::MT_buffer::size(), mrpt::synch::MT_buffer::appendData(), mrpt::synch::MT_buffer::readAndClear(), and mrpt::synch::MT_buffer::read().

std::string mrpt::synch::CCriticalSection::getName ( ) const [inline]

Returns the name used in the constructor.

Definition at line 78 of file CCriticalSection.h.

void mrpt::synch::CCriticalSection::leave ( ) const

Leave

Exceptions:

If	the calling thread is not the current owener of the critical section.

Referenced by mrpt::utils::CConsoleRedirector::overflow(), mrpt::utils::CConsoleRedirector::sync(), mrpt::synch::MT_buffer::clear(), mrpt::synch::MT_buffer::size(), mrpt::synch::MT_buffer::appendData(), mrpt::synch::MT_buffer::readAndClear(), and mrpt::synch::MT_buffer::read().

Member Data Documentation

utils::CReferencedMemBlock mrpt::synch::CCriticalSection::m_data [private]

The OS-dependent descriptors.

Definition at line 55 of file CCriticalSection.h.

utils::CStream* mrpt::synch::CCriticalSection::m_debugOut

If set to a non-NULL value, debug messages regarding the calling threads IDs will be output.

Definition at line 82 of file CCriticalSection.h.

std::string mrpt::synch::CCriticalSection::m_name [private]

Definition at line 57 of file CCriticalSection.h.