X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Socket%2FSocketProtocol.hh;h=206f7ccf29cd0a804f26683cc204e7c4a257b78c;hb=81447258e6ecc9b5d9434fa5a7d382684179c7ab;hp=839fdeba9f192d36fd16e6369853ef1a14d5b102;hpb=145f6a7d0f3a6aaa77b3625351c952d24cb0b8a1;p=senf.git
diff --git a/Socket/SocketProtocol.hh b/Socket/SocketProtocol.hh
index 839fdeb..206f7cc 100644
--- a/Socket/SocketProtocol.hh
+++ b/Socket/SocketProtocol.hh
@@ -37,7 +37,22 @@
/** \defgroup protocol_group The Protocol Classes
- \image html Protocols.png
+ \htmlonly
+
+
+ \endhtmlonly
The socket handle classes and templates only implement the most important socket API methods
using the policy framework. To access the complete API, the protocol interface is
@@ -50,9 +65,9 @@
protocols are implemented using a simple multiple-inheritance hierarchy as shown above.
Since the protocol class is protocol specific (how intelligent ...), the protocol class also
- defines the complete socket policy to be used with it's protocol. Complete meaning, that every
- policy axis must be assigned it's the most specific (that is derived) policy class to be used
- with the protocol.
+ defines the \e complete socket policy to be used with it's protocol. Complete meaning, that
+ every policy axis must be assigned it's the most specific (that is derived) policy class to be
+ used with the protocol and that no policy axis is allowed to be left unspecified.
\see
\ref handle_group \n
@@ -111,7 +126,8 @@ namespace senf {
\attention SocketProtocol must \e always be inherited using public \e virtual inheritance.
*/
- class SocketProtocol : boost::noncopyable
+ class SocketProtocol
+ : boost::noncopyable
{
public:
///////////////////////////////////////////////////////////////////////////
@@ -155,7 +171,9 @@ namespace senf {
/**< This member will check in a (very, sigh) protocol
dependent way, how many bytes are guaranteed to be
readable from the socket without blocking even if the
- socket is blocking. */
+ socket is blocking. If the socket does not support
+ reading (viz. NotReadablePolicy is set), this member
+ should always return \c 0.*/
virtual bool eof() const = 0; ///< Check for end-of-file condition
/**< This is another check which (like available()) is