AuScanEvents (3)

Leading comments

$NCDId: @(#)AuScEvt.man,v 1.1 1994/09/27 00:36:22 greg Exp $
copyright 1994 Steven King

portions are
* Copyright 1993 Network Computing Devices, Inc.
*
* Permission to use, copy, modify, distribute, and sell this software and its
* documentation for any purpose is hereby granted without fee, provided that
* the above copyright notice appear in all copies and that both that
* copyright notice and this permission notice appear in supporting
* documentation, and that the name Network Computing ...

(The comments found at the beginning of the groff file "man3/AuScanEvents.3nas".)

Name

AuScanEvents - return the first event that satisfies the predicate

Synopsis

#include <audio/audiolib.h>

AuBool AuScanEvents(server, mode, dequeue, predicate, arg, event)

    AuServer *server;

    int mode;

    AuBool dequeue;

    AuBool (*predicate)(AuServer *,AuEvent *, AuPointer);

    AuPointer arg;

    AuEvent *event; /* RETURN */

Arguments

server

Specifies the connection to the audio server.

mode

Specifies how far to look for a match. This should be one of these constants: AuEventsQueuedAlready, AuEventsQueuedAfterReading, or AuEventsQueuedAfterFlush.

dequeue

Specifies if a matching event is found, should it be removed from the queue.

predicate

Specifies the procedure that is called to determine if an event matches the criteria.

arg

Specifies any additional arguments to be passed to the predicate procedure.

event

Returns the matching event if found.

Description

AuScanEvents scans the event queue looking for the first event that satisfies the caller-supplied predicate. If mode is AuEventsQueuedAlready, AuScanEvents only checks for events already in the queue. If mode is AuEventsQueuedAfterReading, and a matching event isn't found already in the queue, AuScanEvents attempts to read more events out of the application's connection. If mode is AuEventsQueuedAfterFlush and a matching event isn't already in the queue or isn't waiting to be read, AuScanEvents flushes the output queue and attempts to read more events out of the application's connection. If dequeue is AuTrue, and a matching event is found, it is removed from the queue. The predicate procedure is called with the arguments server, event, and arg and should return AuTrue to indicate a match.

See Also

AuEventsQueued, AuScanForTypedEvent, AuNextEvent.

audiolib - Network Audio System C Language Interface