diff --git a/man/rules/meson.build b/man/rules/meson.build index 3b52d33e371..90b422956d1 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -385,6 +385,7 @@ manpages = [ 'sd_bus_set_anonymous', 'sd_bus_set_trusted'], ''], + ['sd_bus_set_exit_on_disconnect', '3', ['sd_bus_get_exit_on_disconnect'], ''], ['sd_bus_set_method_call_timeout', '3', ['sd_bus_get_method_call_timeout'], diff --git a/man/sd-bus.xml b/man/sd-bus.xml index 3237eb82cc6..92e05a449ca 100644 --- a/man/sd-bus.xml +++ b/man/sd-bus.xml @@ -77,6 +77,7 @@ sd_bus_get_current_message3, sd_bus_get_current_slot3, sd_bus_get_current_userdata3, +sd_bus_get_exit_on_disconnect3, sd_bus_get_fd3, sd_bus_get_method_call_timeout3, sd_bus_get_n_queued_read3, @@ -121,16 +122,17 @@ sd_bus_request_name3, sd_bus_send3, sd_bus_set_address3, +sd_bus_set_bus_client3, +sd_bus_set_close_on_exit3, sd_bus_set_connected_signal3, sd_bus_set_description3, +sd_bus_set_exit_on_disconnect3, sd_bus_set_method_call_timeout3, sd_bus_set_property3, sd_bus_set_propertyv3, sd_bus_set_sender3, -sd_bus_set_bus_client3, sd_bus_set_server3, sd_bus_set_watch_bind3 -sd_bus_set_close_on_exit3, sd_bus_slot_get_current_handler3, sd_bus_slot_get_current_message3, sd_bus_slot_get_current_userdata3, diff --git a/man/sd_bus_set_exit_on_disconnect.xml b/man/sd_bus_set_exit_on_disconnect.xml new file mode 100644 index 00000000000..97e0e03fcf2 --- /dev/null +++ b/man/sd_bus_set_exit_on_disconnect.xml @@ -0,0 +1,102 @@ + + + + + + + + sd_bus_set_exit_on_disconnect + systemd + + + + sd_bus_set_exit_on_disconnect + 3 + + + + sd_bus_set_exit_on_disconnect + sd_bus_get_exit_on_disconnect + + Control the exit behavior when the bus object disconnects + + + + + #include <systemd/sd-bus.h> + + + int sd_bus_set_exit_on_disconnect + sd_bus *bus + int b + + + + int sd_bus_get_exit_on_disconnect + sd_bus *bus + + + + + + Description + + sd_bus_set_exit_on_disconnect() may be used to configure the exit + behavior when the given bus object disconnects. If b is zero, no special + logic is executed when the bus object disconnects. If b is non-zero, the + behavior on disconnect depends on whether the bus object is attached to an event loop or not. If + the bus object is attached to an event loop (see + sd_bus_attach_event3), + the event loop is closed when the bus object disconnects (as if calling + sd_event_exit3). + Otherwise, + exit3 + is called. The exit code passed to sd_event_exit() and + exit() is EXIT_FAILURE. If the bus object has already + disconnected when enabling the exit behavior, the exit behavior is executed immediately. By + default, the exit behavior is disabled. + + sd_bus_get_exit_on_disconnect() returns whether the exit on + disconnect behavior is enabled for the given bus object. + + + + Return Value + + On success, sd_bus_set_close_on_exit() returns a non-negative + integer. On failure, it returns a negative errno-style error code. + + sd_bus_get_close_on_exit() returns a positive integer if the exit on + disconnect behavior is enabled. Otherwise, it returns zero. + + + Errors + + Returned errors may indicate the following problems: + + + + -ECHILD + + The bus connection was created in a different process. + + + + + + + + + See Also + + + systemd1, + sd-bus3, + sd_bus_attach_event3, + sd-event3, + sd_event_exit3 + + +