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

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2006,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_PROTOCOL_CLASS_H
  22 #define INCLUDED_MB_PROTOCOL_CLASS_H
  23
  24 #include <mblock/common.h>
  25
  26 /*!
  27  * \brief construct a protocol_class
  28  *
  29  * \param name          the name of the class (symbol)
  30  * \param incoming      incoming message set (list of symbols)
  31  * \param outgoing      outgoing message set (list of symbols)
  32  */
  33 pmt_t mb_make_protocol_class(pmt_t name, pmt_t incoming, pmt_t outgoing);
  34
  35 // Accessors
  36 pmt_t mb_protocol_class_name(pmt_t pc);         //< return name of protocol class
  37 pmt_t mb_protocol_class_incoming(pmt_t pc);     //< return incoming message set
  38 pmt_t mb_protocol_class_outgoing(pmt_t pc);     //< return outgoing message set
  39
  40 pmt_t mb_protocol_class_lookup(pmt_t name);     //< lookup an existing protocol class by name
  41
  42
  43 /*!
  44  * \brief Initialize one or more protocol class from a serialized description.
  45  * Used by machine generated code.
  46  */
  47 class mb_protocol_class_init {
  48 public:
  49   mb_protocol_class_init(const char *data, size_t len);
  50 };
  51
  52 #endif /* INCLUDED_MB_PROTOCOL_CLASS_H */