X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FSocket%2FClientSocketHandle.hh;h=ce0f82a358f2d9e3615ac0436d66ba8476253dc1;hb=78a6e233083efa63a9cd0684a92abc64202a9ee7;hp=92635f956927c221c820ce60de7bc32402d7d64d;hpb=601d1f509f5bb24df167a4dd5a20da67a0af9af8;p=senf.git diff --git a/senf/Socket/ClientSocketHandle.hh b/senf/Socket/ClientSocketHandle.hh index 92635f9..ce0f82a 100644 --- a/senf/Socket/ClientSocketHandle.hh +++ b/senf/Socket/ClientSocketHandle.hh @@ -98,7 +98,7 @@ namespace senf { /// 'Best' type for passing address as parameter /** Depending on the type of \c Address, this will be either Address or Address const &. See call_traits documentation in + href="http://www.boost.org/doc/libs/release/libs/utility/call_traits.htm">call_traits documentation in the Boost.Utility library. */ typedef typename boost::call_traits
::param_type AddressParam; @@ -136,7 +136,7 @@ namespace senf { # else template ClientSocketHandle const & operator=(ClientSocketHandle other); -# endif +# endif ///@} /////////////////////////////////////////////////////////////////////////// @@ -163,7 +163,7 @@ namespace senf { the other end) and will block, if no data is available now. If you do not want to block, you \e must make the socket non-blocking (using FileHandle::blocking()). - \throws senf::SystemException + \throws senf::SystemException This variant will read up to \c limit bytes from the @@ -191,11 +191,11 @@ namespace senf { range. read returns a past-the-end iterator after the last character read. This iterator will point to somewhere within the input range. - \param[in,out] range Range to store data in + \param[in,out] range Range to store data in \returns past-the-end iterator pointer to after the - last read character + last read character \see \ref read() \n - Boost.Range */ + Boost.Range */ # endif # ifndef DOXYGEN template @@ -209,7 +209,7 @@ namespace senf { ///< Read data into range /**< \see read(ForwardWritableRange const &) \n read() \n - Boost.Range */ + Boost.Range */ # endif template void read (Sequence & container, unsigned limit); @@ -219,7 +219,7 @@ namespace senf { work, the container must be a model of 'Sequence' as defined in the STL documentation \param[out] container Container to write data to - \param[in] limit Maximum number of characters to read + \param[in] limit Maximum number of characters to read \see \ref read() */ char * read (char * start, char * end); ///< Read data into memory area @@ -260,20 +260,20 @@ namespace senf { range. read returns a past-the-end iterator after the last character read. This iterator will point to somewhere within the input range. - \param[in,out] range Range to store data in + \param[in,out] range Range to store data in \param[out] from peers address from which the data was received \returns past-the-end iterator pointer to after the - last read character + last read character \see \ref readfrom() \n - Boost.Range */ + Boost.Range */ template typename boost::range_iterator::type readfrom (ForwardWritableRange & range, Address & from); ///< Read data into range /**< \see readfrom(ForwardWritableRange const&,Address&) \n readfrom() \n - Boost.Range */ + Boost.Range */ template void readfrom (Sequence & container, Address & from, unsigned limit); ///< Read data into container @@ -282,7 +282,7 @@ namespace senf { work, the container must be a model of 'Sequence' as defined in the STL documentation \param[out] container Container to write data to - \param[in] limit Maximum number of characters to read + \param[in] limit Maximum number of characters to read \param[out] from peers address from which the data was received \see \ref readfrom() */ @@ -328,7 +328,7 @@ namespace senf { \param[in] end past-the-end pointer to area to write \returns past-the-end pointer after last byte written \see \ref write() \n - Boost.Range */ + Boost.Range */ /** \brief Write data to unconnected socket @@ -358,7 +358,7 @@ namespace senf { \param[in] end past-the-end pointer after data to write \returns past-the-end iterator after last byte written \see \ref writeto() \n - Boost.Range */ + Boost.Range */ /////////////////////////////////////////////////////////////////////////// ///\name Addressing