1AuScanEvents(3)            Library Functions Manual            AuScanEvents(3)
2
3
4

Name

6       AuScanEvents - return the first event that satisfies the predicate
7

Synopsis

9       #include <audio/audiolib.h>
10
11       AuBool AuScanEvents(server, mode, dequeue, predicate, arg, event)
12           AuServer *server;
13           int mode;
14           AuBool dequeue;
15           AuBool (*predicate)(AuServer *,AuEvent *, AuPointer);
16           AuPointer arg;
17           AuEvent *event; /* RETURN */
18

Arguments

20       server    Specifies the connection to the audio server.
21
22       mode      Specifies how far to look for a match.  This should be one of
23                 these constants: AuEventsQueuedAlready,  AuEventsQueuedAfter‐
24                 Reading, or AuEventsQueuedAfterFlush.
25
26       dequeue   Specifies  if a matching event is found, should it be removed
27                 from the queue.
28
29       predicate Specifies the procedure that is called  to  determine  if  an
30                 event matches the criteria.
31
32       arg       Specifies any additional arguments to be passed to the predi‐
33                 cate procedure.
34
35       event     Returns the matching event if found.
36

Description

38       AuScanEvents scans the event queue looking for  the  first  event  that
39       satisfies  the caller-supplied predicate.  If mode is AuEventsQueuedAl‐
40       ready, AuScanEvents only checks for events already in  the  queue.   If
41       mode  is  AuEventsQueuedAfterReading,  and a matching event isn't found
42       already in the queue, AuScanEvents attempts to read more events out  of
43       the  application's connection.  If mode is AuEventsQueuedAfterFlush and
44       a matching event isn't already in the queue  or  isn't  waiting  to  be
45       read,  AuScanEvents  flushes the output queue and attempts to read more
46       events out of the application's connection.  If dequeue is AuTrue,  and
47       a matching event is found, it is removed from the queue.  The predicate
48       procedure is called with the  arguments  server,  event,  and  arg  and
49       should return AuTrue to indicate a match.
50

See Also

52       AuEventsQueued, AuScanForTypedEvent, AuNextEvent.
53
54       audiolib - Network Audio System C Language Interface
55
56
57
58audiolib - event handling            1.9.2                     AuScanEvents(3)