git.gag.com Git - debian/gnuradio/blob - mblock/src/lib/mb_message.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2006,2007 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 2, 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_MESSAGE_H
  22 #define INCLUDED_MB_MESSAGE_H
  23
  24 #include <mb_common.h>
  25
  26 class mb_message;
  27 typedef boost::shared_ptr<mb_message> mb_message_sptr;
  28
  29 /*!
  30  * \brief construct a message and return boost::shared_ptr
  31  *
  32  * \param signal        identifier of the message
  33  * \param data          the data to be operated on
  34  * \param metadata      information about the data
  35  * \param priority      urgency
  36  */
  37 mb_message_sptr
  38 mb_make_message(pmt_t signal,
  39                 pmt_t data = PMT_NIL,
  40                 pmt_t metadata = PMT_NIL,
  41                 mb_pri_t priority = MB_PRI_DEFAULT);
  42
  43 class mb_message {
  44   mb_message_sptr d_next;               // link field for msg queue
  45   pmt_t           d_signal;
  46   pmt_t           d_data;
  47   pmt_t           d_metadata;
  48   mb_pri_t        d_priority;
  49   pmt_t           d_port_id;            // name of port msg was rcvd on (symbol)
  50
  51   friend class mb_msg_queue;
  52
  53   friend mb_message_sptr
  54   mb_make_message(pmt_t signal, pmt_t data, pmt_t metadata, mb_pri_t priority);
  55
  56   // private constructor
  57   mb_message(pmt_t signal, pmt_t data, pmt_t metadata, mb_pri_t priority);
  58
  59 public:
  60   ~mb_message();
  61
  62   pmt_t signal() const { return d_signal; }
  63   pmt_t data() const { return d_data; }
  64   pmt_t metadata() const { return d_metadata; }
  65   mb_pri_t priority() const { return d_priority; }
  66   pmt_t port_id() const { return d_port_id; }
  67
  68   void set_port_id(pmt_t port_id){ d_port_id = port_id; }
  69 };
  70
  71 #endif /* INCLUDED_MB_MESSAGE_H */