diff --git a/man/rules/meson.build b/man/rules/meson.build index 059197500d..1a6debaaff 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -114,6 +114,7 @@ manpages = [ 'sd_bus_match_signal', 'sd_bus_match_signal_async'], ''], + ['sd_bus_attach_event', '3', ['sd_bus_detach_event', 'sd_bus_get_event'], ''], ['sd_bus_close', '3', ['sd_bus_flush'], ''], ['sd_bus_creds_get_pid', '3', diff --git a/man/sd-bus.xml b/man/sd-bus.xml index bf2f37a86d..949e320c75 100644 --- a/man/sd-bus.xml +++ b/man/sd-bus.xml @@ -44,6 +44,7 @@ See sd_bus_add_match3, +sd_bus_attach_event3, sd_bus_creds_get_pid3, sd_bus_creds_new_from_pid3, sd_bus_default3, diff --git a/man/sd_bus_attach_event.xml b/man/sd_bus_attach_event.xml new file mode 100644 index 0000000000..45f034910f --- /dev/null +++ b/man/sd_bus_attach_event.xml @@ -0,0 +1,114 @@ + + + + + + + + + sd_bus_attach_event + systemd + + + + sd_bus_attach_event + 3 + + + + sd_bus_attach_event + sd_bus_detach_event + sd_bus_get_event + + Attach a bus connection object to an event loop + + + + + #include <systemd/sd-bus.h> + + + int sd_bus_attach_event + sd_bus *bus + sd_event *e + int priority + + + + int sd_bus_detach_event + sd_bus *bus + + + + sd_event *sd_bus_get_event + sd_bus *bus + + + + + + Description + + sd_bus_attach_event() attaches the specified bus connection object to an + sd-event3 event loop object at + the specified priority (see + sd_event_source_set_priority3 + for details on event loop priorities). When a bus connection object is attached to an event loop incoming messages + will be automatically read and processed, and outgoing messages written, whenever the event loop is run. When the + event loop is about to terminate, the bus connection is automatically flushed and closed (see + sd_bus_set_close_on_exit3 for + details on this). By default bus connection objects are not attached to any event loop. When a bus connection + object is attached to one it is not necessary to invoke + sd_bus_wait3 or + sd_bus_process3 as this + functionality is handled automatically by the event loop. + + sd_bus_detach_event() detaches a bus object from its event loop. + + The sd_bus_get_event() returns the event loop object the specified bus object is + currently attached to, or NULL if it is currently not attached to any. + + + + Return Value + + On success, sd_bus_attach_event() and sd_bus_detach_event() return + 0 or a positive integer. On failure, they return a negative errno-style error code. + + sd_bus_get_event() returns an event loop object or NULL. + + + + 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-event3, + sd_event_source_set_priority3, + sd_bus_set_close_on_exit3, + sd_bus_wait3 + + + +