4 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
5 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
6 // Stefan Bund <stefan.bund@fokus.fraunhofer.de>
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.
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.
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.
24 \brief SocketProtocol and ConcreteSocketProtocol public header
26 \idea We should optimize the protocol handling. Allocating a protocol instance for every socket
27 body seems quite wasteful. We could derive SocketPolicy from SocketBody (probably privately,
28 since private inheritance models more of 'has a' than 'is a'). This would allow to reduce
29 the number of heap-allocations per socket to one which is good.
32 // The private inheritance idea should indeed work very well: We just need to change the
33 // implementations of body() and protocol() and that of the ProtocolClient/ServerSocketHandle
34 // constructors and the SocketBody constructor. The body and the protocol would still be visible
35 // like several instances because of the private inheritance but we would save the backwards
38 /** \defgroup protocol_group The Protocol Classes
41 <map name="protocols">
42 <area shape="rect" alt="SocketPolicy" href="structsenf_1_1SocketPolicy.html" title="SocketPolicy" coords="416,50,536,68" />
43 <area shape="rect" alt="ConcreteSocketProtocol" href="classsenf_1_1ConcreteSocketProtocol.html" title="ConcreteSocketProtocol" coords="268,65,456,88" />
44 <area shape="rect" alt="SocketProtocol" href="classsenf_1_1SocketProtocol.html" title="SocketProtocol" coords="1,2,120,26" />
45 <area shape="rect" alt="BSDSocketProtocol" href="classsenf_1_1BSDSocketProtocol.html" title="BSDSocketProtocol" coords="124,118,276,143" />
46 <area shape="rect" alt="AddressableBSDSocketProtocol" href="classsenf_1_1AddressableBSDSocketProtocol.html" title="AddressableBSDSocketProtocol" coords="82,200,314,224" />
47 <area shape="rect" alt="IPv4Protocol" href="classsenf_1_1IPv4Protocol.html" title="IPv4Protocol" coords="149,272,252,296" />
48 <area shape="rect" alt="IPv6Protocol" href="classsenf_1_1IPv6Protocol.html" title="IPv6Protocol" coords="149,335,251,359" />
49 <area shape="rect" alt="TCPProtocol" href="classsenf_1_1TCPProtocol.html" title="TCPProtocol" coords="151,398,248,420" />
50 <area shape="rect" alt="TCPv4SocketProtocol" href="classsenf_1_1TCPv4SocketProtocol.html" title="TCPv4SocketProtocol" coords="288,471,405,494" />
51 <area shape="rect" alt="TCPv6SocketProtocol" href="classsenf_1_1TCPv6SocketProtocol.html" title="TCPv6SocketProtocol" coords="424,470,540,494" />
52 <area shape="rect" alt="PacketProtocol" href="classsenf_1_1PacketProtocol.html" title="PacketProtocol" coords="560,469,680,495" />
54 <img src="Protocols.png" border="0" alt="Protocols" usemap="#protocols">
57 The socket handle classes and templates only implement the most important socket API methods
58 using the policy framework. To access the complete API, the protocol interface is
59 provided. Access to the protocol interface is only possible via senf::ProtocolClientSocketHandle
60 and senf::ProtocolServerSocketHandle which have the necessary \c protocol() member. This member
61 returns a reference to the protocol class instance which contains members covering all the API
62 functions (mostly setsockopt/getsockopt related calls but there may be more, this is completely
63 up to the implementor of the protocol class) not found in the SocketHandle interface. The
64 protocol interface is specific to the protocol. It's implementation is quite free. The standard
65 protocols are implemented using a simple multiple-inheritance hierarchy as shown above.
67 Since the protocol class is protocol specific (how intelligent ...), the protocol class also
68 defines the \e complete socket policy to be used with it's protocol. Complete meaning, that
69 every policy axis must be assigned it's the most specific (that is derived) policy class to be
70 used with the protocol and that no policy axis is allowed to be left unspecified.
76 \todo Complete the protocol interface implementations. Better distribution of members to
77 protocol facets and more precise distribution of functionality among the facets.
80 /** \defgroup concrete_protocol_group Protocol Implementations (Concrete Protocol Classes)
81 \ingroup protocol_group
83 Theese protocol classes define concrete and complete protocol implementations. They inherit from
84 ConcreteSocketProtocol and are used with the ProtocolClientSocketHandle and
85 ProtocolServerSocketHandle templates to instantiate socket handles. Appropriate typedefs are
88 Every protocol defines both the protocol and the policy interface provided by that protocol. See
89 the documentation of the protocol classes listed below for more information on the supported
90 protocols. Every protocol class documents it's policy interface. Use the 'list all members' link
91 of the protocol class to find the complete policy interface.
94 /** \defgroup protocol_facets_group Protocol Facets
95 \ingroup protocol_group
97 The protocol facets are classes used as building blocks to build concrete protocol classes. Each
98 protocol facet will implement some functional part of the protocol interface. The protocol
99 facets all inherit from SocketProtocol by public \e virtual inheritance. This ensures the
100 accessibility of the socket body from all facets.
103 #ifndef HH_SocketProtocol_
104 #define HH_SocketProtocol_ 1
107 #include <boost/utility.hpp>
108 // Hrmpf ... I have tried very hard, but I just can't find a nice, generic way to clean
110 #include "SocketHandle.ih"
112 //#include "SocketProtocol.mpp"
113 ///////////////////////////////hh.p////////////////////////////////////////
117 /// \addtogroup protocol_group
120 class SocketPolicyBase;
122 /** \brief Socket Protocol base class
124 This is the base class of all socket protocol classes. Every protocol class must directly or
125 indirectly inherit from SocketProtocol
127 \attention SocketProtocol must \e always be inherited using public \e virtual inheritance.
133 ///////////////////////////////////////////////////////////////////////////
136 ///////////////////////////////////////////////////////////////////////////
137 ///\name Structors and default members
141 virtual ~SocketProtocol() = 0;
143 // default default constructor
145 // no conversion constructors
148 ///////////////////////////////////////////////////////////////////////////
150 SocketBody & body() const; ///< Access the socket body
151 /**< \todo we don't need body(), we should better provide a
152 handle() member which will return a simple FIleHandle
153 object (we cannot return some other derived class since
154 we don't know the Protocol or Policy at this point) */
155 virtual SocketPolicyBase const & policy() const = 0;
156 ///< Access the policy instance
158 ///////////////////////////////////////////////////////////////////////////
161 virtual std::auto_ptr<SocketProtocol> clone() const = 0;
162 ///< Polymorphically return a copy of this protocol class
163 /**< This member will create a new copy of the protocol
165 \attention This member must be implemented in every \e
166 leaf protocol class to return a new instance of the
168 virtual unsigned available() const = 0;
169 ///< Return number of bytes available for reading without
171 /**< This member will check in a (very, sigh) protocol
172 dependent way, how many bytes are guaranteed to be
173 readable from the socket without blocking even if the
174 socket is blocking. If the socket does not support
175 reading (viz. NotReadablePolicy is set), this member
176 should always return \c 0.*/
178 virtual bool eof() const = 0; ///< Check for end-of-file condition
179 /**< This is another check which (like available()) is
180 extremely protocol dependent. This member will return
181 \c true only, if at end-of-file. If the protocol does
182 not support the notion of EOF, this member should
183 always return \c false. */
185 virtual void close() const; ///< Close socket
186 /**< This override will automatically \c shutdown() the
187 socket whenever it is closed.
188 \throws senf::SystemException */
189 virtual void terminate() const; ///< Forcibly close socket
190 /**< This override will automatically \c shutdown() the
191 socket whenever it is called. Additionally it will
192 disable SO_LINGER to ensure, that v_terminate will not
193 block. Like the overriden method, this member will ignore
194 failures and will never throw. It therefore safe to be
195 called from a destructor. */
197 virtual void state(SocketStateMap & map, unsigned lod) const;
198 ///< Return socket state information
199 /**< This member is called to add state information to the
200 status \a map. The protocol map should provide as
201 detailed information as possible. The amount of
202 information to be added to the map is selected by the
203 \a lod value with a default value of 0. The
204 interpretation of the \a lod value is completely
205 implementation defined.
207 Every class derived from SocketProtocol should
208 reimplement state(). The reimplemented method should
209 call (all) baseclass-implementations of this
212 The \a map Argument is a map which associates
213 std:string keys with std:string-like values. The map
214 keys are interpreted as hierarchical strings with '.'
215 as a separator (like hostnames or struct or class
216 members). They are automatically sorted correctly.
218 The values are std:string with one additional feature:
219 they allow assignment or conversion from *any* type as
220 long as that type is streamable. This simplifies
221 assigning non-string values to the map:
224 map["socket.protocol.ip.address"] = peer();
225 map["socket.protocol.tcp.backlog"] = backlog();
228 This will work even if peer() returns an ip-address
229 object or backlog() returns an integer. The values are
230 automatically converted to their string representation.
232 The operator "+=" also has been reimplemented to
233 simplify adding multiple values to a single entry: It
234 will automatically add a ", " separator if the string
240 // backpointer to owning SocketBody instance
242 friend class SocketBody;
246 /** \brief Concrete Socket Protocol implementation base class
248 ConcreteSocketProtocol is the base class of a concrete socket protocol implementation. The
249 final protocol class must inherit from ConcreteSocketProtocol. The template argument \a
250 SocketPolicy must be set to the complete socket policy of the protocol.
252 A protocol implementation may define the protocol interface directly. It can also
253 (additionally) make use of multiple inheritance to combine a set of protocol facets into a
254 specific protocol implementation (i.e. TCPv4SocketProtocol inherits from
255 ConcreteSocketProtocol and from the protocol facets IPv4Protocol, TCPProtocol,
256 BSDSocketProtocol and AddressableBSDSocketProtocol). The protocol facets are not concrete
257 protocols themselves, they are combined to build concrete protocols. This structure will
258 remove a lot of code duplication. It is important to ensure, that the protocol facets do not
259 overlap, since otherwise there will be problems resolving overlapping members.
261 \doc init_client init_server
263 template <class SocketPolicy>
264 class ConcreteSocketProtocol
265 : public virtual SocketProtocol
268 ///////////////////////////////////////////////////////////////////////////
271 typedef SocketPolicy Policy; ///< The protocols policy
273 ///////////////////////////////////////////////////////////////////////////
274 ///\name Structors and default members
277 ~ConcreteSocketProtocol() = 0;
279 // no default constructor
281 // no conversion constructors
284 ///////////////////////////////////////////////////////////////////////////
286 Policy const & policy() const;
298 ///////////////////////////////hh.e////////////////////////////////////////
299 #include "SocketProtocol.cci"
300 //#include "SocketProtocol.ct"
301 #include "SocketProtocol.cti"
308 // c-file-style: "senf"
309 // indent-tabs-mode: nil
310 // ispell-local-dictionary: "american"
311 // compile-command: "scons -u test"
312 // comment-column: 40