2 Chapter 24. AMANDA Event API
3 Prev Part V. Technical Background Next
5 -------------------------------------------------------------------------------
7 Chapter 24. AMANDA Event API
18 XML-conversion;Updates
67 Refer to http://www.amanda.org/docs/eventapi.html for the current version of
72 This is a document of the API for the event handler. The purpose of the event
73 handler is to allow scheduling and serialization of multiple different types of
81 event_handle_t *event_register(event_id_t data, event_type_t type, event_fn_t
83 Sets up an event of the given type to call the given function with the given
85 The 'data' argument is type specific.
86 EV_READFD, EV_WRITEFD - the file descriptor to monitor EV_SIG - the signal
87 number to monitor EV_TIME - the number of seconds between each pulse EV_WAIT -
88 the wait identifier used with event_wakeup() EV_DEAD - internal use only
92 void event_release(event_handle_t *handle);
93 Remove an event from the queue. This can happen at any time, even while the
98 void event_loop(int dontblock);
99 Process all pending events. If the argument is zero, this will keep running
100 until all events have been released. If the argument is nonzero, this will do
101 one pass over all pending events, and fire the ones that are immediately ready,
106 int event_wakeup(event_id_t id);
107 Fire all EV_WAIT events registered with an argument value of 'id' immediately.
108 Returns the number of events that were fired.
115 This is an opaque structure that describes a registered event. It is only
116 useful to keep if you need to unregister the event later.
120 This is type-specific data. The contents and format depend on on the type of
121 the event. This is an unsigned integral type.
125 This is an enumerated type describing the different events we handle.
129 typedef void (*event_fn_t)(void *arg);
130 This is a function signature for the type of function that needs to get passed
131 to event_register. The argument to the function is a pointer of the caller's
139 This type of event will fire when the file descriptor passed to event_register
140 has data waiting to be read.
144 This type of event will fire when the file descriptor passed to event_register
145 can have data written to it without blocking.
149 This type of event will fire when the signal number passed to event_register
150 has been caught. Note that if a signal is caught while processing is not in
151 event_loop(), the event will be delayed until processing returns to event_loop
156 This type of event will fire repeatedly with a delay of the number of seconds
157 passed to event_register between each interval.
161 This type of event will fire when someone calls event_wakeup() with the numeric
162 argument equal to the argument this event was registered with.
163 -------------------------------------------------------------------------------
166 Chapter 23. AMANDA Internals Home Chapter 25. AMANDA Security API