thread_queue.c File Reference

#include <rz_th.h>
#include "thread.h"

Go to the source code of this file.

Classes
struct	rz_th_queue_t
	RzThreadQueue is a thread-safe queue that can be listened on from multiple threads. More...

Functions
RZ_API RZ_OWN RzThreadQueue *	rz_th_queue_new (size_t max_size, RZ_NULLABLE RzListFree qfree)
	Allocates and initializes a new fifo queue. More...
RZ_API void	rz_th_queue_free (RZ_NULLABLE RzThreadQueue *queue)
	Frees a RzThreadQueue structure. More...
RZ_API bool	rz_th_queue_push (RZ_NONNULL RzThreadQueue *queue, RZ_NONNULL void *user, bool tail)
	Pushes a new element into the queue. More...
RZ_API RZ_OWN void *	rz_th_queue_pop (RZ_NONNULL RzThreadQueue *queue, bool tail)
	Removes an element from the queue, but does not awaits when empty. More...
RZ_API RZ_OWN void *	rz_th_queue_wait_pop (RZ_NONNULL RzThreadQueue *queue, bool tail)
	Removes an element from the queue, but yields the thread till not empty. More...
RZ_API bool	rz_th_queue_is_empty (RZ_NONNULL RzThreadQueue *queue)
	Returns true if the queue is empty (thread-safe) More...
RZ_API bool	rz_th_queue_is_full (RZ_NONNULL RzThreadQueue *queue)
	Returns true if the queue is full and when the size is not RZ_THREAD_QUEUE_UNLIMITED (thread-safe) More...

Function Documentation

rz_th_queue_free()

RZ_API void rz_th_queue_free

(

RZ_NULLABLE RzThreadQueue *

queue

)

Frees a RzThreadQueue structure.

Parameters

queue

The RzThreadQueue to free

Definition at line 55 of file thread_queue.c.

                                                               {
    if (!queue) {
        return;
    }
 
    rz_list_free(queue->list);
    rz_th_lock_free(queue->lock);
    rz_th_cond_free(queue->cond);
    free(queue);
}

References free(), queue, rz_list_free(), rz_th_cond_free(), and rz_th_lock_free().

Referenced by rz_bin_file_strings(), and rz_th_queue_new().

rz_th_queue_is_empty()

RZ_API bool rz_th_queue_is_empty

(

RZ_NONNULL RzThreadQueue *

queue

)

Returns true if the queue is empty (thread-safe)

Parameters

queue

The RzThreadQueue to check

Returns

When empty returns true, otherwise false

Definition at line 148 of file thread_queue.c.

                                                                  {
    rz_return_val_if_fail(queue, false);
 
    rz_th_lock_enter(queue->lock);
    bool is_empty = rz_list_empty(queue->list);
    rz_th_lock_leave(queue->lock);
    return is_empty;
}

References queue, rz_return_val_if_fail, rz_th_lock_enter(), and rz_th_lock_leave().

rz_th_queue_is_full()

RZ_API bool rz_th_queue_is_full

(

RZ_NONNULL RzThreadQueue *

queue

)

Returns true if the queue is full and when the size is not RZ_THREAD_QUEUE_UNLIMITED (thread-safe)

Parameters

queue

The RzThreadQueue to check

Returns

When full returns true, otherwise false

Definition at line 164 of file thread_queue.c.

                                                                 {
    rz_return_val_if_fail(queue, false);
 
    rz_th_lock_enter(queue->lock);
    bool is_full = queue->max_size != RZ_THREAD_QUEUE_UNLIMITED && rz_list_length(queue->list) >= queue->max_size;
    rz_th_lock_leave(queue->lock);
    return is_full;
}

References queue, rz_list_length(), rz_return_val_if_fail, rz_th_lock_enter(), rz_th_lock_leave(), and RZ_THREAD_QUEUE_UNLIMITED.

rz_th_queue_new()

RZ_API RZ_OWN RzThreadQueue* rz_th_queue_new	(	size_t	max_size,
		RZ_NULLABLE RzListFree	qfree
	)

Allocates and initializes a new fifo queue.

Parameters

max_size	The maximum size of the queue, use RZ_THREAD_QUEUE_UNLIMITED for an unlimited size
qfree	Pointer to a custom free function to free the queue if not empty.

Returns

On success returns a valid pointer, otherwise NULL

Definition at line 32 of file thread_queue.c.

                                                                                            {
    RzThreadQueue *queue = RZ_NEW0(RzThreadQueue);
    if (!queue) {
        return NULL;
    }
 
    queue->max_size = max_size;
    queue->list = rz_list_newf(qfree);
    queue->lock = rz_th_lock_new(false);
    queue->cond = rz_th_cond_new();
    if (!queue->list || !queue->lock || !queue->cond) {
        rz_th_queue_free(queue);
        return NULL;
    }
 
    return queue;
}

References NULL, queue, rz_list_newf(), RZ_NEW0, rz_th_cond_new(), rz_th_lock_new(), and rz_th_queue_free().

Referenced by rz_bin_file_strings().

rz_th_queue_pop()

RZ_API RZ_OWN void* rz_th_queue_pop	(	RZ_NONNULL RzThreadQueue *	queue,
		bool	tail
	)

Removes an element from the queue, but does not awaits when empty.

Parameters

queue	The RzThreadQueue to push to
tail	When true, pops the element from the tail, otherwise from the head

Returns

On success returns a valid pointer, otherwise NULL

Definition at line 102 of file thread_queue.c.

                                                                                {
    rz_return_val_if_fail(queue, NULL);
 
    void *user = NULL;
    rz_th_lock_enter(queue->lock);
    if (tail) {
        user = rz_list_pop(queue->list);
    } else {
        user = rz_list_pop_head(queue->list);
    }
    rz_th_lock_leave(queue->lock);
    return user;
}

References NULL, queue, rz_list_pop(), rz_list_pop_head(), rz_return_val_if_fail, rz_th_lock_enter(), and rz_th_lock_leave().

Referenced by search_string_thread_runner().

rz_th_queue_push()

RZ_API bool rz_th_queue_push	(	RZ_NONNULL RzThreadQueue *	queue,
		RZ_NONNULL void *	user,
		bool	tail
	)

Pushes a new element into the queue.

Parameters

queue	The RzThreadQueue to push to
user	The non-null pointer to push to the queue
tail	When true, appends the element to the tail, otherwise to the head

Returns

On success returns true, otherwise false

Definition at line 75 of file thread_queue.c.

                                                                                                {
    rz_return_val_if_fail(queue && user, false);
 
    bool added = false;
    rz_th_lock_enter(queue->lock);
    if (!queue->max_size || rz_list_length(queue->list) < queue->max_size) {
        if (tail) {
            added = rz_list_append(queue->list, user) != NULL;
        } else {
            added = rz_list_prepend(queue->list, user) != NULL;
        }
    }
    if (added) {
        rz_th_cond_signal(queue->cond);
    }
    rz_th_lock_leave(queue->lock);
    return added;
}

References NULL, queue, rz_list_append(), rz_list_length(), rz_list_prepend(), rz_return_val_if_fail, rz_th_cond_signal(), rz_th_lock_enter(), and rz_th_lock_leave().

Referenced by rz_bin_file_strings().

rz_th_queue_wait_pop()

RZ_API RZ_OWN void* rz_th_queue_wait_pop	(	RZ_NONNULL RzThreadQueue *	queue,
		bool	tail
	)

Removes an element from the queue, but yields the thread till not empty.

Parameters

queue	The RzThreadQueue to push to
tail	When true, pops the element from the tail, otherwise from the head

Returns

On success returns a valid pointer, otherwise NULL

Definition at line 124 of file thread_queue.c.

                                                                                     {
    rz_return_val_if_fail(queue, NULL);
 
    void *user = NULL;
    rz_th_lock_enter(queue->lock);
    if (rz_list_empty(queue->list)) {
        rz_th_cond_wait(queue->cond, queue->lock);
    }
    if (tail) {
        user = rz_list_pop(queue->list);
    } else {
        user = rz_list_pop_head(queue->list);
    }
    rz_th_lock_leave(queue->lock);
    return user;
}

References NULL, queue, rz_list_pop(), rz_list_pop_head(), rz_return_val_if_fail, rz_th_cond_wait(), rz_th_lock_enter(), and rz_th_lock_leave().