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
|
'\" t
.TH "SD_BUS_CLOSE" "3" "" "systemd 255" "sd_bus_close"
.\" -----------------------------------------------------------------
.\" * 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_close, sd_bus_flush, sd_bus_default_flush_close \- Close and flush a bus connection
.SH "SYNOPSIS"
.sp
.ft B
.nf
#include <systemd/sd\-bus\&.h>
.fi
.ft
.HP \w'void\ sd_bus_close('u
.BI "void sd_bus_close(sd_bus\ *" "bus" ");"
.HP \w'int\ sd_bus_flush('u
.BI "int sd_bus_flush(sd_bus\ *" "bus" ");"
.HP \w'void\ sd_bus_default_flush_close('u
.BI "void sd_bus_default_flush_close(void);"
.SH "DESCRIPTION"
.PP
\fBsd_bus_close()\fR
disconnects the specified bus connection\&. When this call is invoked and the specified bus object refers to an active connection it is immediately terminated\&. No further messages may be sent or received on it\&. Any messages queued in the bus object (both incoming and outgoing) are released\&. If invoked on
\fBNULL\fR
bus object or when the bus connection is already closed this function executes no operation\&. This call does not free or unreference the bus object itself\&. Use
\fBsd_bus_unref\fR(3)
for that\&.
.PP
\fBsd_bus_flush()\fR
synchronously writes out all outgoing queued message on a bus connection if there are any\&. This function call may block if the peer is not processing bus messages quickly\&.
.PP
Before a program exits it is usually a good idea to flush any pending messages with
\fBsd_bus_flush()\fR
and then close connections with
\fBsd_bus_close()\fR
to ensure that no unwritten messages are lost, no further messages may be queued and all incoming but unprocessed messages are released\&. After both operations have been done, it is a good idea to also drop any remaining references to the bus object so that it may be freed\&. Since these three operations are frequently done together a helper call
\fBsd_bus_flush_close_unref\fR(3)
is provided that combines them into one\&.
.PP
\fBsd_bus_default_flush_close()\fR
is similar to
\fBsd_bus_flush_close_unref()\fR, but does not take a bus pointer argument and instead iterates over any of the "default" buses opened by
\fBsd_bus_default\fR(3),
\fBsd_bus_default_user\fR(3),
\fBsd_bus_default_system\fR(3), and similar calls\&.
\fBsd_bus_default_flush_close()\fR
is particularly useful to clean up any buses opened using those calls before the program exits\&.
.SH "RETURN VALUE"
.PP
On success,
\fBsd_bus_flush()\fR
returns a non\-negative integer\&. On failure, it returns a negative errno\-style error code\&.
.SS "Errors"
.PP
Returned errors may indicate the following problems:
.PP
\fB\-ECHILD\fR
.RS 4
The bus connection has been created in a different process, library or module instance\&.
.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_bus_close()\fR
and
\fBsd_bus_flush()\fR
were added in version 240\&.
.PP
\fBsd_bus_default_flush_close()\fR
was added in version 246\&.
.SH "SEE ALSO"
.PP
\fBsystemd\fR(1),
\fBsd-bus\fR(3),
\fBsd_bus_unref\fR(3),
\fBsd_bus_set_close_on_exit\fR(3)
|
