From: Daan De Meyer Date: Thu, 19 Mar 2020 17:52:52 +0000 (+0100) Subject: sd-bus: Add sd_bus_send docs + cleanups. X-Git-Tag: v246-rc1~720 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b0f4c02e2df072779a1e3b4030db50692cd94dbd;p=thirdparty%2Fsystemd.git sd-bus: Add sd_bus_send docs + cleanups. --- diff --git a/man/rules/meson.build b/man/rules/meson.build index 84a8d6259ed..b95ef6964af 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -332,6 +332,7 @@ manpages = [ 'sd_bus_release_name_async', 'sd_bus_request_name_async'], ''], + ['sd_bus_send', '3', [], ''], ['sd_bus_set_address', '3', ['sd_bus_get_address'], ''], ['sd_bus_set_close_on_exit', '3', ['sd_bus_get_close_on_exit'], ''], ['sd_bus_set_connected_signal', '3', ['sd_bus_get_connected_signal'], ''], diff --git a/man/sd-bus.xml b/man/sd-bus.xml index 9e13af2cc90..e11e6ec794a 100644 --- a/man/sd-bus.xml +++ b/man/sd-bus.xml @@ -89,6 +89,7 @@ sd_bus_reply_method_return3, sd_bus_reply_method_error3, sd_bus_request_name3, +sd_bus_send3, sd_bus_set_address3, sd_bus_set_connected_signal3, sd_bus_set_description3, diff --git a/man/sd_bus_call.xml b/man/sd_bus_call.xml index 6555563793e..f2d725a29f0 100644 --- a/man/sd_bus_call.xml +++ b/man/sd_bus_call.xml @@ -128,14 +128,14 @@ -ENOTCONN - The bus parameter bus is NULL - or the bus is not connected. + The input parameter bus is + NULL or the bus is not connected. -ECONNRESET - The client was disconnected while waiting for the response. + The bus connection was closed while waiting for the response. diff --git a/man/sd_bus_send.xml b/man/sd_bus_send.xml new file mode 100644 index 00000000000..659fa2a86ce --- /dev/null +++ b/man/sd_bus_send.xml @@ -0,0 +1,136 @@ + + + + + + + + sd_bus_send + systemd + + + + sd_bus_send + 3 + + + + sd_bus_send + + Queue a D-Bus message for transfer + + + + + #include <systemd/sd-bus.h> + + + int sd_bus_send + sd_bus *bus + sd_bus_message *m + uint64_t *cookie + + + + + + Description + + sd_bus_send() queues the bus message object m + for transfer. If bus is NULL, the bus that + m is attached to is used. bus only needs to be set + when the message is sent to a different bus than the one it's attached to, for example when + forwarding messages. If the output parameter cookie is not + NULL, it is set to the message identifier. This value can later be used to + match incoming replies to their corresponding messages. If cookie is set + to NULL and the message is not sealed, sd_bus_send() + assumes the message m doesn't expect a reply and adds the necessary + headers to indicate this. + + Note that in most scenarios, sd_bus_send() should not be called + directly. Instead, use higher level functions such as + sd_bus_call_method3 and + sd_bus_reply_method_return3 + which call sd_bus_send() internally. + + + + Return Value + + On success, this function returns a non-negative integer. On failure, it returns a + negative errno-style error code. + + + Errors + + Returned errors may indicate the following problems: + + + + -EINVAL + + The input parameter m is NULL. + + + + + -EOPNOTSUPP + + The bus connection does not support sending file descriptors. + + + + + -ECHILD + + The bus connection was allocated in a parent process and is being reused + in a child process after fork(). + + + + -ENOBUFS + + The bus connection's write queue is full. + + + + -ENOTCONN + + The input parameter bus is + NULL or the bus is not connected. + + + + -ECONNRESET + + The bus connection was closed while waiting for the response. + + + + + -ENOMEM + + Memory allocation failed. + + + + + + + + + See Also + + + systemd1, + sd-bus3, + sd_bus_call_method3, + sd_bus_message_set_destination3, + sd_bus_reply_method_return3, + sd_bus_send_to3 + + + + diff --git a/man/sd_bus_set_method_call_timeout.xml b/man/sd_bus_set_method_call_timeout.xml index 76c938442d1..006020aae70 100644 --- a/man/sd_bus_set_method_call_timeout.xml +++ b/man/sd_bus_set_method_call_timeout.xml @@ -96,7 +96,7 @@ systemd1, sd-bus3, - sd_bus_call3, + sd_bus_call3