stv0g/libnl
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

nl: Improve API doc of nl_connect() and nl_close()

Browse source 
Signed-off-by: Thomas Graf <tgraf@redhat.com>
This commit is contained in:
Thomas Graf 2012-11-08 13:41:54 +01:00
parent fd6f205f8a
commit b28c25eb23
1 changed files with 23 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
lib/nl.c
View file

@ -62,18 +62,25 @@
*/
/**
* Create and connect netlink socket.
* @arg sk Netlink socket.
* @arg protocol Netlink protocol to use.
* Create file descriptor and bind socket.
* @arg sk Netlink socket (required)
* @arg protocol Netlink protocol to use (required)
*
* Creates a netlink socket using the specified protocol, binds the socket
* and issues a connection attempt.
* Creates a new Netlink socket using `socket()` and binds the socket to the
* protocol and local port specified in the `sk` socket object. Fails if
* the socket is already connected.
*
* This function fail if socket is already connected.
* @note If available, the `close-on-exec` (`SOCK_CLOEXEC`) feature is enabled
* automatically on the new file descriptor. This causes the socket to
* be closed automatically if any of the `exec` family functions succeed.
* This is essential for multi threaded programs.
*
* @note SOCK_CLOEXEC is set on the socket if available.
* @see nl_socket_alloc()
* @see nl_close()
*
* @return 0 on success or a negative error code.
*
* @retval -NLE_BAD_SOCK Socket is already connected
*/
int nl_connect(struct nl_sock *sk, int protocol)
{
@ -137,8 +144,15 @@ errout:
}
/**
* Close/Disconnect netlink socket.
* @arg sk Netlink socket.
* Close Netlink socket
* @arg sk Netlink socket (required)
*
* Closes the Netlink socket using `close()`.
*
* @note The socket is closed automatically if a `struct nl_sock` object is
* freed using `nl_socket_free()`.
*
* @see nl_connect()
*/
void nl_close(struct nl_sock *sk)
{