Mercurial > code
changeset 567:4828eca0f78d
Net: various typos
author | David Demelier <markand@malikania.fr> |
---|---|
date | Wed, 29 Jun 2016 14:50:32 +0200 |
parents | 72390061044d |
children | 4d9cd83d821e |
files | modules/net/net.hpp |
diffstat | 1 files changed, 23 insertions(+), 39 deletions(-) [+] |
line wrap: on
line diff
--- a/modules/net/net.hpp Fri Jun 24 13:00:35 2016 +0200 +++ b/modules/net/net.hpp Wed Jun 29 14:50:32 2016 +0200 @@ -63,13 +63,24 @@ /** * \page Networking Networking * - * - \subpage net-configuration * - \subpage net-options * - \subpage net-concepts */ /** - * \page net-configuration Configuration + * \page net-options User options + * + * The user may set the following variables before compiling these files: + * + * # General options + * + * - **NET_NO_AUTO_INIT**: (bool) Set to 0 if you don't want Socket class to + * automatically calls init function and finish functions. + * + * - **NET_NO_SSL**: (bool) Set to 0 if you don't have access to OpenSSL library. + * + * - **NET_NO_AUTO_SSL_INIT**: (bool) Set to 0 if you don't want Socket class with Tls to automatically init + * the OpenSSL library. You will need to call ssl::init and ssl::finish. * * # General compatibility options. * @@ -92,7 +103,6 @@ * * - **NET_HAVE_POLL**: Defined on all BSD, Linux. Also defined on Windows * if _WIN32_WINNT is set to 0x0600 or greater. - * * - **NET_HAVE_KQUEUE**: Defined on all BSD and Apple. * - **NET_HAVE_EPOLL**: Defined on Linux only. * - **NET_DEFAULT_BACKEND**: Which backend to use (e.g. `Select`). @@ -108,22 +118,6 @@ */ /** - * \page net-options User options - * - * The user may set the following variables before compiling these files: - * - * # General options - * - * - **NET_NO_AUTO_INIT**: (bool) Set to 0 if you don't want Socket class to - * automatically calls init function and finish functions. - * - * - **NET_NO_SSL**: (bool) Set to 0 if you don't have access to OpenSSL library. - * - * - **NET_NO_AUTO_SSL_INIT**: (bool) Set to 0 if you don't want Socket class with Tls to automatically init - * the OpenSSL library. You will need to call ssl::init and ssl::finish. - */ - -/** * \page net-concepts Concepts * * - \subpage net-concept-address @@ -136,8 +130,8 @@ /** * \page net-concept-address Address (Concept) * - * An address is used in many place for creating, binding, connecting, receiving and sending. They are implemented as - * templates to allow any type of address and to make sure the same address is used for a given socket. + * An address is used in many places for creating, binding, connecting, receiving and sending. They are implemented as templates to allow + * any type of address and to make sure the same address is used for a given socket. * * This concepts requires the following functions: * @@ -205,8 +199,7 @@ /** * \page net-concept-backend Backend (Concept) * - * A backend is an interface for the Listener class. It is primarily designed to be the most suitable for the host - * environment. + * A backend is an interface for the Listener class. It is primarily designed to be the most suitable for the host environment. * * The backend must be default constructible, it is highly encouraged to be move constructible. * @@ -285,7 +278,7 @@ * * An option can be set or get from a socket. * - * If an operation is not available, provides the function but throws an exception with ENOSYS errno code. + * If an operation is not available, provides the function but throws an exception with ENOSYS message. * * This concepts requires the following functions: * @@ -307,7 +300,7 @@ * * ```` * template <typename Address> - * inline void set(Socket<Address> &sc) const; + * void set(Socket<Address> &sc) const; * ```` * * ## Arguments @@ -322,7 +315,7 @@ * * ```` * template <typename Address> - * inline bool get(Socket<Address> &sc) const; + * T get(Socket<Address> &sc) const; * ```` * * ## Arguments @@ -371,8 +364,8 @@ * * ## Throws * - * - \a net::WouldBlockError: if the operation would block, - * - \a net::Error: on other error. + * - net::WouldBlockError: if the operation would block, + * - net::Error: on other error. * * # accept * @@ -1111,14 +1104,6 @@ return v1; } -/* - * Base Socket class - * ------------------------------------------------------------------ - * - * This base class has operations that are common to all types of sockets but you usually instanciate - * a SocketTcp or SocketUdp - */ - /** * \brief Base socket class. */ @@ -1335,7 +1320,7 @@ { assert(m_handle != Invalid); - if (::listen(this->m_handle, max) == Failure) + if (::listen(m_handle, max) == Failure) throw Error(); } @@ -1501,8 +1486,7 @@ * \brief Clear TCP implementation. * \ingroup net-module-tcp * - * This is the basic TCP protocol that implements recv, send, connect and accept as wrappers of the usual - * C functions. + * This is the basic TCP protocol that implements recv, send, connect and accept as wrappers of the usual C functions. */ template <typename Address> class TcpSocket : public Socket<Address> {