senf/Socket/Protocols/DVB/DVBDemuxSocketProtocol.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 //
   6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
   7 // Version 1.0 (the "License"); you may not use this file except in compliance
   8 // with the License. You may obtain a copy of the License at
   9 // http://senf.berlios.de/license.html
  10 //
  11 // The Fraunhofer FOKUS Public License Version 1.0 is based on,
  12 // but modifies the Mozilla Public License Version 1.1.
  13 // See the full license text for the amendments.
  14 //
  15 // Software distributed under the License is distributed on an "AS IS" basis,
  16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  17 // for the specific language governing rights and limitations under the License.
  18 //
  19 // The Original Code is Fraunhofer FOKUS code.
  20 //
  21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
  22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
  23 // All Rights Reserved.
  24 //
  25 // Contributor(s):
  26 //   Thorsten Horstmann <tho@berlios.de>
  27
  28 /** \file
  29     \brief DVBDemuxSocketProtocol public header */
  30
  31 #ifndef HH_SENF_Socket_Protocols_DVB_DVBDemuxSocketProtocol_
  32 #define HH_SENF_Socket_Protocols_DVB_DVBDemuxSocketProtocol_ 1
  33
  34 #include <linux/dvb/dmx.h>
  35
  36 // Custom includes
  37 #include <senf/Socket/SocketProtocol.hh>
  38
  39 //#include "DVBSocketProtocol.mpp"
  40 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  41
  42 namespace senf {
  43
  44     /// \addtogroup protocol_facets_group
  45     //\{
  46
  47     /** \todo Document me!
  48      */
  49     class DVBDemuxSocketProtocol
  50         : public virtual SocketProtocol
  51     {
  52     public:
  53         void setBufferSize(unsigned long size) const;
  54                                 ///< set the size of the circular buffer used for filtered data.
  55                                 /**< The default size is two maximum sized sections, i.e. if this
  56                                      function is not called a buffer size of 2 * 4096 bytes will
  57                                      be used.
  58                                      \param[in] size Size of circular buffer. */
  59         void startFiltering() const;
  60         void stopFiltering() const;
  61
  62         ///\name Abstract Interface Implementation
  63         //\{
  64
  65         bool eof() const;
  66
  67         //\}
  68     };
  69
  70     //\}
  71 }
  72
  73 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  74 //#include "DVBDemuxSocketProtocol.cci"
  75 //#include "DVBDemuxSocketProtocol.ct"
  76 //#include "DVBDemuxSocketProtocol.cti"
  77 #endif
  78
  79 \f
  80 // Local Variables:
  81 // mode: c++
  82 // fill-column: 100
  83 // c-file-style: "senf"
  84 // indent-tabs-mode: nil
  85 // ispell-local-dictionary: "american"
  86 // compile-command: "scons -u test"
  87 // comment-column: 40
  88 // End: