From b750101eb236130cf056c675997decbac904cc49 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 17:35:18 +0200 Subject: Adding upstream version 252.22. Signed-off-by: Daniel Baumann --- man/sd_event_source_set_floating.xml | 118 +++++++++++++++++++++++++++++++++++ 1 file changed, 118 insertions(+) create mode 100644 man/sd_event_source_set_floating.xml (limited to 'man/sd_event_source_set_floating.xml') diff --git a/man/sd_event_source_set_floating.xml b/man/sd_event_source_set_floating.xml new file mode 100644 index 0000000..7f3ed86 --- /dev/null +++ b/man/sd_event_source_set_floating.xml @@ -0,0 +1,118 @@ + + + + + + + + sd_event_source_set_floating + systemd + + + + sd_event_source_set_floating + 3 + + + + sd_event_source_set_floating + sd_event_source_get_floating + + Set or retrieve 'floating' state of event sources + + + + + #include <systemd/sd-event.h> + + + int sd_event_source_set_floating + sd_event_source *source + int floating + + + + int sd_event_source_get_floating + sd_event_source *source + + + + + + + Description + + sd_event_source_set_floating() takes a boolean and sets the 'floating' state + of the specified event source object. This is used to change the direction of reference counts for the + object and the event loop it is associated with. In non-floating mode, the event source object holds a + reference to the event loop object, but not vice versa. The creator of the event source object must hold + a reference to it as long as the source should exist. In floating mode, the event loop holds a reference + to the source object, and will decrease the reference count when being freed. This means that a reference + to the event loop should be held to prevent both from being destroyed. + + Various calls that allocate event source objects (i.e. + sd_event_add_io3, + sd_event_add_time3 and + similar) will automatically set an event source object to 'floating' mode if the caller passed + NULL in the parameter used to return a reference to the event source object. + Nevertheless, it may be necessary to gain temporary access to the source object, for example to adjust + event source properties after allocation (e.g. its priority or description string). In those cases the + object may be created in non-floating mode, and the returned reference used to adjust the properties, and + the object marked as floating afterwards, and the reference in the caller dropped. + + sd_event_source_get_floating() may be used to query the current 'floating' + state of the event source object source. It returns zero if 'floating' mode is + off, positive if it is on. + + + + Return Value + + On success, sd_event_source_set_floating() and + sd_event_source_get_floating() return a non-negative integer. On failure, they + return a negative errno-style error code. + + + Errors + + Returned errors may indicate the following problems: + + + + -EINVAL + + source is not a valid pointer to an + sd_event_source object. + + + + -ECHILD + + The event loop has been created in a different process. + + + + + + + + + + + See Also + + + sd-event3, + sd_event_add_io3, + sd_event_add_time3, + sd_event_add_signal3, + sd_event_add_child3, + sd_event_add_inotify3, + sd_event_add_defer3, + sd_event_source_set_description3, + sd_event_source_set_priority3 + + + + -- cgit v1.2.3