oysteikt/mpd
0
0
Fork 0
Code Issues Pull Requests Releases Activity

net/SocketUtil: update API documentation

Browse Source
This commit is contained in:
Max Kellermann 2018-10-30 19:56:08 +01:00
parent 2c388434dd
commit f5857c4689
1 changed files with 1 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/net/SocketUtil.hxx
View File

@ -37,15 +37,13 @@ class SocketAddress;
* access. The caller is responsible to apply proper permissions * access. The caller is responsible to apply proper permissions
* at a later point. * at a later point.
* *
* Throws #std::system_error on error. * Throws on error.
* *
* @param domain the socket domain, e.g. PF_INET6 * @param domain the socket domain, e.g. PF_INET6
* @param type the socket type, e.g. SOCK_STREAM * @param type the socket type, e.g. SOCK_STREAM
* @param protocol the protocol, usually 0 to let the kernel choose * @param protocol the protocol, usually 0 to let the kernel choose
* @param address the address to listen on * @param address the address to listen on
* @param backlog the backlog parameter for the listen() system call * @param backlog the backlog parameter for the listen() system call
* @param error location to store the error occurring, or NULL to
* ignore errors
* @return the socket file descriptor * @return the socket file descriptor
*/ */
UniqueSocketDescriptor UniqueSocketDescriptor