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

nl: Improve API doc of nl_send_simple()

Browse source 
Signed-off-by: Thomas Graf <tgraf@redhat.com>
This commit is contained in:
Thomas Graf 2012-11-08 21:17:32 +01:00
parent b28c25eb23
commit 665464cde5
1 changed files with 16 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
lib/nl.c
View file

@ -479,18 +479,24 @@ int nl_send_sync(struct nl_sock *sk, struct nl_msg *msg)
}
/**
* Send simple netlink message using nl_send_auto_complete()
* @arg sk Netlink socket.
* @arg type Netlink message type.
* @arg flags Netlink message flags.
* @arg buf Data buffer.
* @arg size Size of data buffer.
* Construct and transmit a Netlink message
* @arg sk Netlink socket (required)
* @arg type Netlink message type (required)
* @arg flags Netlink message flags (optional)
* @arg buf Data buffer (optional)
* @arg size Size of data buffer (optional)
*
* Builds a netlink message with the specified type and flags and
* appends the specified data as payload to the message.
* Allocates a new Netlink message based on `type` and `flags`. If `buf`
* points to payload of length `size` that payload will be appended to the
* message.
*
* Sends out the message using `nl_send_auto()` and frees the message
* afterwards.
*
* @see nl_send_auto()
*
* @see nl_send_auto_complete()
* @return Number of characters sent on success or a negative error code.
* @retval -NLE_NOMEM Unable to allocate Netlink message
*/
int nl_send_simple(struct nl_sock *sk, int type, int flags, void *buf,
size_t size)
@ -507,9 +513,8 @@ int nl_send_simple(struct nl_sock *sk, int type, int flags, void *buf,
if (err < 0)
goto errout;
}
err = nl_send_auto_complete(sk, msg);
err = nl_send_auto(sk, msg);
errout:
nlmsg_free(msg);