1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
'\" t
.TH "SD_EVENT_GET_FD" "3" "" "systemd 256~rc3" "sd_event_get_fd"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
sd_event_get_fd \- Obtain a file descriptor to poll for event loop events
.SH "SYNOPSIS"
.sp
.ft B
.nf
#include <systemd/sd\-event\&.h>
.fi
.ft
.HP \w'int\ sd_event_get_fd('u
.BI "int sd_event_get_fd(sd_event\ *" "event" ");"
.SH "DESCRIPTION"
.PP
\fBsd_event_get_fd()\fR
returns the file descriptor that an event loop object returned by the
\fBsd_event_new\fR(3)
function uses to wait for events\&. This file descriptor may itself be polled for
\fBPOLLIN\fR/\fBEPOLLIN\fR
events\&. This makes it possible to embed an
\fBsd-event\fR(3)
event loop into another, possibly foreign, event loop\&.
.PP
The returned file descriptor refers to an
\fBepoll\fR(7)
object\&. It is recommended not to alter it by invoking
\fBepoll_ctl\fR(2)
on it, in order to avoid interference with the event loop\*(Aqs inner logic and assumptions\&.
.SH "RETURN VALUE"
.PP
On success,
\fBsd_event_get_fd()\fR
returns a non\-negative file descriptor\&. On failure, it returns a negative errno\-style error code\&.
.SS "Errors"
.PP
Returned errors may indicate the following problems:
.PP
\fB\-EINVAL\fR
.RS 4
\fIevent\fR
is not a valid pointer to an
sd_event
structure\&.
.RE
.PP
\fB\-ECHILD\fR
.RS 4
The event loop has been created in a different process, library or module instance\&.
.RE
.SH "EXAMPLES"
.PP
\fBExample\ \&1.\ \&Integration in the GLib event loop\fR
.sp
.if n \{\
.RS 4
.\}
.nf
/* SPDX\-License\-Identifier: MIT\-0 */
#include <stdlib\&.h>
#include <glib\&.h>
#include <systemd/sd\-event\&.h>
typedef struct SDEventSource {
GSource source;
GPollFD pollfd;
sd_event *event;
} SDEventSource;
static gboolean event_prepare(GSource *source, gint *timeout_) {
return sd_event_prepare(((SDEventSource *)source)\->event) > 0;
}
static gboolean event_check(GSource *source) {
return sd_event_wait(((SDEventSource *)source)\->event, 0) > 0;
}
static gboolean event_dispatch(GSource *source, GSourceFunc callback, gpointer user_data) {
return sd_event_dispatch(((SDEventSource *)source)\->event) > 0;
}
static void event_finalize(GSource *source) {
sd_event_unref(((SDEventSource *)source)\->event);
}
static GSourceFuncs event_funcs = {
\&.prepare = event_prepare,
\&.check = event_check,
\&.dispatch = event_dispatch,
\&.finalize = event_finalize,
};
GSource *g_sd_event_create_source(sd_event *event) {
SDEventSource *source;
source = (SDEventSource *)g_source_new(&event_funcs, sizeof(SDEventSource));
source\->event = sd_event_ref(event);
source\->pollfd\&.fd = sd_event_get_fd(event);
source\->pollfd\&.events = G_IO_IN | G_IO_HUP | G_IO_ERR;
g_source_add_poll((GSource *)source, &source\->pollfd);
return (GSource *)source;
}
.fi
.if n \{\
.RE
.\}
.SH "NOTES"
.PP
Functions described here are available as a shared library, which can be compiled against and linked to with the
\fBlibsystemd\fR\ \&\fBpkg-config\fR(1)
file\&.
.PP
The code described here uses
\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
\fBsetenv\fR(3)
from a parallel thread\&. It is recommended to only do calls to
\fBsetenv()\fR
from an early phase of the program when no other threads have been started\&.
.SH "HISTORY"
.PP
\fBsd_event_get_fd()\fR
was added in version 217\&.
.SH "SEE ALSO"
.PP
\fBsd-event\fR(3), \fBsd_event_new\fR(3), \fBsd_event_wait\fR(3), \fBepoll_ctl\fR(2), \fBepoll\fR(7)
|
