d0b8d0675e
1. remove the old msg queue and queue: i. msg queue is not a common and reusable/flexible component(need user to config the msg pool size and this componet can only be used by tos_queue) ii. tos_queue can only deliver the pointer message(cannot do a memory buffer deliver) 2. add ring queue(tos_ring_q) componet rinq queue can be reused by tos_chr_fifi/tos_msg_q/tos_mail_q as the foundational data container 3. add message queue(tos_msg_q) a little like the old queue mechanism, supply the capability to deliver a pointer message 4. add mail queue(tos_mail_q) supply the capability to deliver a memory buffer 5. add binary heap(tos_bin_heap) the basement componet to implement priority queue 6. add priority queue(tos_prio_q) can be reused by the priority message/mail queue as the foundational data container. 7. add priority message queue(tos_prio_msg_q) a message(pointer) deliver mechanism, supply the capability of delivering the message with priority(message with higher priority comes faster to the pender than with lower) 8. add priority mail queue(tos_prio_mail_q) a mail(memory buffer) deliver mechanism, supply the capability of delivering the mail with priority(mail with higher priority comes faster to the pender than with lower)
126 lines
4.7 KiB
C
126 lines
4.7 KiB
C
/*----------------------------------------------------------------------------
|
|
* Tencent is pleased to support the open source community by making TencentOS
|
|
* available.
|
|
*
|
|
* Copyright (C) 2019 THL A29 Limited, a Tencent company. All rights reserved.
|
|
* If you have downloaded a copy of the TencentOS binary from Tencent, please
|
|
* note that the TencentOS binary is licensed under the BSD 3-Clause License.
|
|
*
|
|
* If you have downloaded a copy of the TencentOS source code from Tencent,
|
|
* please note that TencentOS source code is licensed under the BSD 3-Clause
|
|
* License, except for the third-party components listed below which are
|
|
* subject to different license terms. Your integration of TencentOS into your
|
|
* own projects may require compliance with the BSD 3-Clause License, as well
|
|
* as the other licenses applicable to the third-party components included
|
|
* within TencentOS.
|
|
*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef _TOS_MAIL_QUEUE_H_
|
|
#define _TOS_MAIL_QUEUE_H_
|
|
|
|
#if TOS_CFG_MAIL_QUEUE_EN > 0u
|
|
|
|
typedef struct k_mail_queue_st {
|
|
pend_obj_t pend_obj;
|
|
k_ring_q_t ring_q;
|
|
} k_mail_q_t;
|
|
|
|
/**
|
|
* @brief Create a mail queue.
|
|
* create a mail queue.
|
|
*
|
|
* @attention a MAIL is a buffer with a certain size.
|
|
*
|
|
* @param[in] mail_q pointer to the handler of the mail queue.
|
|
* @param[in] pool pool buffer of the mail queue.
|
|
* @param[in] mail_cnt mail count of the mail queue.
|
|
* @param[in] mail_size size of each mail in the mail queue.
|
|
*
|
|
* @return errcode
|
|
* @retval #K_ERR_NONE return successfully.
|
|
*/
|
|
__API__ k_err_t tos_mail_q_create(k_mail_q_t *mail_q, void *pool, size_t mail_cnt, size_t mail_size);
|
|
|
|
/**
|
|
* @brief Destroy a mail queue.
|
|
* destroy a mail queue.
|
|
*
|
|
* @attention None
|
|
*
|
|
* @param[in] mail_q pointer to the handler of the mail queue.
|
|
*
|
|
* @return errcode
|
|
* @retval #K_ERR_NONE return successfully.
|
|
*/
|
|
__API__ k_err_t tos_mail_q_destroy(k_mail_q_t *mail_q);
|
|
|
|
/**
|
|
* @brief Flush the mail queue.
|
|
* flush the mail queue.
|
|
*
|
|
* @attention None
|
|
*
|
|
* @param[in] mail_q pointer to the handler of the mail queue.
|
|
*
|
|
* @return errcode
|
|
* @retval #K_ERR_NONE return successfully.
|
|
*/
|
|
__API__ k_err_t tos_mail_q_flush(k_mail_q_t *mail_q);
|
|
|
|
/**
|
|
* @brief Pend a mail queue.
|
|
* pend a mail queue.
|
|
*
|
|
* @attention we WILL perform a memcpy when mail_buf is received(a MAIL is a buffer with a certain size).
|
|
*
|
|
* @param[in] mail_q pointer to the handler of the mail queue.
|
|
* @param[OUT] mail_buf a pointer to the mail buffer we wanna receive.
|
|
* @param[OUT] mail_size size of the mail buffer received(should be consistent with the mail_size passed to tos_mail_q_create).
|
|
* @param[in] timeout how much time(in k_tick_t) we would like to wait.
|
|
*
|
|
* @return errcode
|
|
* @retval #K_ERR_PEND_NOWAIT we get nothing, and we don't wanna wait.
|
|
* @retval #K_ERR_PEND_SCHED_LOCKED we can wait, but scheduler is locked.
|
|
* @retval #K_ERR_PEND_TIMEOUT the time we wait is up, we get nothing.
|
|
* @retval #K_ERR_PEND_DESTROY the queue we are pending is destroyed.
|
|
* @retval #K_ERR_NONE return successfully.
|
|
*/
|
|
__API__ k_err_t tos_mail_q_pend(k_mail_q_t *mail_q, void *mail_buf, size_t *mail_size, k_tick_t timeout);
|
|
|
|
/**
|
|
* @brief Post a mail queue.
|
|
* post a mail queue and wakeup one pending task.
|
|
*
|
|
* @attention when tos_mail_q_post return successfully, only one task who are waitting for the mail queue will be woken up.
|
|
*
|
|
* @param[in] mail_q pointer to the handler of the mail queue.
|
|
* @param[in] mail_buf the mail to post(a MAIL is a buffer).
|
|
* @param[in] mail_size the size of the mail to post(a MAIL is just a buffer).
|
|
*
|
|
* @return errcode
|
|
* @retval #K_ERR_RING_Q_FULL the mail queue is full.
|
|
* @retval #K_ERR_NONE return successfully.
|
|
*/
|
|
__API__ k_err_t tos_mail_q_post(k_mail_q_t *mail_q, void *mail_buf, size_t mail_size);
|
|
|
|
/**
|
|
* @brief Post a mail queue.
|
|
* post a mail queue and wakeup all the pending task.
|
|
*
|
|
* @attention when tos_mail_q_post_all return successfully, all of the tasks who are waitting for the message queue will be woken up.
|
|
*
|
|
* @param[in] mail_q pointer to the handler of the mail queue.
|
|
* @param[in] mail_buf the mail to post(a MAIL is a buffer).
|
|
* @param[in] mail_size the size of the mail to post(a MAIL is just a buffer).
|
|
*
|
|
* @return errcode
|
|
* @retval #K_ERR_RING_Q_FULL the mail queue is full.
|
|
* @retval #K_ERR_NONE return successfully.
|
|
*/
|
|
__API__ k_err_t tos_mail_q_post_all(k_mail_q_t *mail_q, void *mail_buf, size_t mail_size);
|
|
|
|
#endif
|
|
|
|
#endif /* _TOS_MAIL_QUEUE_H_ */
|
|
|