senf/Socket/Protocols/DVB/DVBDemuxSocketProtocol.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Thorsten Horstmann <tho@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief DVBDemuxSocketProtocol public header */
  25
  26 #ifndef HH_SENF_Socket_Protocols_DVB_DVBDemuxSocketProtocol_
  27 #define HH_SENF_Socket_Protocols_DVB_DVBDemuxSocketProtocol_ 1
  28
  29 #include <linux/dvb/dmx.h>
  30
  31 // Custom includes
  32 #include <senf/Socket/SocketProtocol.hh>
  33
  34 //#include "DVBSocketProtocol.mpp"
  35 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  36
  37 namespace senf {
  38
  39     /// \addtogroup protocol_facets_group
  40     //\{
  41
  42     /** \todo Document me!
  43      */
  44     class DVBDemuxSocketProtocol
  45         : public virtual SocketProtocol
  46     {
  47     public:
  48         void setBufferSize(unsigned long size) const;
  49                                 ///< set the size of the circular buffer used for filtered data.
  50                                 /**< The default size is two maximum sized sections, i.e. if this
  51                                      function is not called a buffer size of 2 * 4096 bytes will
  52                                      be used.
  53                                      \param[in] size Size of circular buffer. */
  54         void startFiltering() const;
  55         void stopFiltering() const;
  56
  57         ///\name Abstract Interface Implementation
  58         //\{
  59
  60         bool eof() const;
  61
  62         //\}
  63     };
  64
  65     //\}
  66 }
  67
  68 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  69 //#include "DVBDemuxSocketProtocol.cci"
  70 //#include "DVBDemuxSocketProtocol.ct"
  71 //#include "DVBDemuxSocketProtocol.cti"
  72 #endif
  73
  74 \f
  75 // Local Variables:
  76 // mode: c++
  77 // fill-column: 100
  78 // c-file-style: "senf"
  79 // indent-tabs-mode: nil
  80 // ispell-local-dictionary: "american"
  81 // compile-command: "scons -u test"
  82 // comment-column: 40
  83 // End: