X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FSocket%2FSocketHandle.ih;h=7775e5cf7dd3e75e8be6c919c3871942cc9beff4;hb=0e87ffe1cd4de41a27a29c427d7538789e4e3a43;hp=de34df0ac42f4af9d9e0600c721df02a129f9190;hpb=601d1f509f5bb24df167a4dd5a20da67a0af9af8;p=senf.git diff --git a/senf/Socket/SocketHandle.ih b/senf/Socket/SocketHandle.ih index de34df0..7775e5c 100644 --- a/senf/Socket/SocketHandle.ih +++ b/senf/Socket/SocketHandle.ih @@ -33,7 +33,7 @@ #include #include "FileHandle.hh" -///////////////////////////////ih.p//////////////////////////////////////// +//-///////////////////////////////////////////////////////////////////////////////////////////////// namespace senf { @@ -60,10 +60,10 @@ namespace senf { template StreamableString & operator<<(T const & other); - ///< Value assigment + ///< Value assignment /**< This operator will assign the string from any arbitrary type. It will use boost::lexical_cast to - convert the argument to its string representation. + convert the argument to its string representation. If the string is non-empty, an additional separating comma is added to the string. */ @@ -100,14 +100,14 @@ namespace senf { : public FileBody { public: - /////////////////////////////////////////////////////////////////////////// + //-///////////////////////////////////////////////////////////////////////////////////////// // Types typedef boost::intrusive_ptr ptr; - /////////////////////////////////////////////////////////////////////////// + //-///////////////////////////////////////////////////////////////////////////////////////// ///\name Structors and default members - ///@{ + //\{ SocketBody(bool isServer); /**< \param isServer \c true, if this socket is a server socket, false otherwise */ @@ -119,8 +119,8 @@ namespace senf { // no copy // no conversion constructors - ///@} - /////////////////////////////////////////////////////////////////////////// + //\} + //-///////////////////////////////////////////////////////////////////////////////////////// SocketProtocol & protocol() const; ///< Access the protocol instance @@ -139,12 +139,12 @@ namespace senf { socket whenever it is closed. \throws senf::SystemException */ virtual void v_terminate(); ///< Forcibly close socket - /**< This override will automatically \c shutfown() the + /**< This override will automatically \c shutdown() the socket whenever it is called. Additionally it will disable SO_LINGER to ensure, that v_terminate will not - block. Like the overriden method, this member will ignore - failures and will never throw. It therefore safe to be - called from a destructor. */ + block. Like the overridden method, this member will + ignore failures and will never throw. It therefore + safe to be called from a destructor. */ virtual bool v_eof() const; ///< Check for eof condition /**< Since the eof check for sockets is very protocol dependent, this member will forward the call to @@ -157,8 +157,8 @@ namespace senf { }; template - class ProtocolSocketBody - : public SocketBody, + class ProtocolSocketBody + : public SocketBody, private SProtocol, public senf::pool_alloc_mixin< ProtocolSocketBody > { @@ -174,7 +174,7 @@ namespace senf { /**< \param isServer \c true, if this socket is a server socket, false otherwise \param fd socket file descriptor */ - + private: virtual SocketProtocol const & v_protocol() const; virtual std::string v_protocolName() const; @@ -184,7 +184,7 @@ namespace senf { } -///////////////////////////////ih.e//////////////////////////////////////// +//-///////////////////////////////////////////////////////////////////////////////////////////////// #endif