Add missing doxygen \file comments
[senf.git] / Socket / Protocols / DVB / DVBDemuxHandles.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 DVBDemuxHandles public header */
25
26 #ifndef HH_DVBDemuxHandles_
27 #define HH_DVBDemuxHandles_ 1
28
29 // Custom includes
30 #include "Socket/BufferingPolicy.hh"
31 #include "Socket/FramingPolicy.hh"
32 #include "Socket/CommunicationPolicy.hh"
33 #include "Socket/ReadWritePolicy.hh"
34 #include "Socket/ProtocolClientSocketHandle.hh"
35 #include "DVBDemuxProtocol.hh"
36
37 //#include "DVBDemuxHandles.mpp"
38 ///////////////////////////////hh.p////////////////////////////////////////
39
40 namespace senf {
41
42     /// \addtogroup concrete_protocol_group
43     /// @{
44
45     typedef MakeSocketPolicy<
46         NoAddressingPolicy,
47         DatagramFramingPolicy,
48         UnconnectedCommunicationPolicy,
49         ReadablePolicy,
50         NotWriteablePolicy,
51         NoBufferingPolicy
52         >::policy DVBDemux_Policy;   ///< Socket Policy for xxxx
53
54     /** \brief xxx
55      */
56     class DVBDemuxSectionProtocol
57         : public ConcreteSocketProtocol<DVBDemux_Policy>,
58           public DVBDemuxProtocol
59     {
60     public:
61         ///////////////////////////////////////////////////////////////////////////
62         // internal interface
63
64         ///\name Constructors
65         ///@{
66
67         void init_client() const;       ///< xxx
68                                         /**< \note This member is implicitly called from the
69                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
70                                              constructor */
71
72         ///@}
73         ///\name Abstract Interface Implementation
74         
75         unsigned available() const;
76
77         std::auto_ptr<SocketProtocol> clone() const;
78
79         ///@}
80         
81         void setSectionFilter(struct dmx_sct_filter_params *filter) const;    
82     };
83
84     typedef ProtocolClientSocketHandle<DVBDemuxSectionProtocol> DVBDemuxSectionHandle;
85     
86     // ----------------------------------------------------------------
87     
88     /** \brief xxx
89      */
90     class DVBDemuxPESProtocol
91         : public ConcreteSocketProtocol<DVBDemux_Policy>,
92           public DVBDemuxProtocol
93     {
94     public:
95         ///////////////////////////////////////////////////////////////////////////
96         // internal interface
97
98         ///\name Constructors
99         ///@{
100
101         void init_client() const;       ///< xxx
102                                         /**< \note This member is implicitly called from the
103                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
104                                              constructor */
105
106         ///@}
107         ///\name Abstract Interface Implementation
108         
109         unsigned available() const;
110
111         std::auto_ptr<SocketProtocol> clone() const;
112
113         ///@}
114         
115         void setPESFilter(struct dmx_pes_filter_params *filter) const;    
116     };
117
118     typedef ProtocolClientSocketHandle<DVBDemuxPESProtocol> DVBDemuxPESHandle;
119
120     
121     // ----------------------------------------------------------------
122     
123     
124     /** \brief xxx
125          */
126     class DVBDvrProtocol
127         : public ConcreteSocketProtocol<DVBDemux_Policy>,
128           public DVBDemuxProtocol
129     {
130     public:
131         ///////////////////////////////////////////////////////////////////////////
132         // internal interface
133
134         ///\name Constructors
135         ///@{
136
137         void init_client() const;       ///< xxx
138                                         /**< \note This member is implicitly called from the
139                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
140                                              constructor */
141
142         ///@}
143         ///\name Abstract Interface Implementation
144         
145         unsigned available() const;
146
147         std::auto_ptr<SocketProtocol> clone() const;
148
149         ///@}
150    
151      };
152
153      typedef ProtocolClientSocketHandle<DVBDvrProtocol> DVBDvrHandle;
154     
155 }
156
157 ///////////////////////////////hh.e////////////////////////////////////////
158 //#include "DVBDemuxHandles.cci"
159 //#include "DVBDemuxHandles.ct"
160 //#include "DVBDemuxHandles.cti"
161 #endif
162
163 \f
164 // Local Variables:
165 // mode: c++
166 // fill-column: 100
167 // c-file-style: "senf"
168 // indent-tabs-mode: nil
169 // ispell-local-dictionary: "american"
170 // compile-command: "scons -u test"
171 // comment-column: 40
172 // End: