git.gag.com Git - debian/gnuradio/blob - vrt/lib/data_handler.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2008,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_VRT_DATA_HANDLER_H
  22 #define INCLUDED_VRT_DATA_HANDLER_H
  23
  24 #include <stdint.h>
  25 #include <stddef.h>
  26
  27 namespace vrt {
  28
  29   /*!
  30    * \brief Abstract function object called to handle received data blocks.
  31    */
  32   class data_handler
  33   {
  34   public:
  35
  36     enum result_bits {
  37       DONE      = 0x0002,       //< do not call this object again
  38     };
  39
  40     typedef int result;         //< bitmask of result_bits
  41
  42     /*!
  43      * \param base points to the beginning of the data
  44      * \param len is the length in bytes of the data
  45      * \returns bitmask composed of DONE
  46      */
  47     virtual result operator()(const void *base, size_t len) = 0;
  48     virtual ~data_handler();
  49   };
  50
  51 } // namespace vrt
  52
  53 #endif /* INCLUDED_VRT_DATA_HANDLER_H */