X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Socket%2FSocketHandle.hh;h=6d36be8c225dd3951c65a0400d02dbaa928cc197;hb=6e4cfeb813b1da364395b2da6e3762e0abd2ac70;hp=68cce0225c0f6d5a253e3aa654b55abcb10f3588;hpb=a1a6c76a214ad1935032826713cabaf9ac57bf07;p=senf.git diff --git a/Socket/SocketHandle.hh b/Socket/SocketHandle.hh index 68cce02..6d36be8 100644 --- a/Socket/SocketHandle.hh +++ b/Socket/SocketHandle.hh @@ -44,20 +44,22 @@ namespace senf { /** \brief basic SocketHandle supporting protocol and policy abstraction - The senf::SocketHandle class introduces the two abstraction layers of the socket + The %senf::SocketHandle class introduces the two abstraction layers of the socket library. senf::SocketHandle does \e not provide socket functions it only provides the infrastructure necessary to support both, the protocol and the policy interface. - senf::SocketHandle takes the socket policy as a template argument. senf::SocketHandle also + %SocketHandle takes the socket policy as a template argument. %SocketHandle also introduces the protocol class. However, the class has no public constructors (see the derived classes senf::ProtocolClientSocketHandle and senf::ProtocolServerSocketHandle). - The most important functionality provided by senf::SocketHandle is the conversion + The most important functionality provided by %SocketHandle is the conversion constructor. This allows to implicitly convert between compatible socket handle types as specified by the socket policy. The conversion constructor is defined in such a way, that only valid conversions are possible (see the implementation source for a more complete discussion). + \tparam SPolicy socket policy + \note This class is \e not meant to be used as a base-class outside the library implementation; The protected interface is for internal use only. @@ -125,7 +127,7 @@ namespace senf { \param map string to string mapping to be filled with state information - \param lod level of detail requested. The + \param lod level of %detail requested. The interpretation of this value is protocol specific \implementation This member will be re-implemented in @@ -138,7 +140,7 @@ namespace senf { /**< Formats the complete state map value and returns it as a single multi-line string. - \param lod level of detail requested. The + \param lod level of %detail requested. The interpretation of this value is protocol specific \implementation This member will be re-implemented in