git.gag.com Git - debian/gnuradio/blob - gruel/src/include/gruel/msg_accepter.h

   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/pmt.h>
  25 #include <boost/shared_ptr.hpp>
  26
  27 namespace gruel {
  28
  29   /*!
  30    * \brief Virtual base class that accepts messages
  31    */
  32   class msg_accepter
  33   {
  34   public:
  35     msg_accepter() {};
  36     virtual ~msg_accepter();
  37
  38     /*!
  39      * \brief send \p msg to \p msg_accepter
  40      *
  41      * Sending a message is an asynchronous operation.  The \p post
  42      * call will not wait for the message either to arrive at the
  43      * destination or to be received.
  44      */
  45     virtual void post(pmt::pmt_t msg) = 0;
  46   };
  47
  48   typedef boost::shared_ptr<msg_accepter> msg_accepter_sptr;
  49
  50 } /* namespace gruel */
  51
  52 #endif /* INCLUDED_GRUEL_MSG_ACCEPTER_H */