timer Class Reference

#include "timerPrivate.h"

Inheritance diagram for timer:

Collaboration diagram for timer:

Public Member Functions
void	destroy ()
void	start (class epicsTimerNotify &, const epicsTime &)
void	start (class epicsTimerNotify &, double delaySeconds)
void	cancel ()
expireInfo	getExpireInfo () const
void	show (unsigned int level) const
void *	operator new (size_t size, tsFreeList< timer, 0x20 > &)
Public Member Functions inherited from tsDLNode< timer >
	tsDLNode ()
	tsDLNode (const tsDLNode< timer > &)
const tsDLNode< timer > &	operator= (const tsDLNode< timer > &)

Public Attributes
epicsPlacementDeleteOperator((void *, tsFreeList< timer, 0x20 > &)) protecte	~timer )()
timerQueue &	queue

Friends
class	timerQueue

Detailed Description

Definition at line 34 of file timerPrivate.h.

Member Function Documentation

void timer::cancel

(

)

Definition at line 135 of file timer.cpp.

{
    bool reschedual = false;
    bool wakeupCancelBlockingThreads = false;
    {
        epicsGuard < epicsMutex > locker ( this->queue.mutex );
        this->pNotify = 0;
        if ( this->curState == statePending ) {
            this->queue.timerList.remove ( *this );
            this->curState = stateLimbo;
            if ( this->queue.timerList.first() == this &&
                    this->queue.timerList.count() > 0 ) {
                reschedual = true;
            }
        }
        else if ( this->curState == stateActive ) {
            this->queue.cancelPending = true;
            this->curState = timer::stateLimbo;
            if ( this->queue.processThread != epicsThreadGetIdSelf() ) {
                // make certain timer expire() does not run after cancel () returns,
                // but dont require that lock is applied while calling expire()
                while ( this->queue.cancelPending &&
                        this->queue.pExpireTmr == this ) {
                    epicsGuardRelease < epicsMutex > autoRelease ( locker );
                    this->queue.cancelBlockingEvent.wait ();
                }
                // in case other threads are waiting
                wakeupCancelBlockingThreads = true;
            }
        }
    }
    if ( reschedual ) {
        this->queue.notify.reschedule ();
    }
    if ( wakeupCancelBlockingThreads ) {
        this->queue.cancelBlockingEvent.signal ();
    }
}

void timer::destroy

(

)

Definition at line 47 of file timer.cpp.

{
    timerQueue & queueTmp = this->queue;
    this->~timer ();
    queueTmp.timerFreeList.release ( this );
}

epicsTimer::expireInfo timer::getExpireInfo

(

)

const

Definition at line 174 of file timer.cpp.

{
    // taking a lock here guarantees that users will not
    // see brief intervals when a timer isnt active because
    // it is is canceled when start is called
    epicsGuard < epicsMutex > locker ( this->queue.mutex );
    if ( this->curState == statePending || this->curState == stateActive ) {
        return expireInfo ( true, this->exp );
    }
    return expireInfo ( false, epicsTime() );
}

void * timer::operator new ( size_t  size, tsFreeList< timer, 0x20 > &  freeList  )

inline

Definition at line 238 of file timerPrivate.h.

{
    return freeList.allocate ( size );
}

void timer::show

(

unsigned int

level

)

const

Definition at line 186 of file timer.cpp.

{
    epicsGuard < epicsMutex > locker ( this->queue.mutex );
    double delay;
    if ( this->curState == statePending || this->curState == stateActive ) {
        try {
            delay = this->exp - epicsTime::getCurrent();
        }
        catch ( ... ) {
            delay = - DBL_MAX;
        }
    }
    else {
        delay = -DBL_MAX;
    }
    const char *pStateName;
    if ( this->curState == statePending ) {
        pStateName = "pending";
    }
    else if ( this->curState == stateActive ) {
        pStateName = "active";
    }
    else if ( this->curState == stateLimbo ) {
        pStateName = "limbo";
    }
    else {
        pStateName = "corrupt";
    }
    printf ( "timer, state = %s, delay = %f\n",
        pStateName, delay );
    if ( level >= 1u && this->pNotify ) {
        this->pNotify->show ( level - 1u );
    }
}

void timer::start	(	class epicsTimerNotify &	notify,
		const epicsTime &	expire
	)

Definition at line 59 of file timer.cpp.

{
    epicsGuard < epicsMutex > locker ( this->queue.mutex );
    this->privateStart ( notify, expire );
}

void timer::start	(	class epicsTimerNotify &	notify,
		double	delaySeconds
	)

Definition at line 54 of file timer.cpp.

{
    this->start ( notify, epicsTime::getCurrent () + delaySeconds );
}

Friends And Related Function Documentation

friend class timerQueue

friend

Definition at line 61 of file timerPrivate.h.

Member Data Documentation

timerQueue& timer::queue

Definition at line 47 of file timerPrivate.h.

timer::~timer

Definition at line 46 of file timerPrivate.h.

---

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

• modules/libcom/src/timer/timerPrivate.h
• modules/libcom/src/timer/timer.cpp