From fee23e05581390c54a93c2ddd39900ec22eca0c9 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Wed, 22 Jan 2020 17:44:33 +0100 Subject: [PATCH] man: document the new sd_bus_enqueue_for_read() API call Origin: upstream, https://github.com/systemd/systemd/commit/5c1163273569809742c164260cfd9f096520cb82 Change-Id: I40ea7e0d913bc80e96a4875818ae3d266e0cf70e Signed-off-by: Youngjae Cho --- man/rules/meson.build | 1 + man/sd_bus_enqueue_for_read.xml | 88 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 89 insertions(+) create mode 100644 man/sd_bus_enqueue_for_read.xml diff --git a/man/rules/meson.build b/man/rules/meson.build index 20c3d09..7777ab4 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -192,6 +192,7 @@ manpages = [ 'sd_bus_open_user_with_description', 'sd_bus_open_with_description'], ''], + ['sd_bus_enqueue_for_read', '3', [], ''], ['sd_bus_error', '3', ['SD_BUS_ERROR_MAKE_CONST', diff --git a/man/sd_bus_enqueue_for_read.xml b/man/sd_bus_enqueue_for_read.xml new file mode 100644 index 0000000..30ccee2 --- /dev/null +++ b/man/sd_bus_enqueue_for_read.xml @@ -0,0 +1,88 @@ + + + + + + + + sd_bus_enqueue_for_read + systemd + + + + sd_bus_enqueue_for_read + 3 + + + + sd_bus_enqueue_for_read + + Re-enqueue a bus message on a bus connection, for reading. + + + + + #include <systemd/sd-bus.h> + + + int sd_bus_enqueue_for_read + sd_bus *bus + sd_bus_message *message + + + + + + + Description + + sd_bus_enqueue_for_read() may be used to re-enqueue an incoming bus message on + the local read queue, so that it is processed and dispatched locally again, similar to how an incoming + message from the peer is processed. Takes a bus connection object and the message to enqueue. A reference + is taken of the message and the caller's reference thus remains in possession of the caller. The message + is enqueued at the end of the queue, thus will be dispatched after all other already queued messages are + dispatched. + + This call is primarily useful for dealing with incoming method calls that may be processed only + after an additional asynchronous operation completes. One example are PolicyKit authorization requests + that are determined to be necessary to autorize a newly incoming method call: when the PolicyKit response + is received the original method call may be re-enqueued to process it again, this time with the + authorization result known. + + + + Return Value + + On success, this function return 0 or a positive integer. On failure, it returns a negative errno-style + error code. + + + Errors + + Returned errors may indicate the following problems: + + + + -ECHILD + + The bus connection has been created in a different process. + + + + + + + + + See Also + + + systemd1, + sd-bus3, + sd_bus_send3, + + + + -- 2.7.4