Debian Codegraph @

upstream/debian-unstable/man3/sd_bus_message_at_end.3

raw
1 '\" t
2 .TH "SD_BUS_MESSAGE_AT_END" "3" "" "systemd 261~rc3" "sd_bus_message_at_end"
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_bus_message_at_end \- Check if a message has been fully read
24 .SH "SYNOPSIS"
25 .sp
26 .ft B
27 .nf
28 #include <systemd/sd\-bus\&.h>
29 .fi
30 .ft
31 .HP \w'int\ sd_bus_message_at_end('u
32 .BI "int sd_bus_message_at_end(sd_bus_message\ *" "m" ", int\ " "complete" ");"
33 .SH "DESCRIPTION"
34 .PP
35 \fBsd_bus_message_at_end()\fR
36 returns whether all data from the currently opened container in
37 \fIm\fR
38 or all data from all containers in
39 \fIm\fR
40 has been read\&. If
41 \fIcomplete\fR
42 is zero, this function returns whether all data from the currently opened container has been read\&. If
43 \fIcomplete\fR
44 is non\-zero, this function returns whether all data from all containers in
45 \fIm\fR
46 has been read\&.
47 .SH "RETURN VALUE"
48 .PP
49 If all data from all containers or the current container (depending on the value of
50 \fIcomplete\fR) has been read,
51 \fBsd_bus_message_at_end()\fR
52 returns a positive integer\&. If there is still data left to be read, it returns zero\&. On failure, it returns a negative errno\-style error code\&.
53 .SS "Errors"
54 .PP
55 Returned errors may indicate the following problems:
56 .PP
57 \fB\-EINVAL\fR
58 .RS 4
59 The
60 \fIm\fR
61 parameter is
62 \fBNULL\fR\&.
63 .sp
64 Added in version 246\&.
65 .RE
66 .PP
67 \fB\-EPERM\fR
68 .RS 4
69 The message is not sealed\&.
70 .sp
71 Added in version 246\&.
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_bus_message_at_end()\fR
88 was added in version 246\&.
89 .SH "SEE ALSO"
90 .PP
91 \fBsystemd\fR(1), \fBsd-bus\fR(3), \fBsd_bus_message_read\fR(3)