thread_cond.c File Reference

#include "thread.h"

Go to the source code of this file.

Functions
RZ_API RZ_OWN RzThreadCond *	rz_th_cond_new (void)
	Condition variables are intended to be used to communicate changes in the state of data shared between threads. Condition variables are always associated with a mutex to provide synchronized access to the shared data. More...
RZ_API void	rz_th_cond_signal (RZ_NONNULL RzThreadCond *cond)
	This function shall unblock at least one of the threads that are blocked on the specified condition. More...
RZ_API void	rz_th_cond_signal_all (RZ_NONNULL RzThreadCond *cond)
	This function shall unblock all threads currently blocked on the specified condition. More...
RZ_API void	rz_th_cond_wait (RZ_NONNULL RzThreadCond *cond, RZ_NONNULL RzThreadLock *lock)
	The function shall block on a condition variable and shall be called with RzThreadLock locked by the calling thread. More...
RZ_API void	rz_th_cond_free (RZ_NULLABLE RzThreadCond *cond)
	Frees a RzThreadCond struct. More...

Function Documentation

rz_th_cond_free()

RZ_API void rz_th_cond_free

(

RZ_NULLABLE RzThreadCond *

cond

)

Frees a RzThreadCond struct.

Parameters

cond	The RzThreadCond to free

Definition at line 77 of file thread_cond.c.

                                                            {
    if (!cond) {
        return;
    }
#if HAVE_PTHREAD
    pthread_cond_destroy(&cond->cond);
#endif
    free(cond);
}

References cond, and free().

Referenced by rz_test_main(), rz_th_queue_free(), and task_free().

rz_th_cond_new()

RZ_API RZ_OWN RzThreadCond* rz_th_cond_new

(

void

)

Condition variables are intended to be used to communicate changes in the state of data shared between threads. Condition variables are always associated with a mutex to provide synchronized access to the shared data.

Returns

On success returns a valid pointer to a RzThreadCond structure.

Definition at line 13 of file thread_cond.c.

                                                 {
    RzThreadCond *cond = RZ_NEW0(RzThreadCond);
    if (!cond) {
        return NULL;
    }
#if HAVE_PTHREAD
    if (pthread_cond_init(&cond->cond, NULL) != 0) {
        free(cond);
        return NULL;
    }
#elif __WINDOWS__
    InitializeConditionVariable(&cond->cond);
#endif
    return cond;
}

References cond, free(), NULL, and RZ_NEW0.

Referenced by rz_core_task_new(), rz_test_main(), and rz_th_queue_new().

rz_th_cond_signal()

RZ_API void rz_th_cond_signal

(

RZ_NONNULL RzThreadCond *

cond

)

This function shall unblock at least one of the threads that are blocked on the specified condition.

Parameters

cond	The RzThreadCond to use for signalling a waiting thread

Definition at line 34 of file thread_cond.c.

                                                             {
    rz_return_if_fail(cond);
#if HAVE_PTHREAD
    pthread_cond_signal(&cond->cond);
#elif __WINDOWS__
    WakeConditionVariable(&cond->cond);
#endif
}

References cond, and rz_return_if_fail.

Referenced by rz_core_task_schedule(), rz_th_queue_push(), and worker_th().

rz_th_cond_signal_all()

RZ_API void rz_th_cond_signal_all

(

RZ_NONNULL RzThreadCond *

cond

)

This function shall unblock all threads currently blocked on the specified condition.

Parameters

cond	The RzThreadCond to use for signalling all waiting threads

Definition at line 48 of file thread_cond.c.

                                                                 {
    rz_return_if_fail(cond);
#if HAVE_PTHREAD
    pthread_cond_broadcast(&cond->cond);
#elif __WINDOWS__
    WakeAllConditionVariable(&cond->cond);
#endif
}

References cond, and rz_return_if_fail.

rz_th_cond_wait()

RZ_API void rz_th_cond_wait	(	RZ_NONNULL RzThreadCond *	cond,
		RZ_NONNULL RzThreadLock *	lock
	)

The function shall block on a condition variable and shall be called with RzThreadLock locked by the calling thread.

Parameters

cond	The RzThreadCond to use for waiting the signal
lock	The RzThreadLock lock to use (the lock must be already taken by the thread)

Definition at line 63 of file thread_cond.c.

                                                                                          {
    rz_return_if_fail(cond);
#if HAVE_PTHREAD
    pthread_cond_wait(&cond->cond, &lock->lock);
#elif __WINDOWS__
    SleepConditionVariableCS(&cond->cond, &lock->lock, INFINITE);
#endif
}

References cond, lock(), and rz_return_if_fail.

Referenced by rz_core_task_schedule(), rz_test_main(), rz_th_queue_wait_pop(), and task_wakeup().