BLAlarm Class Reference

#include <BLAlarm.hh>

List of all members.

---

Detailed Description

class BLAlarm implements an alarm clock.

used to prevent an infinite tracking loop from hanging an entire job.

If BLSignal is also used, BLSignal::init() must be called first.

This class is 100% static.

Public Member Functions
int	timeRemaining ()
	timeRemaining() returns the time remaining, in seconds. returns -1 if no alarm is set.
Static Public Member Functions
static void	clear ()
	clear will clear any alarm.
static void	set (int seconds)
	set() sets an alarm in the future. Implicitly clears any previous alarm. seconds <= 0 does a clear().
static void	init ()
	init() will setup the signal handler. Must be called before set().
static void(*	setCustomHandler (void(*handler)()))()
	setCustomhandler() sets a custom alarm handler. returns the previous handler, or 0 if none.
Static Private Member Functions
static void	sighandler (int sig)
	sighandler() handles the alarm signal
Static Private Attributes
static void(*	customHandler )()

---

Member Function Documentation

void BLAlarm::clear

(

)

[static]

clear will clear any alarm.

Linux and Mac OS X handle alarm signals natively.

Referenced by BLManager::EndOfEventAction(), and BLManager::Notify().

{
        set(0);
}

void BLAlarm::set

(

int

seconds

)

[static]

set() sets an alarm in the future. Implicitly clears any previous alarm. seconds <= 0 does a clear().

References alarm_time, NEVER, and BLTime::time().

Referenced by BLManager::BeginOfEventAction().

{
        alarm(seconds < 0 ? 0 : seconds);
        if(seconds <= 0)
                alarm_time = NEVER;
        else
                alarm_time = BLTime::time() + seconds;
}

void BLAlarm::init

(

)

[static]

init() will setup the signal handler. Must be called before set().

References sighandler().

Referenced by BLManager::BLManager().

{
        signal(SIGALRM,sighandler); 
}

static void(* BLAlarm::setCustomHandler

(

void(*)()

handler

)

[static]

setCustomhandler() sets a custom alarm handler. returns the previous handler, or 0 if none.

int BLAlarm::timeRemaining

(

)

timeRemaining() returns the time remaining, in seconds. returns -1 if no alarm is set.

References alarm_time, NEVER, and BLTime::time().

{
        unsigned long t = BLTime::time();
        if(t > alarm_time || alarm_time == NEVER)
                return -1;
        return alarm_time - t;

}

void BLAlarm::sighandler

(

int

sig

)

[static, private]

sighandler() handles the alarm signal

References BLRunManager::abandonCurrentEvent(), alarm_time, customHandler, BLRunManager::getObject(), and NEVER.

Referenced by init().

{ 
        alarm(0);
        alarm_time = NEVER;
        signal(sig,sighandler); 

        if(customHandler != 0) {
                (*customHandler)();
                return;
        }

        BLRunManager::getObject()->abandonCurrentEvent();
        G4Exception("BLAlarm","Alarm Signal",FatalException,
                        "SIGALRM fired, cannot be recovered");
}

---

Member Data Documentation

void(* BLAlarm::customHandler)()=0

(

)

[static, private]

Referenced by sighandler().

---

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

• BLAlarm.hh
• BLAlarm.cc