summaryrefslogtreecommitdiff
path: root/gnuradio-runtime/include/gnuradio/messages/msg_passing.h
blob: f888eb1b211a82cd5cc187b5f8ba51931214cab9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
/* -*- c++ -*- */
/*
 * Copyright 2009,2013 Free Software Foundation, Inc.
 *
 * This file is part of GNU Radio
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 */

#ifndef INCLUDED_MSG_PASSING_H
#define INCLUDED_MSG_PASSING_H

/*!
 * \brief Include this header to use the message passing features
 */

#include <gnuradio/api.h>
#include <gnuradio/messages/msg_accepter.h>
#include <pmt/pmt.h>

namespace gr {
namespace messages {

/*!
 * \brief send message to msg_accepter
 *
 * \param accepter is the target of the send.
 * \param which_port A pmt symbol describing the port by name.
 * \param msg is the message to send. It's usually a pmt tuple.
 *
 * Sending a message is an asynchronous operation. The \p send
 * call will not wait for the message either to arrive at the
 * destination or to be received.
 *
 * \returns msg
 */
static inline pmt::pmt_t
send(msg_accepter_sptr accepter, const pmt::pmt_t& which_port, const pmt::pmt_t& msg)
{
    accepter->post(which_port, msg);
    return msg;
}

/*!
 * \brief send message to msg_accepter
 *
 * \param accepter is the target of the send.
 * \param which_port A pmt symbol describing the port by name.
 * \param msg is the message to send. It's usually a pmt tuple.
 *
 * Sending a message is an asynchronous operation. The \p send
 * call will not wait for the message either to arrive at the
 * destination or to be received.
 *
 * \returns msg
 */
static inline pmt::pmt_t
send(msg_accepter* accepter, const pmt::pmt_t& which_port, const pmt::pmt_t& msg)
{
    accepter->post(which_port, msg);
    return msg;
}

/*!
 * \brief send message to msg_accepter
 *
 * \param accepter is the target of the send.
 * \param which_port A pmt symbol describing the port by name.
 * \param msg is the message to send.  It's usually a pmt tuple.
 *
 * Sending a message is an asynchronous operation.  The \p send
 * call will not wait for the message either to arrive at the
 * destination or to be received.
 *
 * \returns msg
 */
static inline pmt::pmt_t
send(msg_accepter& accepter, const pmt::pmt_t& which_port, const pmt::pmt_t& msg)
{
    accepter.post(which_port, msg);
    return msg;
}

/*!
 * \brief send message to msg_accepter
 *
 * \param accepter is the target of the send.
 *        aprecond: pmt::is_msg_accepter(accepter)
 * \param which_port A pmt symbol describing the port by name.
 * \param msg is the message to send.  It's usually a pmt tuple.
 *
 * Sending a message is an asynchronous operation. The \p send
 * call will not wait for the message either to arrive at the
 * destination or to be received.
 *
 * \returns msg
 */
static inline pmt::pmt_t
send(pmt::pmt_t accepter, const pmt::pmt_t& which_port, const pmt::pmt_t& msg)
{
    return send(pmt::msg_accepter_ref(accepter), which_port, msg);
}

} /* namespace messages */
} /* namespace gr */

#endif /* INCLUDED_MSG_PASSING_H */