Attention une mise à jour du service Gitlab va être effectuée le mardi 18 janvier (et non lundi 17 comme annoncé précédemment) entre 18h00 et 18h30. Cette mise à jour va générer une interruption du service dont nous ne maîtrisons pas complètement la durée mais qui ne devrait pas excéder quelques minutes.

Commit 97513620 authored by RILLING Louis's avatar RILLING Louis
Browse files

tansiv-client / capi: Better document vsg_recv()

parent ad5baf4f
Pipeline #179519 failed with stages
in 11 minutes and 22 seconds
......@@ -155,8 +155,9 @@ pub unsafe extern fn vsg_send(context: *const Context, dst: libc::in_addr_t, msg
}
/// Picks the next message in the receive queue, stores its payload in `msg[0..*msglen]` and
/// optionnally returns sender and destination addresses in `*psrc` and `*pdst` respectively. The
/// actual length of the received payload is stored in `*msglen`.
/// optionnally returns sender and destination addresses in `*psrc` and `*pdst` respectively.
/// `*msglen` initially contains the size of the buffer pointed to by `msg`. When `vsg_recv`
/// returns with success, `*msglen` contains the actual length of the received payload.
///
/// # Safety
///
......@@ -164,6 +165,9 @@ pub unsafe extern fn vsg_send(context: *const Context, dst: libc::in_addr_t, msg
///
/// * `psrc` and `pdst` can be `NULL`, in which case the correponding addresses will not be returned.
///
/// * If `msglen` is not `NULL`, `msg` must point to a valid memory range of at least `*msglen`
/// bytes. This memory range does not need to be initialized.
///
/// * If `msglen` is `NULL` or `*msglen` is `0`, only 0-length messages can be received. Note that
/// in that case it is allowed that `msg` is `NULL` too.
///
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment