generalTimeSup.h File Reference

#include "epicsTime.h"
#include "epicsTimer.h"
#include "libComAPI.h"

Include dependency graph for generalTimeSup.h:

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

Go to the source code of this file.

Macros
#define	LAST_RESORT_PRIORITY   999
#define	generalTimeCurrentTpRegister   generalTimeRegisterCurrentProvider
#define	generalTimeEventTpRegister   generalTimeRegisterEventProvider

Typedefs
typedef int(*	TIMECURRENTFUN) (epicsTimeStamp *pDest)
typedef int(*	TIMEEVENTFUN) (epicsTimeStamp *pDest, int event)

Functions
LIBCOM_API int	generalTimeRegisterCurrentProvider (const char *name, int priority, TIMECURRENTFUN getTime)
LIBCOM_API int	generalTimeRegisterEventProvider (const char *name, int priority, TIMEEVENTFUN getEvent)
LIBCOM_API int	generalTimeAddIntCurrentProvider (const char *name, int priority, TIMECURRENTFUN getTime)
LIBCOM_API int	generalTimeAddIntEventProvider (const char *name, int priority, TIMEEVENTFUN getEvent)
LIBCOM_API int	generalTimeGetExceptPriority (epicsTimeStamp *pDest, int *pPrio, int ignorePrio)

Macro Definition Documentation

#define generalTimeCurrentTpRegister   generalTimeRegisterCurrentProvider

Definition at line 32 of file generalTimeSup.h.

#define generalTimeEventTpRegister   generalTimeRegisterEventProvider

Definition at line 33 of file generalTimeSup.h.

#define LAST_RESORT_PRIORITY   999

Definition at line 17 of file generalTimeSup.h.

Typedef Documentation

typedef int(* TIMECURRENTFUN) (epicsTimeStamp *pDest)

Definition at line 23 of file generalTimeSup.h.

typedef int(* TIMEEVENTFUN) (epicsTimeStamp *pDest, int event)

Definition at line 24 of file generalTimeSup.h.

Function Documentation

LIBCOM_API int generalTimeAddIntCurrentProvider	(	const char *	name,
		int	priority,
		TIMECURRENTFUN	getTime
	)

Definition at line 487 of file epicsGeneralTime.c.

{
    gtProvider *ptp = findProvider(&gtPvt.timeProviders, gtPvt.timeListLock,
        name, priority);
    if (ptp == NULL)
        return S_time_noProvider;

    ptp->getInt.Time = getTime;

    IFDEBUG(1)
        printf("Time provider '%s' is interrupt-callable\n", name);

    return epicsTimeOK;
}

LIBCOM_API int generalTimeAddIntEventProvider	(	const char *	name,
		int	priority,
		TIMEEVENTFUN	getEvent
	)

Definition at line 444 of file epicsGeneralTime.c.

{
    gtProvider *ptp = findProvider(&gtPvt.eventProviders, gtPvt.eventListLock,
        name, priority);
    if (ptp == NULL)
        return S_time_noProvider;

    ptp->getInt.Event = getEvent;

    IFDEBUG(1)
        printf("Event provider '%s' is interrupt-callable\n", name);

    return epicsTimeOK;
}

LIBCOM_API int generalTimeGetExceptPriority	(	epicsTimeStamp *	pDest,
		int *	pPrio,
		int	ignorePrio
	)

Definition at line 105 of file epicsGeneralTime.c.

{
    gtProvider *ptp;
    int status = S_time_noProvider;

    if(useOsdGetCurrent)
        return osdTimeGetCurrent(pDest);

    generalTime_Init();

    IFDEBUG(2)
        printf("generalTimeGetExceptPriority(ignore=%d)\n", ignore);

    epicsMutexMustLock(gtPvt.timeListLock);
    for (ptp = (gtProvider *)ellFirst(&gtPvt.timeProviders);
         ptp; ptp = (gtProvider *)ellNext(&ptp->node)) {
        if ((ignore > 0 && ptp->priority == ignore) ||
            (ignore < 0 && ptp->priority != -ignore))
            continue;

        status = ptp->get.Time(pDest);
        if (status == epicsTimeOK) {
            /* No ratchet, time from this routine may go backwards */
            if (pPrio)
                *pPrio = ptp->priority;
            break;
        }
        else IFDEBUG(2)
            printf("gTGExP provider '%s' returned error\n", ptp->name);
    }
    epicsMutexUnlock(gtPvt.timeListLock);

    IFDEBUG(2) {
        if (ptp && status == epicsTimeOK) {
            char buff[40];

            epicsTimeToStrftime(buff, sizeof(buff), tsfmt, pDest);
            printf("gTGExP returning %s from provider '%s'\n",
                buff, ptp->name);
        }
        else
            printf("gTGExP returning error\n");
    }

    return status;
}

LIBCOM_API int generalTimeRegisterCurrentProvider	(	const char *	name,
		int	priority,
		TIMECURRENTFUN	getTime
	)

Definition at line 460 of file epicsGeneralTime.c.

{
    gtProvider *ptp;

    generalTime_Init();

    if (name == NULL || getTime == NULL)
        return S_time_badArgs;

    ptp = (gtProvider *)malloc(sizeof(gtProvider));
    if (ptp == NULL)
        return S_time_noMemory;

    ptp->name        = epicsStrDup(name);
    ptp->priority    = priority;
    ptp->get.Time    = getTime;
    ptp->getInt.Time = NULL;

    insertProvider(ptp, &gtPvt.timeProviders, gtPvt.timeListLock);

    IFDEBUG(1)
        printf("Registered time provider '%s' at %d\n", name, priority);

    return epicsTimeOK;
}

LIBCOM_API int generalTimeRegisterEventProvider	(	const char *	name,
		int	priority,
		TIMEEVENTFUN	getEvent
	)

Definition at line 417 of file epicsGeneralTime.c.

{
    gtProvider *ptp;

    generalTime_Init();

    if (name == NULL || getEvent == NULL)
        return S_time_badArgs;

    ptp = (gtProvider *)malloc(sizeof(gtProvider));
    if (ptp == NULL)
        return S_time_noMemory;

    ptp->name         = epicsStrDup(name);
    ptp->priority     = priority;
    ptp->get.Event    = getEvent;
    ptp->getInt.Event = NULL;

    insertProvider(ptp, &gtPvt.eventProviders, gtPvt.eventListLock);

    IFDEBUG(1)
        printf("Registered event provider '%s' at %d\n", name, priority);

    return epicsTimeOK;
}