rgv-kinco/rt-thread/components/cplusplus/Mail.h

/*
 * Copyright (c) 2006-2018, RT-Thread Development Team
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Change Logs:
 * Date           Author       Notes
 * 2016/10/1      Bernard      The first version
 */

#pragma once

#include <stdint.h>
#include <string.h>

#include <rtthread.h>

namespace rtthread {

/**
 * The Mail class allow to control, send, receive, or wait for mail.
 * A mail is a memory block that is send to a thread or interrupt service routine.
 * @param  T         data type of a single message element.
 * @param  queue_sz  maximum number of messages in queue.
 */

template<typename T, uint32_t queue_sz>
class Mail {
public:
    /** Create and Initialise Mail queue. */
    Mail(const char *name = "")
    {
        rt_mb_init(&mID, name, mPool, queue_sz, RT_IPC_FLAG_FIFO);
    }

    ~Mail()
    {
        rt_mb_detach(&mID);
    }

    /** Put a mail in the queue.
      @param   mptr  memory block previously allocated with Mail::alloc or Mail::calloc.
      @return  status code that indicates the execution status of the function.
    */
    bool put(T *mptr, int32_t millisec = 0)
    {
        rt_int32_t tick;

        if (millisec < 0)
            tick = -1;
        else
            tick = rt_tick_from_millisecond(millisec);

        return rt_mb_send_wait(&mID, (rt_uint32_t)mptr, tick) == RT_EOK;
    }

    /** Get a mail from a queue.
      @param   millisec  timeout value or 0 in case of no time-out. (default: osWaitForever).
      @return  event that contains mail information or error code.
    */
    T* get(int32_t millisec = -1)
    {
        T *t = NULL;
        rt_int32_t tick;

        if (millisec < 0)
            tick = -1;
        else
            tick = rt_tick_from_millisecond(millisec);

        rt_mb_recv(&mID, &t, tick);

        return t;
    }

private:
    struct rt_mailbox mID;
    T* mPool[queue_sz];
};

}