CAENThread.h

Go to the documentation of this file.

/******************************************************************************
*
*   CAEN SpA - Software Division
*   Via Vetraia, 11 - 55049 - Viareggio ITALY
*   +39 0594 388 398 - www.caen.it
*
*******************************************************************************
*
*   Copyright (C) 2019-2022 CAEN SpA
*
*   This file is part of the CAEN Utility.
*
*   The CAEN Utility is free software; you can redistribute it and/or
*   modify it under the terms of the GNU Lesser General Public
*   License as published by the Free Software Foundation; either
*   version 3 of the License, or (at your option) any later version.
*
*   The CAEN Utility is distributed in the hope that it will be useful,
*   but WITHOUT ANY WARRANTY; without even the implied warranty of
*   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
*   Lesser General Public License for more details.
*
*   You should have received a copy of the GNU Lesser General Public
*   License along with the CAEN Utility; if not, see
*   https://www.gnu.org/licenses/.
*
*   SPDX-License-Identifier: LGPL-3.0-or-later
*
***************************************************************************/
#ifndef CAEN_INCLUDE_CAENTHREAD_H_
#define CAEN_INCLUDE_CAENTHREAD_H_

#include <stdbool.h>
#include <time.h>

#include <types/CAENThreadTypes.h>
#include <CAENUtility.h>

#ifdef __cplusplus
extern "C" {
#endif

CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_condition_init(c_condition_t *cond);

CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_condition_destroy(c_condition_t *cond);

c_acquires_lock_on_success(cond->_critical_section)
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_condition_lock(c_condition_t *cond);

c_releases_lock_on_success(cond->_critical_section)
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_condition_unlock(c_condition_t *cond);

CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_condition_wait(c_condition_t *cond, int32_t ms);

CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_condition_signal_one(c_condition_t *cond);

CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_condition_broadcast(c_condition_t *cond);

CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_semaphore_init(c_semaphore_t *s);
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_semaphore_multi_init(c_semaphore_t *s);
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_semaphore_destroy(c_semaphore_t *s);
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_semaphore_wait(c_semaphore_t *s, int32_t ms);
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_semaphore_post(c_semaphore_t *s);
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_mutex_init(c_mutex_t *m);
c_acquires_lock_on_success(*m)
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_mutex_lock(c_mutex_t *m);
c_acquires_lock_on_success(*m) c_nodiscard
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_mutex_trylock(c_mutex_t *m);
c_releases_lock_on_success(*m)
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_mutex_unlock(c_mutex_t *m);
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_mutex_destroy(c_mutex_t *m);
CAEN_UTILITY_DLLAPI c_thread_t CAEN_UTILITY_API c_thread_invalid();

CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_thread_create(c_thread_t *thr, c_tstart_t func, void *arg);
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_thread_join(c_thread_t thr, int *res);
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_thread_timedjoin(c_thread_t thr, int *res, int32_t timeout_ms);
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_thread_setaffinity(c_thread_t thr, uint64_t mask);
CAEN_UTILITY_DLLAPI c_thread_t CAEN_UTILITY_API c_thread_current(void);
CAEN_UTILITY_DLLAPI void CAEN_UTILITY_API c_thread_yield(void);
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_thread_detach(c_thread_t thr);
c_noreturn
CAEN_UTILITY_DLLAPI void CAEN_UTILITY_API c_thread_exit(int res);
CAEN_UTILITY_DLLAPI bool CAEN_UTILITY_API c_thread_equal(c_thread_t lhs, c_thread_t rhs);
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_thread_sleep(const struct timespec* duration, struct timespec* remaining);

CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_sleep(uint32_t ms);
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_ticket_init(c_ticket_t *ticket);
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_ticket_delete(c_ticket_t *ticket);
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_ticket_lock(c_ticket_t *ticket);
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_ticket_unlock(c_ticket_t *ticket);
#ifdef __cplusplus
}
#endif

#endif // CAEN_INCLUDE_CAENTHREAD_H_