Further documentation (mainly SocketPolicy)
[senf.git] / Socket / ProtocolClientSocketHandle.hh
1 // $Id$
2 //
3 // Copyright (C) 2006 
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 #ifndef HH_ProtocolClientSocketHandle_
24 #define HH_ProtocolClientSocketHandle_ 1
25
26 // Custom includes
27 #include "ClientSocketHandle.hh"
28
29 #include "ProtocolClientSocketHandle.mpp"
30 ///////////////////////////////hh.p////////////////////////////////////////
31
32 namespace senf {
33
34     /// \addtogroup handle_group
35     /// @{
36
37     template <class Protocol> class ProtocolServerSocketHandle;
38
39     /** \brief
40       */
41     template <class SocketProtocol>
42     class ProtocolClientSocketHandle
43         : public ClientSocketHandle<typename SocketProtocol::Policy>
44     {
45     public:
46         ///////////////////////////////////////////////////////////////////////////
47         // Types
48
49         typedef SocketProtocol Protocol;
50
51         ///////////////////////////////////////////////////////////////////////////
52         ///\name Structors and default members
53         ///@{
54
55         ProtocolClientSocketHandle();
56
57 #       define BOOST_PP_ITERATION_PARAMS_1 (4, (1, 9, "Socket/ProtocolClientSocketHandle.mpp", 1))
58 #       include BOOST_PP_ITERATE()
59         
60         ///@}
61         ///////////////////////////////////////////////////////////////////////////
62
63         Protocol const & protocol();
64
65         static ProtocolClientSocketHandle cast_static(FileHandle handle);
66         static ProtocolClientSocketHandle cast_dynamic(FileHandle handle);
67
68         void state(SocketStateMap & map, unsigned lod=0);
69         std::string dumpState(unsigned lod=0);
70
71     protected:
72         ProtocolClientSocketHandle(FileHandle other, bool isChecked);
73
74     private:
75         friend class ProtocolServerSocketHandle<Protocol>;
76     };
77
78     /// @}
79 }
80
81 ///////////////////////////////hh.e////////////////////////////////////////
82 //#include "ProtocolClientSocketHandle.cci"
83 //#include "ProtocolClientSocketHandle.ct"
84 #include "ProtocolClientSocketHandle.cti"
85 #include "ProtocolClientSocketHandle.mpp"
86 #endif
87
88 \f
89 // Local Variables:
90 // mode: c++
91 // c-file-style: "senf"
92 // End: