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

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

#include <carma/util/PthreadRWLockAttr.h>

Public Member Functions

const ::pthread_rwlockattr_t & InternalPthreadRWLockAttr () const
 Obtain a reference to the internal ::pthread_rwlockattr_t. More...
 
::pthread_rwlockattr_t & InternalPthreadRWLockAttr ()
 Obtain a reference to the internal ::pthread_rwlockattr_t. More...
 
 PthreadRWLockAttr ()
 Construct read/write lock attributes with the CARMA defaults. More...
 
virtual ~PthreadRWLockAttr ()
 Destruct read/write lock attributes. More...
 

Detailed Description

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

Definition at line 14 of file PthreadRWLockAttr.h.

Constructor & Destructor Documentation

carma::util::PthreadRWLockAttr::PthreadRWLockAttr ( )
explicit

Construct read/write lock attributes with the CARMA defaults.

Any internal errors will throw an exception.

virtual carma::util::PthreadRWLockAttr::~PthreadRWLockAttr ( )
virtual

Destruct read/write lock 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_rwlockattr_t & carma::util::PthreadRWLockAttr::InternalPthreadRWLockAttr ( ) const

Obtain a reference to the internal ::pthread_rwlockattr_t.

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

Definition at line 73 of file PthreadRWLockAttr.h.

pthread_rwlockattr_t & carma::util::PthreadRWLockAttr::InternalPthreadRWLockAttr ( )

Obtain a reference to the internal ::pthread_rwlockattr_t.

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

Definition at line 80 of file PthreadRWLockAttr.h.


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