fixed small documentation typo
[senf.git] / Socket / DVBFrontendHandle.hh
1 // $Id$
2 //
3 // Copyright (C) 2007
4 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
5 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
6 //     Stefan Bund <stefan.bund@fokus.fraunhofer.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 DVBHandles
25  */
26
27 #ifndef HH_DVBFrontendHandle_
28 #define HH_DVBFrontendHandle_ 1
29
30 // Custom includes
31 #include "BufferingPolicy.hh"
32 #include "FramingPolicy.hh"
33 #include "CommunicationPolicy.hh"
34 #include "ReadWritePolicy.hh"
35 #include "ProtocolClientSocketHandle.hh"
36 #include "SocketProtocol.hh"
37
38 #include <linux/dvb/frontend.h> 
39
40 //#include "DVBFrontendHandle.mpp"
41 ///////////////////////////////hh.p////////////////////////////////////////
42
43 namespace senf {
44
45     /// \addtogroup concrete_protocol_group
46     /// @{
47
48     typedef MakeSocketPolicy<
49         NoAddressingPolicy,
50         DatagramFramingPolicy,
51         UnconnectedCommunicationPolicy,
52         NotReadablePolicy,
53         NotWriteablePolicy,
54         NoBufferingPolicy
55         >::policy DVBFrontend_Policy;   ///< Socket Policy for xxxx
56
57     /** \brief xxx
58      */
59     class DVBFrontendProtocol
60         : public ConcreteSocketProtocol<DVBFrontend_Policy>
61     {
62     public:
63         ///////////////////////////////////////////////////////////////////////////
64         // internal interface
65
66         ///\name Constructors
67         ///@{
68
69         void init_client() const;       ///< xxx
70                                         /**< \note This member is implicitly called from the
71                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
72                                              constructor */
73
74         ///@}
75         ///\name Abstract Interface Implementation
76         
77         unsigned available() const;
78         bool eof() const;
79
80         std::auto_ptr<SocketProtocol> clone() const;
81
82         ///@}
83         
84         void signalStrength(int16_t *strength) const;
85     };
86
87     typedef ProtocolClientSocketHandle<DVBFrontendProtocol> DVBFrontendHandle;
88
89 }
90
91
92 ///////////////////////////////hh.e////////////////////////////////////////
93 //#include "DVBFrontendHandle.cci"
94 //#include "DVBFrontendHandle.ct"
95 //#include "DVBFrontendHandle.cti"
96 #endif
97
98 \f
99 // Local Variables:
100 // mode: c++
101 // fill-column: 100
102 // c-file-style: "senf"
103 // indent-tabs-mode: nil
104 // ispell-local-dictionary: "american"
105 // compile-command: "scons -u test"
106 // comment-column: 40
107 // End: