asTrapWrite.h File Reference

API for monitoring external put operations to an IOC. More...

#include "libComAPI.h"

Include dependency graph for asTrapWrite.h:

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

Go to the source code of this file.

Classes
struct	asTrapWriteMessage
	The message passed to registered listeners. More...

Typedefs
typedef struct asTrapWriteMessage	asTrapWriteMessage
	The message passed to registered listeners. More...
typedef void *	asTrapWriteId
	An identifier needed to unregister an listener. More...
typedef void(*	asTrapWriteListener) (asTrapWriteMessage *pmessage, int after)
	Pointer to a listener function. More...

Functions
LIBCOM_API asTrapWriteId epicsStdCall	asTrapWriteRegisterListener (asTrapWriteListener func)
	Register function to be called on asTrapWriteListener. More...
LIBCOM_API void epicsStdCall	asTrapWriteUnregisterListener (asTrapWriteId id)
	Unregister asTrapWriteListener. More...

Detailed Description

API for monitoring external put operations to an IOC.

Author

Marty Kraimer

The access security subsystem provides an API asTrapWrite that makes put/write requests visible to any facility that registers a listener.

Definition in file asTrapWrite.h.

Typedef Documentation

typedef void* asTrapWriteId

An identifier needed to unregister an listener.

Definition at line 58 of file asTrapWrite.h.

typedef void(* asTrapWriteListener) (asTrapWriteMessage *pmessage, int after)

Pointer to a listener function.

Each registered listener function is called twice for every put; once before and once after the write is performed. The listener may set userPvt in the first call and retrieve it in the second call.

Each asTrapWriteMessage can change or may be deleted after the user's asTrapWriteListener returns

The listener function is called by a server thread so it must not block or do anything that causes a delay.

Definition at line 74 of file asTrapWrite.h.

typedef struct asTrapWriteMessage asTrapWriteMessage

The message passed to registered listeners.

Function Documentation

LIBCOM_API asTrapWriteId epicsStdCall asTrapWriteRegisterListener

(

asTrapWriteListener

func

)

Register function to be called on asTrapWriteListener.

Parameters

func	The listener function to be called.

Returns

A listener identifier for unregistering this listener.

Definition at line 73 of file asTrapWrite.c.

{
    listener *plistener;
    if(pasTrapWritePvt==0) asTrapWriteInit();
    plistener = callocMustSucceed(1,sizeof(listener),"asTrapWriteRegisterListener");
    plistener->func = func;
    epicsMutexMustLock(pasTrapWritePvt->lock);
    ellAdd(&pasTrapWritePvt->listenerList,&plistener->node);
    epicsMutexUnlock(pasTrapWritePvt->lock);
    return((asTrapWriteId)plistener);
}

LIBCOM_API void epicsStdCall asTrapWriteUnregisterListener

(

asTrapWriteId

id

)

Unregister asTrapWriteListener.

Parameters

id	Listener identifier from asTrapWriteRegisterListener().

Definition at line 86 of file asTrapWrite.c.

{
    listener *plistener = (listener *)id;
    writeMessage *pwriteMessage;

    if(pasTrapWritePvt==0) return;
    epicsMutexMustLock(pasTrapWritePvt->lock);
    pwriteMessage = (writeMessage *)ellFirst(&pasTrapWritePvt->writeMessageList);
    while(pwriteMessage) {
        listenerPvt *plistenerPvt
             = (listenerPvt *)ellFirst(&pwriteMessage->listenerPvtList);
        while(plistenerPvt) {
            listenerPvt *pnext
                 = (listenerPvt *)ellNext(&plistenerPvt->node);
            if(plistenerPvt->plistener == plistener) {
                ellDelete(&pwriteMessage->listenerPvtList,&plistenerPvt->node);
                freeListFree(pasTrapWritePvt->freeListListenerPvt, plistenerPvt);
            }
            plistenerPvt = pnext;
        }
        pwriteMessage = (writeMessage *)ellNext(&pwriteMessage->node);
    }
    ellDelete(&pasTrapWritePvt->listenerList,&plistener->node);
    free(plistener);
    epicsMutexUnlock(pasTrapWritePvt->lock);
}