87 lines
1.7 KiB
C
87 lines
1.7 KiB
C
#ifndef __CORE_MSGQ_H__
|
|
#define __CORE_MSGQ_H__
|
|
|
|
/**
|
|
* @file core_msgq.h
|
|
* @brief Message queue header
|
|
*/
|
|
|
|
#include "core.h"
|
|
#include "core_time.h"
|
|
#include "core_errno.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
typedef c_uintptr_t msgq_id;
|
|
|
|
#define MAX_MSG_LEN 0xffff
|
|
|
|
/**
|
|
* @return CORE_OK or CORE_ERROR.
|
|
*/
|
|
CORE_DECLARE(status_t) msgq_init(void);
|
|
|
|
/**
|
|
* @return CORE_OK or CORE_ERROR.
|
|
*/
|
|
CORE_DECLARE(status_t) msgq_final(void);
|
|
|
|
#define MSGQ_O_BLOCK 0x0
|
|
#define MSGQ_O_NONBLOCK 0x1
|
|
|
|
/**
|
|
* @param id
|
|
* @param msgsize
|
|
* @param opt
|
|
*
|
|
* @return If succeed, handler value. If fail, zero
|
|
*/
|
|
CORE_DECLARE(msgq_id) msgq_create(int qsize, int msgsize, int opt);
|
|
|
|
/**
|
|
* @param id
|
|
*
|
|
* @return If succeed, CORE_OK. If fail, CORE_ERROR.
|
|
*/
|
|
CORE_DECLARE(status_t) msgq_delete(msgq_id id);
|
|
|
|
/**
|
|
* @param id
|
|
* @param msg
|
|
* @param msglen
|
|
*
|
|
* @return the number of bytes to be sent. If there is insufficient room in
|
|
* ring buffer, return CORE_EAGAIN. If any error, CORE_ERROR.
|
|
*/
|
|
CORE_DECLARE(int) msgq_send(msgq_id id, const char *msg, int msglen);
|
|
|
|
/**
|
|
* @param id
|
|
* @param msg
|
|
* @param msglen
|
|
*
|
|
* @return the number of bytes to be read. If any error, CORE_ERROR.
|
|
* If ring buffer is empty and MSGQ_O_NONBLOCK set, CORE_EAGAIN.
|
|
*/
|
|
CORE_DECLARE(int) msgq_recv(msgq_id id, char *msg, int msglen);
|
|
|
|
/**
|
|
* @param id
|
|
* @param msg
|
|
* @param msglen
|
|
*
|
|
* @return the number of bytes to be read. If any error, CORE_ERROR.
|
|
* If ring buffer is empty and MSGQ_O_NONBLOCK set, CORE_EAGAIN.
|
|
* If time out with empty buffer, CORE_TIMEUP.
|
|
*/
|
|
CORE_DECLARE(int) msgq_timedrecv(msgq_id id, char *msg, int msglen,
|
|
c_time_t timeout);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
|
|
#endif /* !__CORE_MSGQ_H__ */
|