epicsTimer.h File Reference

#include <float.h>
#include "libComAPI.h"
#include "epicsTime.h"
#include "epicsThread.h"

Include dependency graph for epicsTimer.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef struct epicsTimerForC *	epicsTimerId
typedef void(*	epicsTimerCallback) (void *pPrivate)
typedef struct epicsTimerQueueActiveForC *	epicsTimerQueueId
typedef struct epicsTimerQueuePassiveForC *	epicsTimerQueuePassiveId
typedef void(*	epicsTimerQueueNotifyReschedule) (void *pPrivate)
typedef double(*	epicsTimerQueueNotifyQuantum) (void *pPrivate)

Functions
LIBCOM_API epicsTimerQueueId epicsStdCall	epicsTimerQueueAllocate (int okToShare, unsigned int threadPriority)
LIBCOM_API void epicsStdCall	epicsTimerQueueRelease (epicsTimerQueueId)
LIBCOM_API epicsTimerId epicsStdCall	epicsTimerQueueCreateTimer (epicsTimerQueueId queueid, epicsTimerCallback callback, void *arg)
LIBCOM_API void epicsStdCall	epicsTimerQueueDestroyTimer (epicsTimerQueueId queueid, epicsTimerId id)
LIBCOM_API void epicsStdCall	epicsTimerQueueShow (epicsTimerQueueId id, unsigned int level)
LIBCOM_API epicsTimerQueuePassiveId epicsStdCall	epicsTimerQueuePassiveCreate (epicsTimerQueueNotifyReschedule, epicsTimerQueueNotifyQuantum, void *pPrivate)
LIBCOM_API void epicsStdCall	epicsTimerQueuePassiveDestroy (epicsTimerQueuePassiveId)
LIBCOM_API epicsTimerId epicsStdCall	epicsTimerQueuePassiveCreateTimer (epicsTimerQueuePassiveId queueid, epicsTimerCallback pCallback, void *pArg)
LIBCOM_API void epicsStdCall	epicsTimerQueuePassiveDestroyTimer (epicsTimerQueuePassiveId queueid, epicsTimerId id)
LIBCOM_API double epicsStdCall	epicsTimerQueuePassiveProcess (epicsTimerQueuePassiveId)
LIBCOM_API void epicsStdCall	epicsTimerQueuePassiveShow (epicsTimerQueuePassiveId id, unsigned int level)
LIBCOM_API void epicsStdCall	epicsTimerStartTime (epicsTimerId id, const epicsTimeStamp *pTime)
LIBCOM_API void epicsStdCall	epicsTimerStartDelay (epicsTimerId id, double delaySeconds)
LIBCOM_API void epicsStdCall	epicsTimerCancel (epicsTimerId id)
LIBCOM_API double epicsStdCall	epicsTimerGetExpireDelay (epicsTimerId id)
LIBCOM_API void epicsStdCall	epicsTimerShow (epicsTimerId id, unsigned int level)

Typedef Documentation

typedef void( * epicsTimerCallback) (void *pPrivate)

Definition at line 134 of file epicsTimer.h.

typedef struct epicsTimerForC* epicsTimerId

Definition at line 133 of file epicsTimer.h.

typedef struct epicsTimerQueueActiveForC* epicsTimerQueueId

Definition at line 137 of file epicsTimer.h.

typedef double( * epicsTimerQueueNotifyQuantum) (void *pPrivate)

Definition at line 153 of file epicsTimer.h.

typedef void( * epicsTimerQueueNotifyReschedule) (void *pPrivate)

Definition at line 152 of file epicsTimer.h.

typedef struct epicsTimerQueuePassiveForC* epicsTimerQueuePassiveId

Definition at line 151 of file epicsTimer.h.

Function Documentation

LIBCOM_API void epicsStdCall epicsTimerCancel

(

epicsTimerId

id

)

Definition at line 260 of file epicsTimer.cpp.

{
    pTmr->cancel ();
}

LIBCOM_API double epicsStdCall epicsTimerGetExpireDelay

(

epicsTimerId

id

)

Definition at line 265 of file epicsTimer.cpp.

{
    return pTmr->getExpireDelay ();
}

LIBCOM_API epicsTimerQueueId epicsStdCall epicsTimerQueueAllocate	(	int	okToShare,
		unsigned int	threadPriority
	)

Definition at line 206 of file epicsTimer.cpp.

{
    try {
        epicsSingleton < timerQueueActiveMgr > :: reference ref =
            timerQueueMgrEPICS.getReference ();
        epicsTimerQueueActiveForC & tmr =
            ref->allocate ( ref, okToShare ? true : false, threadPriority );
        return &tmr;
    }
    catch ( ... ) {
        return 0;
    }
}

LIBCOM_API epicsTimerId epicsStdCall epicsTimerQueueCreateTimer	(	epicsTimerQueueId	queueid,
		epicsTimerCallback	callback,
		void *	arg
	)

Definition at line 225 of file epicsTimer.cpp.

{
    try {
        return & pQueue->createTimerForC ( pCallback, pArg );
    }
    catch ( ... ) {
        return 0;
    }
}

LIBCOM_API void epicsStdCall epicsTimerQueueDestroyTimer	(	epicsTimerQueueId	queueid,
		epicsTimerId	id
	)

Definition at line 242 of file epicsTimer.cpp.

{
    pTmr->destroy ();
}

LIBCOM_API epicsTimerQueuePassiveId epicsStdCall epicsTimerQueuePassiveCreate	(	epicsTimerQueueNotifyReschedule	,
		epicsTimerQueueNotifyQuantum	,
		void *	pPrivate
	)

Definition at line 149 of file epicsTimer.cpp.

{
    try {
        return new epicsTimerQueuePassiveForC (
            pRescheduleCallbackIn,
            pSleepQuantumCallbackIn,
            pPrivateIn );
    }
    catch ( ... ) {
        return 0;
    }
}

LIBCOM_API epicsTimerId epicsStdCall epicsTimerQueuePassiveCreateTimer	(	epicsTimerQueuePassiveId	queueid,
		epicsTimerCallback	pCallback,
		void *	pArg
	)

Definition at line 182 of file epicsTimer.cpp.

{
    try {
        return  & pQueue->createTimerForC ( pCallback, pArg );
    }
    catch ( ... ) {
        return 0;
    }
}

LIBCOM_API void epicsStdCall epicsTimerQueuePassiveDestroy

(

epicsTimerQueuePassiveId

)

Definition at line 166 of file epicsTimer.cpp.

{
    pQueue->destroy ();
}

LIBCOM_API void epicsStdCall epicsTimerQueuePassiveDestroyTimer	(	epicsTimerQueuePassiveId	queueid,
		epicsTimerId	id
	)

Definition at line 193 of file epicsTimer.cpp.

{
    pTmr->destroy ();
}

LIBCOM_API double epicsStdCall epicsTimerQueuePassiveProcess

(

epicsTimerQueuePassiveId

)

Definition at line 172 of file epicsTimer.cpp.

{
    try {
        return pQueue->process ( epicsTime::getCurrent() );
    }
    catch ( ... ) {
        return 1.0;
    }
}

LIBCOM_API void epicsStdCall epicsTimerQueuePassiveShow	(	epicsTimerQueuePassiveId	id,
		unsigned int	level
	)

Definition at line 199 of file epicsTimer.cpp.

{
    pQueue->show ( level );
}

LIBCOM_API void epicsStdCall epicsTimerQueueRelease

(

epicsTimerQueueId

)

Definition at line 220 of file epicsTimer.cpp.

{
    pQueue->release ();
}

LIBCOM_API void epicsStdCall epicsTimerQueueShow	(	epicsTimerQueueId	id,
		unsigned int	level
	)

Definition at line 236 of file epicsTimer.cpp.

{
    pQueue->show ( level );
}

LIBCOM_API void epicsStdCall epicsTimerShow	(	epicsTimerId	id,
		unsigned int	level
	)

Definition at line 270 of file epicsTimer.cpp.

{
    pTmr->timer::show ( level );
}

LIBCOM_API void epicsStdCall epicsTimerStartDelay	(	epicsTimerId	id,
		double	delaySeconds
	)

Definition at line 254 of file epicsTimer.cpp.

{
    pTmr->start ( *pTmr, delaySeconds );
}

LIBCOM_API void epicsStdCall epicsTimerStartTime	(	epicsTimerId	id,
		const epicsTimeStamp *	pTime
	)

Definition at line 248 of file epicsTimer.cpp.

{
    pTmr->start ( *pTmr, *pTime );
}