CARMA C++
carma::util::PthreadCondAttr Class Reference

A simple wrapper class that makes use of ::pthread_condattr_t easier in a C++ world. More...

#include <carma/util/PthreadCondAttr.h>

Public Member Functions

const ::pthread_condattr_t & InternalPthreadCondAttr () const
 Obtain a reference to the internal ::pthread_condattr_t. More...
 
::pthread_condattr_t & InternalPthreadCondAttr ()
 Obtain a reference to the internal ::pthread_condattr_t. More...
 
 PthreadCondAttr ()
 Construct cond attributes with the CARMA defaults. More...
 
virtual ~PthreadCondAttr ()
 Destruct cond attributes. More...
 

Detailed Description

A simple wrapper class that makes use of ::pthread_condattr_t easier in a C++ world.

Definition at line 14 of file PthreadCondAttr.h.

Constructor & Destructor Documentation

carma::util::PthreadCondAttr::PthreadCondAttr ( )
explicit

Construct cond attributes with the CARMA defaults.

Any internal errors will throw an exception.

virtual carma::util::PthreadCondAttr::~PthreadCondAttr ( )
virtual

Destruct cond attributes.

No exceptions will be thrown and hence internal errors will be ignored as far as clients are concerned (though they may be logged).

Member Function Documentation

const ::pthread_condattr_t & carma::util::PthreadCondAttr::InternalPthreadCondAttr ( ) const

Obtain a reference to the internal ::pthread_condattr_t.

Warning
Use this with care. Certainly do not go off and call something like ::pthread_condattr_destroy on the return value. If you don't know what you are doing with POSIX cond attributes then think twice before using this method.
Returns
a reference to the internal ::pthread_condattr_t

Definition at line 73 of file PthreadCondAttr.h.

pthread_condattr_t & carma::util::PthreadCondAttr::InternalPthreadCondAttr ( )

Obtain a reference to the internal ::pthread_condattr_t.

Warning
Use this with care. Certainly do not go off and call something like ::pthread_condattr_destroy on the return value. If you don't know what you are doing with POSIX cond attributes then think twice before using this method.
Returns
a reference to the internal ::pthread_condattr_t

Definition at line 80 of file PthreadCondAttr.h.


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