msg_queues.h

Go to the documentation of this file.

 
#ifndef MSG_QUEUES_H_
#define MSG_QUEUES_H_
 
#include <osal.h>
 
typedef uint16_t MSG_SIZE; 
typedef uint16_t MSG_ID;   
typedef uint16_t MSG_TYPE; 
typedef void (*MSG_FREE)(void *); 
typedef void *(*MSG_ALLOC)(size_t); 
#ifndef MSG_QUEUE_MALLOC
#define MSG_QUEUE_MALLOC OS_MALLOC_FUNC
#endif
 
#ifndef MSG_QUEUE_FREE
#define MSG_QUEUE_FREE OS_FREE_FUNC
#endif
 
typedef struct content_allocator {
        MSG_ALLOC content_alloc; 
        MSG_FREE content_free;   
} content_allocator;
 
#if CONFIG_MSG_QUEUE_USE_ALLOCATORS
 
#define DEFAULT_OS_ALLOCATOR (&default_os_allocator)
extern const content_allocator default_os_allocator;
 
#else
 
#define DEFAULT_OS_ALLOCATOR NULL
 
#endif
 
typedef struct msq_queue {
        OS_QUEUE queue;                
#if CONFIG_MSG_QUEUE_USE_ALLOCATORS
        content_allocator *allocator;  
#endif
} msg_queue;
 
typedef struct msg {
        MSG_ID id;        
        MSG_TYPE type;    
        MSG_SIZE size;    
        uint8_t *data;    
        MSG_FREE free_cb; 
} msg;
 
void msg_queue_create(msg_queue *queue, int queue_size, content_allocator *allocator);
 
void msg_queue_delete(msg_queue *queue);
 
int msg_queue_put(msg_queue *queue, msg *msg, OS_TICK_TIME timeout);
 
int msg_queue_get(msg_queue *queue, msg *msg, OS_TICK_TIME timeout);
 
void msg_init(msg *msg, MSG_ID id, MSG_TYPE type, void *buf, MSG_SIZE size, MSG_FREE free_cb);
 
void msg_release(msg *msg);
 
int msg_queue_init_msg(msg_queue *queue, msg *msg, MSG_ID id, MSG_TYPE type, MSG_SIZE size);
 
int msg_queue_send(msg_queue *queue, MSG_ID id, MSG_TYPE type, void *buf, MSG_SIZE size,
                                                                        OS_TICK_TIME timeout);
 
int msq_queue_send_zero_copy(msg_queue *queue, MSG_ID id, MSG_TYPE type, void *buf,
                                        MSG_SIZE size, OS_TICK_TIME timeout, MSG_FREE free_cb);
 
#endif /* MSG_QUEUES_H_ */