portmidi_docs/pmutil_8h_source.html

#ifdef __cplusplus

extern "C" {

#endif /* __cplusplus */


typedef void PmQueue;


PMEXPORT PmQueue *Pm_QueueCreate(long num_msgs, int32_t bytes_per_msg);


PMEXPORT PmError Pm_QueueDestroy(PmQueue *queue);


PMEXPORT PmError Pm_Dequeue(PmQueue *queue, void *msg);


PMEXPORT PmError Pm_Enqueue(PmQueue *queue, void *msg);


PMEXPORT int Pm_QueueFull(PmQueue *queue);


PMEXPORT int Pm_QueueEmpty(PmQueue *queue);


PMEXPORT void *Pm_QueuePeek(PmQueue *queue);


PMEXPORT PmError Pm_SetOverflow(PmQueue *queue);


#ifdef __cplusplus

}

#endif /* __cplusplus */

PmError
PmError
PortMidi error code; a common return type.
Definition: portmidi.h:100

Pm_Dequeue
PMEXPORT PmError Pm_Dequeue(PmQueue *queue, void *msg)
remove one message from the queue, copying it into msg.
Definition: pmutil.c:85

Pm_SetOverflow
PMEXPORT PmError Pm_SetOverflow(PmQueue *queue)
allows the writer (enqueuer) to signal an overflow condition to the reader (dequeuer).
Definition: pmutil.c:164

Pm_QueuePeek
PMEXPORT void * Pm_QueuePeek(PmQueue *queue)
get a pointer to the item at the head of the queue.
Definition: pmutil.c:248

Pm_QueueEmpty
PMEXPORT int Pm_QueueEmpty(PmQueue *queue)
test if the queue is empty.
Definition: pmutil.c:221

Pm_QueueFull
PMEXPORT int Pm_QueueFull(PmQueue *queue)
test if the queue is full.
Definition: pmutil.c:229

PmQueue
void PmQueue
The queue representation is opaque.
Definition: pmutil.h:21

Pm_QueueCreate
PMEXPORT PmQueue * Pm_QueueCreate(long num_msgs, int32_t bytes_per_msg)
create a single-reader, single-writer queue.
Definition: pmutil.c:33

Pm_Enqueue
PMEXPORT PmError Pm_Enqueue(PmQueue *queue, void *msg)
insert one message into the queue, copying it from msg.
Definition: pmutil.c:179

Pm_QueueDestroy
PMEXPORT PmError Pm_QueueDestroy(PmQueue *queue)
destroy a queue and free its storage.
Definition: pmutil.c:70