thread_api.h

Go to the documentation of this file.

/*
    MIT License
 
    Copyright (c) 2025 Robin A. Onsay
 
    Permission is hereby granted, free of charge, to any person obtaining
    a copy of this software and associated documentation files
    (the "Software"), to deal in the Software without restriction,
    including without limitation the rights to use, copy, modify, merge,
    publish, distribute, sublicense, and/or sell copies of the Software,
    and to permit persons to whom the Software is furnished to do so,
    subject to the following conditions:
 
    The above copyright notice and this permission notice shall be
    included in all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
    IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
    CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
    TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
    SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
 
#ifndef JUNO_THREAD_API_H
#define JUNO_THREAD_API_H
 
#include <stdint.h>
#include <stdbool.h>
#include "juno/status.h"
#include "juno/module.h"
#include "juno/types.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
/* -------------------------------------------------------------------------
 * Forward declarations
 * ---------------------------------------------------------------------- */
 
typedef struct JUNO_THREAD_ROOT_TAG JUNO_THREAD_ROOT_T;
 
typedef struct JUNO_THREAD_API_TAG  JUNO_THREAD_API_T;
 
typedef struct JUNO_THREAD_LINUX_TAG JUNO_THREAD_LINUX_T;
 
typedef union  JUNO_THREAD_TAG      JUNO_THREAD_T;
 
/* -------------------------------------------------------------------------
 * Module root
 * ---------------------------------------------------------------------- */
 
// @{"req": ["REQ-THREAD-001", "REQ-THREAD-007", "REQ-THREAD-008", "REQ-THREAD-009"]}
struct JUNO_THREAD_ROOT_TAG JUNO_MODULE_ROOT(JUNO_THREAD_API_T,
    volatile bool bStop;
);
 
/* -------------------------------------------------------------------------
 * Vtable
 * ---------------------------------------------------------------------- */
 
// @{"req": ["REQ-THREAD-002", "REQ-THREAD-014"]}
struct JUNO_THREAD_API_TAG
{
    JUNO_STATUS_T (*Stop)(JUNO_THREAD_ROOT_T *ptRoot);
 
    JUNO_STATUS_T (*Join)(JUNO_THREAD_ROOT_T *ptRoot);
 
    JUNO_STATUS_T (*Free)(JUNO_THREAD_ROOT_T *ptRoot);
};
 
/* -------------------------------------------------------------------------
 * Generic initialisation
 * ---------------------------------------------------------------------- */
 
JUNO_STATUS_T JunoThread_Init(
    JUNO_THREAD_ROOT_T          *ptRoot,
    const JUNO_THREAD_API_T     *ptApi,
    JUNO_FAILURE_HANDLER_T       pfcnFailureHandler,
    void                        *pvFailureUserData
);
 
#ifdef __cplusplus
}
#endif
 
#endif /* JUNO_THREAD_API_H */