Thread Safe FIFO bounded queue
[Brought To You By APR]

Typedefs
typedef apr_queue_t	switch_queue_t
Functions
switch_status_t	switch_queue_create (switch_queue_t **queue, unsigned int queue_capacity, switch_memory_pool_t *pool)
switch_status_t	switch_queue_pop (switch_queue_t *queue, void **data)
switch_status_t	switch_queue_push (switch_queue_t *queue, void *data)
unsigned int	switch_queue_size (switch_queue_t *queue)
switch_status_t	switch_queue_trypop (switch_queue_t *queue, void **data)
switch_status_t	switch_queue_trypush (switch_queue_t *queue, void *data)

---

Typedef Documentation

typedef struct apr_queue_t switch_queue_t

Opaque structure used for queue API

---

Function Documentation

switch_status_t switch_queue_create (  switch_queue_t **  queue, unsigned int  queue_capacity, switch_memory_pool_t *  pool )

create a FIFO queue Parameters: queue  The new queue queue_capacity  maximum size of the queue pool  a pool to allocate queue from { return apr_queue_create(queue, queue_capacity, pool); }

switch_status_t switch_queue_pop (  switch_queue_t *  queue, void **  data )

pop/get an object from the queue, blocking if the queue is already empty Parameters: queue  the queue data  the data Returns: APR_EINTR the blocking was interrupted (try again) APR_EOF if the queue has been terminated APR_SUCCESS on a successfull pop { return apr_queue_pop(queue, data); }

switch_status_t switch_queue_push (  switch_queue_t *  queue, void *  data )

push/add a object to the queue, blocking if the queue is already full Parameters: queue  the queue data  the data Returns: APR_EINTR the blocking was interrupted (try again) APR_EOF the queue has been terminated APR_SUCCESS on a successfull push { apr_status_t s; do { s = apr_queue_push(queue, data); } while (s == APR_EINTR); return s; }

unsigned int switch_queue_size (  switch_queue_t *  queue  )

returns the size of the queue. Warning: this is not threadsafe, and is intended for reporting/monitoring of the queue. Parameters: queue  the queue Returns: the size of the queue { return apr_queue_size(queue); }

switch_status_t switch_queue_trypop (  switch_queue_t *  queue, void **  data )

pop/get an object to the queue, returning immediatly if the queue is empty Parameters: queue  the queue data  the data Returns: APR_EINTR the blocking operation was interrupted (try again) APR_EAGAIN the queue is empty APR_EOF the queue has been terminated APR_SUCCESS on a successfull push { return apr_queue_trypop(queue, data); }

switch_status_t switch_queue_trypush (  switch_queue_t *  queue, void *  data )

push/add a object to the queue, returning immediatly if the queue is full Parameters: queue  the queue data  the data Returns: APR_EINTR the blocking operation was interrupted (try again) APR_EAGAIN the queue is full APR_EOF the queue has been terminated APR_SUCCESS on a successfull push { apr_status_t s; do { s = apr_queue_trypush(queue, data); } while (s == APR_EINTR); return s; }

---