GNU Radio 3.6.3 C++ API
msg_accepter.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2009 Free Software Foundation, Inc.
4  *
5  * This file is part of GNU Radio
6  *
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3, or (at your option)
10  * any later version.
11  *
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License along
18  * with this program; if not, write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20  */
21 #ifndef INCLUDED_GRUEL_MSG_ACCEPTER_H
22 #define INCLUDED_GRUEL_MSG_ACCEPTER_H
23 
24 #include <gruel/api.h>
25 #include <gruel/pmt.h>
26 #include <boost/shared_ptr.hpp>
27 
28 namespace gruel {
29 
30  /*!
31  * \brief Virtual base class that accepts messages
32  */
34  {
35  public:
37  virtual ~msg_accepter();
38 
39  /*!
40  * \brief send \p msg to \p msg_accepter on port \p which_port
41  *
42  * Sending a message is an asynchronous operation. The \p post
43  * call will not wait for the message either to arrive at the
44  * destination or to be received.
45  */
46  virtual void post(pmt::pmt_t which_port, pmt::pmt_t msg) = 0;
47  };
48 
49  typedef boost::shared_ptr<msg_accepter> msg_accepter_sptr;
50 
51 } /* namespace gruel */
52 
53 #endif /* INCLUDED_GRUEL_MSG_ACCEPTER_H */