vpr::SignalSet Class Reference

Wrapper class for a signal set. More...

#include <vpr/Thread/Signal.h>

List of all members.

Public Member Functions
	SignalSet (const sigset_t *const sigset)
	Initializes mSigSet with sigset.
	SignalSet (bool fill=false)
	If fill is false then initialize the mSigSet to be empty.
vpr::ReturnStatus	emptySet ()
	Creates a set that includes no signals defined by the system.
vpr::ReturnStatus	fillSet ()
	Creates a set that includes all signals defined by the system.
vpr::ReturnStatus	addSignal (const int sigNum)
	Adds the individual signal specified by sigNum to the set.
vpr::ReturnStatus	removeSignal (const int sigNum)
	Deletes the individual signal specified by sigNum from the set.
bool	isMember (const int sigNum) const
	Checks whether the signal specified by sigNum is in the set.
const sigset_t *	getMask () const
	Returns a constant pointer to the underlying sigset_t variable.

---

Detailed Description

Wrapper class for a signal set.

A signal set contains the set of system signals to be masked when used with a vpr::SignalAction.

Definition at line 98 of file Signal.h.

---

Constructor & Destructor Documentation

vpr::SignalSet::SignalSet

(

const sigset_t *const

sigset

)

[inline]

Initializes mSigSet with sigset.

If sigset == 0 then fill the set.

Parameters:

sigset

The signal set used for initializing this object.

Definition at line 107 of file Signal.h.

   {
      if ( sigset == 0 )
      {
         fillSet();
      }
      else
      {
         mSigSet = *sigset;
      }
   }

vpr::SignalSet::SignalSet

(

bool

fill = false

)

[inline]

If fill is false then initialize the mSigSet to be empty.

Otherwise, mSigSet is initialized to be full.

Parameters:

fill

A boolean flag stating whether to fill this object's signal set or make it empty.

Definition at line 126 of file Signal.h.

   {
      if ( fill )
      {
         fillSet();
      }
      else
      {
         emptySet();
      }
   }

---

Member Function Documentation

vpr::ReturnStatus vpr::SignalSet::emptySet

(

)

Creates a set that includes no signals defined by the system.

Returns:

vpr::ReturnStatus::Succeed is returned if this object's signal set is emptied. vpr::ReturnStatus::Fail is returned otherwise.

Definition at line 59 of file Signal.cpp.

References vpr::ReturnStatus::Fail, and vpr::ReturnStatus::setCode().

{
   vpr::ReturnStatus status;

#ifdef HAVE_SIGEMPTYSET
   if ( sigemptyset(&mSigSet) != 0 )
   {
      status.setCode(vpr::ReturnStatus::Fail);
   }
#else
   mSigSet = 0;
#endif

   return status;
}

vpr::ReturnStatus vpr::SignalSet::fillSet

(

)

Creates a set that includes all signals defined by the system.

Returns:

vpr::ReturnStatus::Succeed is returned if this object's signal set is filled. vpr::ReturnStatus::Fail is returned otherwise.

Definition at line 75 of file Signal.cpp.

References vpr::ReturnStatus::Fail, and vpr::ReturnStatus::setCode().

{
   vpr::ReturnStatus status;

#ifdef HAVE_SIGFILLSET
   if ( sigfillset(&mSigSet) != 0 ) {
      status.setCode(vpr::ReturnStatus::Fail);
   }
#else
   mSigSet = ~(sigset_t) 0;
#endif

   return status;
}

vpr::ReturnStatus vpr::SignalSet::addSignal

(

const int

sigNum

)

Adds the individual signal specified by sigNum to the set.

Parameters:

sigNum

The signal number to be added.

Returns:

vpr::ReturnStatus::Succeed is returned if the given signal is added to this object's signal set. vpr::ReturnStatus::Fail is returned otherwise.

Definition at line 90 of file Signal.cpp.

References vpr::ReturnStatus::Fail, vpr::ReturnStatus::setCode(), and vprASSERT.

{
   vpr::ReturnStatus status;

   vprASSERT(sigNum >= 1 && "Invalid signal number");

#ifdef HAVE_SIGADDSET
   if ( sigaddset(&mSigSet, sigNum) != 0 )
   {
      status.setCode(vpr::ReturnStatus::Fail);
   }
#else
   mSigSet |= (1 << (sigNum - 1));
#endif

   return status;
}

vpr::ReturnStatus vpr::SignalSet::removeSignal

(

const int

sigNum

)

Deletes the individual signal specified by sigNum from the set.

Parameters:

sigNum

The signal number to be removed.

Returns:

vpr::ReturnStatus::Succeed is returned if the given signal is removed from this object's signal set. vpr::ReturnStatus::Fail is returned otherwise.

Definition at line 108 of file Signal.cpp.

References vpr::ReturnStatus::Fail, vpr::ReturnStatus::setCode(), and vprASSERT.

{
   vpr::ReturnStatus status;

   vprASSERT(sigNum >= 1 && "Invalid signal number");

#ifdef HAVE_SIGDELSET
   if ( sigdelset(&mSigSet, sigNum) != 0 )
   {
      status.setCode(vpr::ReturnStatus::Fail);
   }
#else
   mSigSet &= ~(1 << (sigNum - 1)) ;
#endif

   return status;
}

bool vpr::SignalSet::isMember

(

const int

sigNum

)

const

Checks whether the signal specified by sigNum is in the set.

Parameters:

sigNum

The signal number being checked.

Returns:

true is returned if sigNum is in this object's set.

false is returned otherwise.

Definition at line 126 of file Signal.cpp.

References vprASSERT.

{
   bool is_member;

   vprASSERT(sigNum >= 1 && "Invalid signal number");

#ifdef HAVE_SIGISMEMBER
   is_member = (sigismember(&mSigSet, sigNum) == 1);
#else
   is_member = ((mSigSet & (1 << (sigNum - 1))) != 0);
#endif

   return is_member;
}

const sigset_t* vpr::SignalSet::getMask

(

)

const [inline]

Returns a constant pointer to the underlying sigset_t variable.

Returns:

A constant pointer to this object's sigset_t variable.

Definition at line 191 of file Signal.h.

Referenced by vpr::SignalAction::SignalAction().

   {
      return &mSigSet;
   }

---

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

• Signal.h
• Signal.cpp

---