Queue.h

Go to the documentation of this file.

/******************************************************************************
* Title                 :   Queue header file  
* Filename              :   Queue.h
* Author                :   Maximiliano Valencia
* Origin Date           :   13/02/2019
* Version               :   1.0.0
* Compiler              :   gcc
* Target                :   STM32
* Notes                 :   None
******************************************************************************/
#ifndef QUEUE_H
#define QUEUE_H

/******************************************************************************
* Includes
******************************************************************************/
#include <stdio.h>
#include <stdint.h>
#include <pthread.h>

/******************************************************************************
* Preprocessor Constants
******************************************************************************/


/******************************************************************************
* Configuration Constants
******************************************************************************/


/******************************************************************************
* Macros
******************************************************************************/


/******************************************************************************
* Typedefs
******************************************************************************/
typedef uint8_t queue_array_t;

typedef struct queue_t queue_t;

struct queue_t
{
    uint16_t index;             
    uint16_t outdex;            
    uint16_t numElements;       
    queue_array_t* queueArray;  
    uint16_t queueSize;         
    uint8_t dataSize;           
    pthread_mutex_t lock;       
};

/******************************************************************************
* Variables
******************************************************************************/


/******************************************************************************
* Function Prototypes
******************************************************************************/
void queue_init(queue_t* queue,
                queue_array_t* queueArray, 
                uint16_t queueSize, 
                uint8_t dataSize);
uint8_t queue_enqueue(queue_t* queue, const void* value);
uint8_t queue_dequeue(queue_t* queue, void* value);
void queue_print(queue_t* queue, void (*printFn)(const void* data), void* data);
uint16_t queue_count(queue_t* queue);

#endif /* QUEUE_H */