X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Socket%2FSocketHandle.hh;h=d1b42508965ee361e5617b80875dcf73b256077b;hb=445c71d8d242f4ce3d23d8db8d1faf909943cfec;hp=7b64f531373ee60b71372c875aa5d5e218d9454a;hpb=c778649a04a9835ecaad9108b9613832d76c2d15;p=senf.git diff --git a/Socket/SocketHandle.hh b/Socket/SocketHandle.hh index 7b64f53..d1b4250 100644 --- a/Socket/SocketHandle.hh +++ b/Socket/SocketHandle.hh @@ -1,8 +1,8 @@ // $Id:SocketHandle.hh 218 2007-03-20 14:39:32Z tho $ // // Copyright (C) 2006 -// Fraunhofer Institute for Open Communication Systems (FOKUS) -// Competence Center NETwork research (NET), St. Augustin, GERMANY +// Fraunhofer Institute for Open Communication Systems (FOKUS) +// Competence Center NETwork research (NET), St. Augustin, GERMANY // Stefan Bund // // This program is free software; you can redistribute it and/or modify @@ -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.