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

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2007,2008 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_MB_MSG_ACCEPTER_H
  22 #define INCLUDED_MB_MSG_ACCEPTER_H
  23
  24 #include <mblock/common.h>
  25
  26 /*!
  27  * \brief Abstract class that accepts messages
  28  *
  29  * The mb_port::send method ultimately resolves the (local)
  30  * destination of a send to an object of this type.  The resulting
  31  * object is called to deliver the message.
  32  *
  33  * Expect derived classes such as these:
  34  *
  35  *  smp      : target is visible in this address space
  36  *  mpi      : target is on the other end of an MPI link
  37  *  ppe->spe : sending from Cell PPE to Cell SPE
  38  *  spe->ppe : sending from Cell SPE to Cell PPE
  39  */
  40 class mb_msg_accepter {
  41 public:
  42   mb_msg_accepter(){};
  43   virtual ~mb_msg_accepter();
  44
  45   virtual void operator()(pmt_t signal, pmt_t data, pmt_t metadata, mb_pri_t priority) = 0;
  46 };
  47
  48 #endif /* INCLUDED_MB_MSG_ACCEPTER_H */