GNU Radio 3.4.0 C++ API
msg_accepter.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2009 Free Software Foundation, Inc.
00004  * 
00005  * This file is part of GNU Radio
00006  * 
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  * 
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  * 
00017  * You should have received a copy of the GNU General Public License along
00018  * with this program; if not, write to the Free Software Foundation, Inc.,
00019  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
00020  */
00021 #ifndef INCLUDED_GRUEL_MSG_ACCEPTER_H
00022 #define INCLUDED_GRUEL_MSG_ACCEPTER_H
00023 
00024 #include <gruel/pmt.h>
00025 #include <boost/shared_ptr.hpp>
00026 
00027 namespace gruel {
00028 
00029   /*!
00030    * \brief Virtual base class that accepts messages
00031    */
00032   class msg_accepter
00033   {
00034   public:
00035     msg_accepter() {};
00036     virtual ~msg_accepter();
00037 
00038     /*!
00039      * \brief send \p msg to \p msg_accepter
00040      *
00041      * Sending a message is an asynchronous operation.  The \p post
00042      * call will not wait for the message either to arrive at the
00043      * destination or to be received.
00044      */
00045     virtual void post(pmt::pmt_t msg) = 0;
00046   };
00047 
00048   typedef boost::shared_ptr<msg_accepter> msg_accepter_sptr;
00049 
00050 } /* namespace gruel */
00051 
00052 #endif /* INCLUDED_GRUEL_MSG_ACCEPTER_H */