uhallibs::ipc::RobustMutex Class Reference

#include <RobustMutex.hpp>

Public Member Functions
	RobustMutex ()
	~RobustMutex ()
void	lock ()
void	unlock ()
uint64_t	getCounter () const
bool	isActive () const
void	startSession ()
void	endSession ()

Private Member Functions
	RobustMutex (const RobustMutex &)

Private Attributes
pthread_mutex_t	mMutex
uint64_t	mCount
bool	mSessionActive

Detailed Description

Definition at line 20 of file RobustMutex.hpp.

Constructor & Destructor Documentation

RobustMutex() [1/2]

uhallibs::ipc::RobustMutex::RobustMutex

(

)

Definition at line 9 of file RobustMutex.cpp.

  : mCount(0)
  , mSessionActive(false)
{
  pthread_mutexattr_t lAttr;
 
  int s = pthread_mutexattr_init(&lAttr);
  if (s != 0) {
    exception::MutexError lExc;
    log(lExc, "Error code ", uhal::Integer(s), " (", strerror(s), ") returned in mutex attr initialisation");
    throw lExc;
  }
 
  s = pthread_mutexattr_setpshared(&lAttr, PTHREAD_PROCESS_SHARED);
  if (s != 0) {
    exception::MutexError lExc;
    log(lExc, "Error code ", uhal::Integer(s), " (", strerror(s), ") returned by pthread_mutexattr_setpshared");
    throw lExc;
  }
 
  s = pthread_mutexattr_setrobust(&lAttr, PTHREAD_MUTEX_ROBUST);
  if (s != 0) {
    exception::MutexError lExc;
    log(lExc, "Error code ", uhal::Integer(s), " (", strerror(s), ") returned by pthread_mutexattr_setrobust");
    throw lExc;
  }
 
  s = pthread_mutex_init(&mMutex, &lAttr);
  if (s != 0) {
    exception::MutexError lExc;
    log(lExc, "Error code ", uhal::Integer(s), " (", strerror(s), ") returned in mutex initialisation");
    throw lExc;
  }
}

~RobustMutex()

uhallibs::ipc::RobustMutex::~RobustMutex

(

)

Definition at line 44 of file RobustMutex.cpp.

{}

RobustMutex() [2/2]

uhallibs::ipc::RobustMutex::RobustMutex ( const RobustMutex & )

private

Member Function Documentation

endSession()

void uhallibs::ipc::RobustMutex::endSession

(

)

Definition at line 95 of file RobustMutex.cpp.

{
  mSessionActive = false;
}

getCounter()

uint64_t uhallibs::ipc::RobustMutex::getCounter

(

)

const

Definition at line 76 of file RobustMutex.cpp.

{
  return mCount;
}

isActive()

bool uhallibs::ipc::RobustMutex::isActive

(

)

const

Definition at line 82 of file RobustMutex.cpp.

{
  return mSessionActive;
}

lock()

void uhallibs::ipc::RobustMutex::lock

(

)

Definition at line 47 of file RobustMutex.cpp.

{
  int s = pthread_mutex_lock(&mMutex);
  bool lLastOwnerDied = (s == EOWNERDEAD);
  if (lLastOwnerDied)
    s = pthread_mutex_consistent(&mMutex);
 
  if (s != 0) {
    exception::MutexError lExc;
    log(lExc,
        "Error code ",
        uhal::Integer(s),
        " (",
        strerror(s),
        ") returned when ",
        lLastOwnerDied ? "making mutex state consistent" : "locking mutex");
    throw lExc;
  }
}

startSession()

void uhallibs::ipc::RobustMutex::startSession

(

)

Definition at line 88 of file RobustMutex.cpp.

{
  mCount++;
  mSessionActive = true;
}

unlock()

void uhallibs::ipc::RobustMutex::unlock

(

)

Definition at line 68 of file RobustMutex.cpp.

{
  int s = pthread_mutex_unlock(&mMutex);
  if (s != 0)
    log(uhal::Error(), "Error code ", uhal::Integer(s), " (", strerror(s), ") returned when unlocking mutex");
}

Member Data Documentation

mCount

uint64_t uhallibs::ipc::RobustMutex::mCount

private

Definition at line 42 of file RobustMutex.hpp.

mMutex

pthread_mutex_t uhallibs::ipc::RobustMutex::mMutex

private

Definition at line 41 of file RobustMutex.hpp.

mSessionActive

bool uhallibs::ipc::RobustMutex::mSessionActive

private

Definition at line 43 of file RobustMutex.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/uhallibs/include/uhallibs/ipc/RobustMutex.hpp
• /github/workspace/dunedaq/sourcecode/uhallibs/src/RobustMutex.cpp