xf_task_queue.h

浏览该文件的文档.

 
#ifndef __XF_TASK_QUEUE_H__
#define __XF_TASK_QUEUE_H__
 
/* ==================== [Includes] ========================================== */
 
#include "xf_utils.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ==================== [Defines] =========================================== */
 
/* ==================== [Typedefs] ========================================== */
 
typedef struct _xf_task_queue_t {
    uint8_t *head;
    uint8_t *tail;
    uint8_t *writer;
    uint8_t *reader;
    volatile size_t waiting;
    size_t count;
    size_t size;
} xf_task_queue_t;
 
typedef enum _xf_task_queue_mode_t {
    XF_TASK_QUEUE_SEND_TO_BACK, 
    XF_TASK_QUEUE_SEND_TO_FRONT 
} xf_task_queue_mode_t;
 
/* ==================== [Global Prototypes] ================================= */
 
xf_err_t xf_task_queue_init(xf_task_queue_t *const queue, void *data, const size_t size, const size_t count);
 
xf_err_t xf_task_queue_reset(xf_task_queue_t *const queue);
 
bool xf_task_queue_is_empty(const xf_task_queue_t *const queue);
 
size_t xf_task_queue_count(const xf_task_queue_t *const queue);
 
void *xf_task_queue_peek(const xf_task_queue_t *const queue);
 
size_t xf_task_queue_available(const xf_task_queue_t *const queue);
 
bool xf_task_queue_is_full(const xf_task_queue_t *const queue);
 
xf_err_t xf_task_queue_send(xf_task_queue_t *const queue, void *item, const xf_task_queue_mode_t pos);
 
xf_err_t xf_task_queue_remove_front(xf_task_queue_t *const queue);
 
xf_err_t xf_task_queue_receive(xf_task_queue_t *const queue, void *const buffer);
 
/* ==================== [Macros] ============================================ */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif // __XF_TASK_QUEUE_H__