From 45069c67ced7a8f56f2a69e583764f70300067c1 Mon Sep 17 00:00:00 2001 From: Daan De Meyer Date: Sat, 28 Mar 2020 23:19:58 +0100 Subject: [PATCH] sd-bus: Add sd_bus_slot_get_current_* docs --- man/rules/meson.build | 7 ++- man/sd-bus.xml | 5 ++- man/sd_bus_slot_get_bus.xml | 88 +++++++++++++++++++++++++++++++++++++ man/sd_bus_slot_ref.xml | 14 +----- 4 files changed, 98 insertions(+), 16 deletions(-) create mode 100644 man/sd_bus_slot_get_bus.xml diff --git a/man/rules/meson.build b/man/rules/meson.build index b95ef6964af..01aebddd42d 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -352,10 +352,13 @@ manpages = [ ''], ['sd_bus_set_sender', '3', ['sd_bus_get_sender'], ''], ['sd_bus_set_watch_bind', '3', ['sd_bus_get_watch_bind'], ''], - ['sd_bus_slot_ref', + ['sd_bus_slot_get_bus', '3', - ['sd_bus_slot_get_bus', 'sd_bus_slot_unref', 'sd_bus_slot_unrefp'], + ['sd_bus_slot_get_current_handler', + 'sd_bus_slot_get_current_message', + 'sd_bus_slot_get_current_userdata'], ''], + ['sd_bus_slot_ref', '3', ['sd_bus_slot_unref', 'sd_bus_slot_unrefp'], ''], ['sd_bus_slot_set_description', '3', ['sd_bus_slot_get_description'], ''], ['sd_bus_slot_set_destroy_callback', '3', diff --git a/man/sd-bus.xml b/man/sd-bus.xml index e11e6ec794a..48f4a2a84fc 100644 --- a/man/sd-bus.xml +++ b/man/sd-bus.xml @@ -96,7 +96,10 @@ sd_bus_set_method_call_timeout3, sd_bus_set_sender3, sd_bus_set_watch_bind3 -sd_bus_set_close_on_exit3 +sd_bus_set_close_on_exit3, +sd_bus_slot_get_current_handler3, +sd_bus_slot_get_current_message3, +sd_bus_slot_get_current_userdata3, sd_bus_slot_set_description3, sd_bus_slot_set_destroy_callback3, sd_bus_slot_set_floating3, diff --git a/man/sd_bus_slot_get_bus.xml b/man/sd_bus_slot_get_bus.xml new file mode 100644 index 00000000000..ed3e55b0574 --- /dev/null +++ b/man/sd_bus_slot_get_bus.xml @@ -0,0 +1,88 @@ + + + + + + + sd_bus_slot_get_bus + systemd + + + + sd_bus_slot_get_bus + 3 + + + + sd_bus_slot_get_bus + sd_bus_slot_get_current_handler + sd_bus_slot_get_current_message + sd_bus_slot_get_current_userdata + + Query information attached to a bus slot object + + + + + #include <systemd/sd-bus.h> + + + sd_bus *sd_bus_slot_get_bus + sd_bus_slot *slot + + + + sd_bus_message_handler_t sd_bus_slot_get_current_handler + + sd_bus_slot *slot + + + + sd_bus_message *sd_bus_slot_get_current_message + sd_bus_slot *slot + + + + void *sd_bus_slot_get_current_userdata + sd_bus_slot *slot + + + + + + Description + + sd_bus_slot_get_bus() returns the bus object that message + slot is attached to. + + sd_bus_slot_get_current_handler(), + sd_bus_slot_get_current_message() and + sd_bus_slot_get_current_userdata() return the current handler, message and + userdata respectively of the bus slot is attached to if we're currently + executing the callback associated with slot. + + + + Return Value + + sd_bus_slot_get_bus() always returns the bus object. + + On success, sd_bus_slot_get_current_handler(), + sd_bus_slot_get_current_message() and + sd_bus_slot_get_current_userdata() return the requested object. On failure, + they return NULL. + + + + + + See Also + + + systemd1, + sd-bus3, + + + + diff --git a/man/sd_bus_slot_ref.xml b/man/sd_bus_slot_ref.xml index 22b288bfcce..ef144ece6d4 100644 --- a/man/sd_bus_slot_ref.xml +++ b/man/sd_bus_slot_ref.xml @@ -18,7 +18,6 @@ sd_bus_slot_ref sd_bus_slot_unref sd_bus_slot_unrefp - sd_bus_slot_get_bus Create and destroy references to a bus slot object @@ -41,11 +40,6 @@ void sd_bus_slot_unrefp sd_bus_slot **slotp - - - sd_bus *sd_bus_slot_get_bus - sd_bus_slot *m - @@ -72,11 +66,7 @@ execute no operation if the passed in bus object address is NULL. sd_bus_slot_unrefp() will first dereference its argument, which must not be NULL, and will execute no operation if - that is NULL. - - - sd_bus_slot_get_bus() returns the bus object that message - slot is attached to. + that is NULL. @@ -85,8 +75,6 @@ sd_bus_slot_ref() always returns the argument. sd_bus_slot_unref() always returns NULL. - - sd_bus_slot_get_bus() always returns the bus object.