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
|
'\" t
.TH "SD_BUS_PROCESS" "3" "" "systemd 241" "sd_bus_process"
.\" -----------------------------------------------------------------
.\" * 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_bus_process \- Drive the connection
.SH "SYNOPSIS"
.sp
.ft B
.nf
#include <systemd/sd\-bus\&.h>
.fi
.ft
.HP \w'int\ sd_bus_process('u
.BI "int sd_bus_process(sd_bus\ *" "bus" ", sd_bus_message\ **" "ret" ");"
.SH "DESCRIPTION"
.PP
\fBsd_bus_process()\fR
drives the connection between the client and the message bus\&. That is, it handles connecting, authentication, and message processing\&. When invoked pending I/O work is executed, and queued incoming messages are dispatched to registered callbacks\&. Each time it is invoked a single operation is executed\&. It returns zero when no operations were pending and positive if a message was processed\&. When zero is returned the caller should synchronously poll for I/O events before calling into
\fBsd_bus_process()\fR
again\&. For that either user the simple, synchronous
\fBsd_bus_wait\fR(3)
call, or hook up the bus connection object to an external or manual event loop using
\fBsd_bus_get_fd\fR(3)\&.
.PP
\fBsd_bus_process()\fR
processes at most one incoming message per call\&. If the parameter
\fIret\fR
is not
\fBNULL\fR
and the call processed a message,
\fI*ret\fR
is set to this message\&. The caller owns a reference to this message and should call
\fBsd_bus_message_unref\fR(3)
when the message is no longer needed\&. If
\fIret\fR
is not NULL, progress was made, but no message was processed,
\fI*ret\fR
is set to
\fBNULL\fR\&.
.PP
If a the bus object is connected to an
\fBsd-event\fR(3)
event loop (with
\fBsd_bus_attach_event\fR(3)), it is not necessary to call
\fBsd_bus_process()\fR
directly as it is invoked automatically when necessary\&.
.SH "RETURN VALUE"
.PP
If progress was made, a positive integer is returned\&. If no progress was made, 0 is returned\&. If an error occurs, a negative
\fIerrno\fR\-style error code is returned\&.
.SH "ERRORS"
.PP
Returned errors may indicate the following problems:
.PP
\fB\-EINVAL\fR
.RS 4
An invalid bus object was passed\&.
.RE
.PP
\fB\-ECHILD\fR
.RS 4
The bus connection was allocated in a parent process and is being reused in a child process after
\fBfork()\fR\&.
.RE
.PP
\fB\-ENOTCONN\fR
.RS 4
The bus connection has been terminated already\&.
.RE
.PP
\fB\-ECONNRESET\fR
.RS 4
The bus connection has been terminated just now\&.
.RE
.PP
\fB\-EBUSY\fR
.RS 4
This function is already being called, i\&.e\&.
\fBsd_bus_process()\fR
has been called from a callback function that itself was called by
\fBsd_bus_process()\fR\&.
.RE
.SH "NOTES"
.PP
These APIs are implemented as a shared library, which can be compiled and linked to with the
\fBlibsystemd\fR\ \&\fBpkg-config\fR(1)
file\&.
.SH "SEE ALSO"
.PP
\fBsystemd\fR(1),
\fBsd-bus\fR(3),
\fBsd_bus_wait\fR(3),
\fBsd_bus_get_fd\fR(3),
\fBsd_bus_message_unref\fR(3),
\fBsd-event\fR(3),
\fBsd_bus_attach_event\fR(3)
|
