summaryrefslogtreecommitdiff
path: root/gnuradio-runtime/include/gnuradio/messages/msg_passing.h
blob: 6ad6c40b081570fed8d193b8f0c1ff37efc9f213 (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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
/* -*- c++ -*- */
/*
 * Copyright 2009,2013 Free Software Foundation, Inc.
 *
 * This file is part of GNU Radio
 *
 * GNU Radio is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3, or (at your option)
 * any later version.
 *
 * GNU Radio is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#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 <pmt/pmt.h>
#include <gnuradio/messages/msg_accepter.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 */