diff --git a/man/rules/meson.build b/man/rules/meson.build index d5feb5da08..12c2b92b29 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -301,6 +301,7 @@ manpages = [ 'sd_bus_track_set_destroy_callback'], ''], ['sd_bus_slot_set_floating', '3', ['sd_bus_slot_get_floating'], ''], + ['sd_bus_slot_set_userdata', '3', ['sd_bus_slot_get_userdata'], ''], ['sd_bus_track_add_name', '3', ['sd_bus_track_add_sender', diff --git a/man/sd-bus.xml b/man/sd-bus.xml index 7f9fab3cc3..a1f1ecb956 100644 --- a/man/sd-bus.xml +++ b/man/sd-bus.xml @@ -80,8 +80,9 @@ sd_bus_set_description3, sd_bus_set_sender3, sd_bus_set_watch_bind3 -sd_bus_set_slot_destroy_callback3, -sd_bus_set_slot_floating3, +sd_bus_slot_set_destroy_callback3, +sd_bus_slot_set_floating3, +sd_bus_slot_set_userdata3, sd_bus_track_add_name3, sd_bus_track_new3 diff --git a/man/sd_bus_slot_set_userdata.xml b/man/sd_bus_slot_set_userdata.xml new file mode 100644 index 0000000000..dad708b6ab --- /dev/null +++ b/man/sd_bus_slot_set_userdata.xml @@ -0,0 +1,88 @@ + + + + + + + + sd_bus_slot_set_userdata + systemd + + + + sd_bus_slot_set_userdata + 3 + + + + sd_bus_slot_set_userdata + sd_bus_slot_get_userdata + + Set and query the value in the "userdata" field + + + + + #include <systemd/sd-bus.h> + + + void* sd_bus_slot_set_userdata + sd_bus_slot* slot + void* userdata + + + + void* sd_bus_slot_get_userdata + sd_bus_slot* slot + + + + + + + Description + + The userdata pointer allows data to be passed between the point where a callback is + registered, for example when a filter is added using + sd_bus_add_filter3 + or an asynchronous function call is made using + sd_bus_call_async3, + and the point where the callback is called, without having any global state. The pointer has + type void* and is not used by the sd-bus functions in any way, except to pass to + the callback function. + + Usually, the userdata field is set when the slot object is initially + registered. sd_bus_slot_set_userdata() may be used to change it later for + the bus slot object slot. Previous value of the field is returned. The + argument and returned value may be NULL. It will be passed as the + userdata argument to the callback function attached to the slot. + + sd_bus_slot_set_userdata() gets the value of the userdata field in + the bus slot object slot. + + + + Return Value + + On success, these functions return the value of the userdata field before the function + call. If the slot object is NULL, + NULL will be returned to signify an error, but this is not distinguishable + from the userdata field value being NULL. + + + + + + See Also + + + systemd1, + sd-bus3, + sd_bus_slot_set_destroy_callback3, + sd_bus_add_match3, + sd_bus_slot_get_current_userdata3 + + + +