initHooks.h File Reference

#include "libComAPI.h"

Include dependency graph for initHooks.h:

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

Go to the source code of this file.

Typedefs
typedef void(*	initHookFunction) (initHookState state)

Enumerations
enum	initHookState {   initHookAtIocBuild = 0, initHookAtBeginning, initHookAfterCallbackInit, initHookAfterCaLinkInit,   initHookAfterInitDrvSup, initHookAfterInitRecSup, initHookAfterInitDevSup, initHookAfterInitDatabase,   initHookAfterFinishDevSup, initHookAfterScanInit, initHookAfterInitialProcess, initHookAfterCaServerInit,   initHookAfterIocBuilt, initHookAtIocRun, initHookAfterDatabaseRunning, initHookAfterCaServerRunning,   initHookAfterIocRunning, initHookAtIocPause, initHookAfterCaServerPaused, initHookAfterDatabasePaused,   initHookAfterIocPaused, initHookAtShutdown, initHookAfterCloseLinks, initHookAfterStopScan,   initHookAfterStopCallback, initHookAfterStopLinks, initHookBeforeFree, initHookAfterShutdown,   initHookAfterInterruptAccept, initHookAtEnd }

Functions
LIBCOM_API int	initHookRegister (initHookFunction func)
LIBCOM_API void	initHookAnnounce (initHookState state)
LIBCOM_API const char *	initHookName (int state)
LIBCOM_API void	initHookFree (void)

Typedef Documentation

typedef void(* initHookFunction) (initHookState state)

Definition at line 66 of file initHooks.h.

Enumeration Type Documentation

enum initHookState

Enumerator
initHookAtIocBuild
initHookAtBeginning
initHookAfterCallbackInit
initHookAfterCaLinkInit
initHookAfterInitDrvSup
initHookAfterInitRecSup
initHookAfterInitDevSup
initHookAfterInitDatabase
initHookAfterFinishDevSup
initHookAfterScanInit
initHookAfterInitialProcess
initHookAfterCaServerInit
initHookAfterIocBuilt
initHookAtIocRun
initHookAfterDatabaseRunning
initHookAfterCaServerRunning
initHookAfterIocRunning
initHookAtIocPause
initHookAfterCaServerPaused
initHookAfterDatabasePaused
initHookAfterIocPaused
initHookAtShutdown
initHookAfterCloseLinks
initHookAfterStopScan
initHookAfterStopCallback
initHookAfterStopLinks
initHookBeforeFree
initHookAfterShutdown
initHookAfterInterruptAccept
initHookAtEnd

Definition at line 25 of file initHooks.h.

             {
    initHookAtIocBuild = 0,         /* Start of iocBuild/iocInit commands */
    initHookAtBeginning,
    initHookAfterCallbackInit,
    initHookAfterCaLinkInit,
    initHookAfterInitDrvSup,
    initHookAfterInitRecSup,
    initHookAfterInitDevSup,
    initHookAfterInitDatabase,
    initHookAfterFinishDevSup,
    initHookAfterScanInit,
    initHookAfterInitialProcess,
    initHookAfterCaServerInit,
    initHookAfterIocBuilt,          /* End of iocBuild command */

    initHookAtIocRun,               /* Start of iocRun command */
    initHookAfterDatabaseRunning,
    initHookAfterCaServerRunning,
    initHookAfterIocRunning,        /* End of iocRun/iocInit commands */

    initHookAtIocPause,             /* Start of iocPause command */
    initHookAfterCaServerPaused,
    initHookAfterDatabasePaused,
    initHookAfterIocPaused,         /* End of iocPause command */

    initHookAtShutdown,             /* Start of iocShutdown commands */
    initHookAfterCloseLinks,
    initHookAfterStopScan,          /* triggered only by unittest code.   testIocShutdownOk() */
    initHookAfterStopCallback,      /* triggered only by unittest code.   testIocShutdownOk() */
    initHookAfterStopLinks,
    initHookBeforeFree,             /* triggered only by unittest code.   testIocShutdownOk() */
    initHookAfterShutdown,          /* End of iocShutdown commands */

/* Deprecated states, provided for backwards compatibility.
 * These states are announced at the same point they were before,
 * but will not be repeated if the IOC gets paused and restarted.
 */
    initHookAfterInterruptAccept,   /* After initHookAfterDatabaseRunning */
    initHookAtEnd,                  /* Before initHookAfterIocRunning */
} initHookState;

Function Documentation

LIBCOM_API void initHookAnnounce

(

initHookState

state

)

Definition at line 76 of file initHooks.c.

{
    initHookLink *hook;

    initHookInit();

    epicsMutexMustLock(listLock);
    hook = (initHookLink *)ellFirst(&functionList);
    epicsMutexUnlock(listLock);

    while (hook != NULL) {
        hook->func(state);

        epicsMutexMustLock(listLock);
        hook = (initHookLink *)ellNext(&hook->node);
        epicsMutexUnlock(listLock);
    }
}

LIBCOM_API void initHookFree

(

void

)

Definition at line 95 of file initHooks.c.

{
    initHookInit();
    epicsMutexMustLock(listLock);
    ellFree(&functionList);
    epicsMutexUnlock(listLock);
}

LIBCOM_API const char* initHookName

(

int

state

)

Definition at line 106 of file initHooks.c.

{
    const char *stateName[] = {
        "initHookAtIocBuild",
        "initHookAtBeginning",
        "initHookAfterCallbackInit",
        "initHookAfterCaLinkInit",
        "initHookAfterInitDrvSup",
        "initHookAfterInitRecSup",
        "initHookAfterInitDevSup",
        "initHookAfterInitDatabase",
        "initHookAfterFinishDevSup",
        "initHookAfterScanInit",
        "initHookAfterInitialProcess",
        "initHookAfterCaServerInit",
        "initHookAfterIocBuilt",
        "initHookAtIocRun",
        "initHookAfterDatabaseRunning",
        "initHookAfterCaServerRunning",
        "initHookAfterIocRunning",
        "initHookAtIocPause",
        "initHookAfterCaServerPaused",
        "initHookAfterDatabasePaused",
        "initHookAfterIocPaused",
        "initHookAfterInterruptAccept",
        "initHookAtEnd"
    };
    if (state < 0 || state >= NELEMENTS(stateName)) {
        return "Not an initHookState";
    }
    return stateName[state];
}

LIBCOM_API int initHookRegister

(

initHookFunction

func

)

Definition at line 51 of file initHooks.c.

{
    initHookLink *newHook;

    if (!func) return 0;

    initHookInit();

    newHook = (initHookLink *)malloc(sizeof(initHookLink));
    if (!newHook) {
        printf("Cannot malloc a new initHookLink\n");
        return -1;
    }
    newHook->func = func;

    epicsMutexMustLock(listLock);
    ellAdd(&functionList, &newHook->node);
    epicsMutexUnlock(listLock);
    return 0;
}