git.gag.com Git - debian/gnuradio/blob - mblock/src/lib/mb_port_simple.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_PORT_SIMPLE_H
  22 #define INCLUDED_MB_PORT_SIMPLE_H
  23
  24 #include <mblock/port.h>
  25
  26 /*!
  27  * \brief Concrete port realization
  28  */
  29 class mb_port_simple : public mb_port
  30 {
  31   bool                  d_cache_valid;
  32   mb_msg_accepter_sptr  d_cached_accepter;
  33
  34 protected:
  35   static mb_msg_accepter_sptr
  36   find_accepter(mb_port_simple *start);
  37
  38   mb_msg_accepter_sptr
  39   make_accepter();
  40
  41 public:
  42   mb_port_simple(mb_mblock *mblock,
  43                  const std::string &port_name,
  44                  const std::string &protocol_class_name,
  45                  bool conjugated,
  46                  mb_port::port_type_t port_type);
  47
  48   ~mb_port_simple();
  49
  50   /*!
  51    * \brief send a message
  52    *
  53    * \param signal      the event name
  54    * \param data        optional data
  55    * \param metadata    optional metadata
  56    * \param priority    the urgency at which the message is sent
  57    */
  58   void
  59   send(pmt_t signal,
  60        pmt_t data = PMT_NIL,
  61        pmt_t metadata = PMT_NIL,
  62        mb_pri_t priority = MB_PRI_DEFAULT);
  63
  64   /*
  65    * \brief Invalidate any cached peer resolutions
  66    * \internal
  67    */
  68   void invalidate_cache();
  69
  70 };
  71
  72 #endif /* INCLUDED_MB_PORT_SIMPLE_H */