Debian Codegraph @

upstream/debian-unstable/man3/sd_event_source_set_exit_on_failure.3

raw
1 '\" t
2 .TH "SD_EVENT_SOURCE_SET_EXIT_ON_FAILURE" "3" "" "systemd 261~rc3" "sd_event_source_set_exit_on_failure"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 sd_event_source_set_exit_on_failure, sd_event_source_get_exit_on_failure \- Set or retrieve the exit\-on\-failure feature of event sources
24 .SH "SYNOPSIS"
25 .sp
26 .ft B
27 .nf
28 #include <systemd/sd\-event\&.h>
29 .fi
30 .ft
31 .HP \w'int\ sd_event_source_set_exit_on_failure('u
32 .BI "int sd_event_source_set_exit_on_failure(sd_event_source\ *" "source" ", int\ " "b" ");"
33 .HP \w'int\ sd_event_source_get_exit_on_failure('u
34 .BI "int sd_event_source_get_exit_on_failure(sd_event_source\ *" "source" ");"
35 .SH "DESCRIPTION"
36 .PP
37 \fBsd_event_source_set_exit_on_failure()\fR
38 may be used to set/unset the exit\-on\-failure flag of the event source object specified as
39 \fIsource\fR\&. The flag defaults to off\&. If on and the callback function set for the event source returns a failure code (i\&.e\&. a negative value) the event loop is exited too, using the callback return code as the exit code for
40 \fBsd_event_exit\fR(3)\&. If off, the event source is disabled but the event loop continues to run\&. Setting this flag is useful for "dominant" event sources that define the purpose and reason for the event loop, and whose failure hence should propagate to the event loop itself \(em as opposed to "auxiliary" event sources whose failures should remain local and affect the event source, but not propagate further\&.
41 .PP
42 \fBsd_event_source_get_exit_on_failure()\fR
43 may be used to query the flag currently set for the event source object
44 \fIsource\fR\&.
45 .SH "RETURN VALUE"
46 .PP
47 On success,
48 \fBsd_event_source_set_exit_on_failure()\fR
49 returns a non\-negative integer\&.
50 \fBsd_event_source_get_exit_on_failure()\fR
51 returns 0 if the flag is off, > 0 if the flag is on\&. On failure, both return a negative errno\-style error code\&.
52 .SS "Errors"
53 .PP
54 Returned errors may indicate the following problems:
55 .PP
56 \fB\-EINVAL\fR
57 .RS 4
58 \fIsource\fR
59 is not a valid pointer to an
60 sd_event_source
61 object\&.
62 .sp
63 Added in version 247\&.
64 .RE
65 .PP
66 \fB\-EDOM\fR
67 .RS 4
68 The event source refers to an exit event source (as created with
69 \fBsd_event_add_exit\fR(3)), for which this functionality is not supported\&.
70 .sp
71 Added in version 247\&.
72 .RE
73 .SH "NOTES"
74 .PP
75 Functions described here are available as a shared library, which can be compiled against and linked to with the
76 \fBlibsystemd\fR\ \&\fBpkg-config\fR(1)
77 file\&.
78 .PP
79 The code described here uses
80 \fBgetenv\fR(3), which is declared to be not multi\-thread\-safe\&. This means that the code calling the functions described here must not call
81 \fBsetenv\fR(3)
82 from a parallel thread\&. It is recommended to only do calls to
83 \fBsetenv()\fR
84 from an early phase of the program when no other threads have been started\&.
85 .SH "HISTORY"
86 .PP
87 \fBsd_event_source_set_exit_on_failure()\fR
88 and
89 \fBsd_event_source_get_exit_on_failure()\fR
90 were added in version 247\&.
91 .SH "SEE ALSO"
92 .PP
93 \fBsd-event\fR(3), \fBsd_event_add_io\fR(3), \fBsd_event_add_time\fR(3), \fBsd_event_add_signal\fR(3), \fBsd_event_add_child\fR(3), \fBsd_event_add_inotify\fR(3), \fBsd_event_add_defer\fR(3)