asTrapWrite.h File Reference

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

#include "libComAPI.h"

Include dependency graph for asTrapWrite.h:

Go to the source code of this file.

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

Typedefs
typedef void *	asTrapWriteId
	An identifier needed to unregister an listener.
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

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(* asTrapWriteListener)(asTrapWriteMessage *pmessage, int after)

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 75 of file asTrapWrite.h.

Function Documentation

LIBCOM_API asTrapWriteId epicsStdCall asTrapWriteRegisterListener

(

asTrapWriteListener

func

)

Parameters

func	The listener function to be called.

Returns

A listener identifier for unregistering this listener.

LIBCOM_API void epicsStdCall asTrapWriteUnregisterListener

(

asTrapWriteId

id

)

Parameters

id	Listener identifier from asTrapWriteRegisterListener().