Debian Codegraph @

upstream/debian-unstable/man3/sd_bus_message_seal.3

raw
1 '\" t
2 .TH "SD_BUS_MESSAGE_SEAL" "3" "" "systemd 261~rc3" "sd_bus_message_seal"
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_seal \- Prepare a D\-Bus message for transmission
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_seal('u
32 .BI "int sd_bus_message_seal(sd_bus_message\ *" "m" ", uint64_t\ " "cookie" ", uint64_t\ " "timeout_usec" ");"
33 .SH "DESCRIPTION"
34 .PP
35 \fBsd_bus_message_seal()\fR
36 finishes the message
37 \fIm\fR
38 and prepares it for transmission using
39 \fBsd_bus_send\fR(3)\&.
40 \fIcookie\fR
41 specifies the identifier used to match the message reply to its corresponding request\&.
42 \fItimeout_usec\fR
43 specifies the maximum time in microseconds to wait for a reply to arrive\&.
44 .PP
45 Note that in most scenarios, it is not necessary to call this function directly\&.
46 \fBsd_bus_call\fR(3),
47 \fBsd_bus_call_async\fR(3)
48 and
49 \fBsd_bus_send\fR(3)
50 will seal any given messages if they have not been sealed yet\&.
51 .SH "RETURN VALUE"
52 .PP
53 On success, this function returns a non\-negative integer\&. On failure, it returns a negative errno\-style error code\&.
54 .SS "Errors"
55 .PP
56 Returned errors may indicate the following problems:
57 .PP
58 \fB\-EINVAL\fR
59 .RS 4
60 The
61 \fIm\fR
62 parameter is
63 \fBNULL\fR\&.
64 .sp
65 Added in version 246\&.
66 .RE
67 .PP
68 \fB\-EBADMSG\fR
69 .RS 4
70 The D\-Bus message
71 \fIm\fR
72 has open containers\&.
73 .sp
74 Added in version 246\&.
75 .RE
76 .PP
77 \fB\-ENOMSG\fR
78 .RS 4
79 The D\-Bus message
80 \fIm\fR
81 is a reply but its type signature does not match the return type signature of its corresponding member in the object vtable\&.
82 .sp
83 Added in version 246\&.
84 .RE
85 .SH "NOTES"
86 .PP
87 Functions described here are available as a shared library, which can be compiled against and linked to with the
88 \fBlibsystemd\fR\ \&\fBpkg-config\fR(1)
89 file\&.
90 .PP
91 The code described here uses
92 \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
93 \fBsetenv\fR(3)
94 from a parallel thread\&. It is recommended to only do calls to
95 \fBsetenv()\fR
96 from an early phase of the program when no other threads have been started\&.
97 .SH "HISTORY"
98 .PP
99 \fBsd_bus_message_seal()\fR
100 was added in version 246\&.
101 .SH "SEE ALSO"
102 .PP
103 \fBsystemd\fR(1), \fBsd-bus\fR(3), \fBsd_bus_call\fR(3), \fBsd_bus_call_async\fR(3), \fBsd_bus_send\fR(3)