//
// Copyright 2011-2015 Ettus Research LLC
// Copyright 2018 Ettus Research, a National Instruments Company
//
// SPDX-License-Identifier: GPL-3.0-or-later
//

#ifndef INCLUDED_UHD_UTILS_MSG_TASK_HPP
#define INCLUDED_UHD_UTILS_MSG_TASK_HPP

#include <uhd/config.hpp>
#include <uhd/transport/zero_copy.hpp>
#include <stdint.h>
#include <boost/function.hpp>
#include <boost/optional/optional.hpp>
#include <boost/shared_ptr.hpp>
#include <uhd/utils/noncopyable.hpp>
#include <vector>

namespace uhd {
class UHD_API msg_task : uhd::noncopyable
{
public:
    typedef boost::shared_ptr<msg_task> sptr;
    typedef std::vector<uint8_t> msg_payload_t;
    typedef std::pair<uint32_t, msg_payload_t> msg_type_t;
    typedef boost::function<boost::optional<msg_type_t>(void)> task_fcn_type;

    /*
     * During shutdown message queues for radio control cores might not be available
     * anymore. Such stranded messages get pushed into a dump queue. With this function
     * radio_ctrl_core can check if one of the messages meant for it got stranded.
     */
    virtual msg_payload_t get_msg_from_dump_queue(uint32_t sid) = 0;

    UHD_INLINE static std::vector<uint8_t> buff_to_vector(uint8_t* p, size_t n)
    {
        if (p and n > 0) {
            std::vector<uint8_t> v(n);
            memcpy(&v.front(), p, n);
            return v;
        }
        return std::vector<uint8_t>();
    }

    virtual ~msg_task(void) = 0;

    /*!
     * Create a new task object with function callback.
     * The task function callback will be run in a loop.
     * until the thread is interrupted by the deconstructor.
     *
     * A function may return payload which is then pushed to
     * a synchronized message queue.
     *
     * A task should return in a reasonable amount of time
     * or may block forever under the following conditions:
     *  - The blocking call is interruptible.
     *  - The task polls the interrupt condition.
     *
     * \param task_fcn the task callback function
     * \return a new task object
     */
    static sptr make(const task_fcn_type& task_fcn);
};
} // namespace uhd

#endif /* INCLUDED_UHD_UTILS_MSG_TASK_HPP */
