Debian Codegraph @

upstream/debian-unstable/man3/sd-bus-errors.3

raw
1 '\" t
2 .TH "SD\-BUS\-ERRORS" "3" "" "systemd 261~rc3" "sd-bus-errors"
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-errors, SD_BUS_ERROR_FAILED, SD_BUS_ERROR_NO_MEMORY, SD_BUS_ERROR_SERVICE_UNKNOWN, SD_BUS_ERROR_NAME_HAS_NO_OWNER, SD_BUS_ERROR_NO_REPLY, SD_BUS_ERROR_IO_ERROR, SD_BUS_ERROR_BAD_ADDRESS, SD_BUS_ERROR_NOT_SUPPORTED, SD_BUS_ERROR_LIMITS_EXCEEDED, SD_BUS_ERROR_ACCESS_DENIED, SD_BUS_ERROR_AUTH_FAILED, SD_BUS_ERROR_NO_SERVER, SD_BUS_ERROR_TIMEOUT, SD_BUS_ERROR_NO_NETWORK, SD_BUS_ERROR_ADDRESS_IN_USE, SD_BUS_ERROR_DISCONNECTED, SD_BUS_ERROR_INVALID_ARGS, SD_BUS_ERROR_FILE_NOT_FOUND, SD_BUS_ERROR_FILE_EXISTS, SD_BUS_ERROR_UNKNOWN_METHOD, SD_BUS_ERROR_UNKNOWN_OBJECT, SD_BUS_ERROR_UNKNOWN_INTERFACE, SD_BUS_ERROR_UNKNOWN_PROPERTY, SD_BUS_ERROR_PROPERTY_READ_ONLY, SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN, SD_BUS_ERROR_INVALID_SIGNATURE, SD_BUS_ERROR_INCONSISTENT_MESSAGE, SD_BUS_ERROR_TIMED_OUT, SD_BUS_ERROR_MATCH_RULE_NOT_FOUND, SD_BUS_ERROR_MATCH_RULE_INVALID, SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED, SD_BUS_ERROR_INVALID_FILE_CONTENT, SD_BUS_ERROR_SELINUX_SECURITY_CONTEXT_UNKNOWN, SD_BUS_ERROR_OBJECT_PATH_IN_USE \- Standard D\-Bus error names
24 .SH "SYNOPSIS"
25 .sp
26 .ft B
27 .nf
28 #include <systemd/sd\-bus\&.h>
29 .fi
30 .ft
31 .sp
32 .ft B
33 .nf
34 #define SD_BUS_ERROR_FAILED "org\&.freedesktop\&.DBus\&.Error\&.Failed"
35 #define SD_BUS_ERROR_NO_MEMORY "org\&.freedesktop\&.DBus\&.Error\&.NoMemory"
36 #define SD_BUS_ERROR_SERVICE_UNKNOWN "org\&.freedesktop\&.DBus\&.Error\&.ServiceUnknown"
37 #define SD_BUS_ERROR_NAME_HAS_NO_OWNER "org\&.freedesktop\&.DBus\&.Error\&.NameHasNoOwner"
38 #define SD_BUS_ERROR_NO_REPLY "org\&.freedesktop\&.DBus\&.Error\&.NoReply"
39 #define SD_BUS_ERROR_IO_ERROR "org\&.freedesktop\&.DBus\&.Error\&.IOError"
40 #define SD_BUS_ERROR_BAD_ADDRESS "org\&.freedesktop\&.DBus\&.Error\&.BadAddress"
41 #define SD_BUS_ERROR_NOT_SUPPORTED "org\&.freedesktop\&.DBus\&.Error\&.NotSupported"
42 #define SD_BUS_ERROR_LIMITS_EXCEEDED "org\&.freedesktop\&.DBus\&.Error\&.LimitsExceeded"
43 #define SD_BUS_ERROR_ACCESS_DENIED "org\&.freedesktop\&.DBus\&.Error\&.AccessDenied"
44 #define SD_BUS_ERROR_AUTH_FAILED "org\&.freedesktop\&.DBus\&.Error\&.AuthFailed"
45 #define SD_BUS_ERROR_NO_SERVER "org\&.freedesktop\&.DBus\&.Error\&.NoServer"
46 #define SD_BUS_ERROR_TIMEOUT "org\&.freedesktop\&.DBus\&.Error\&.Timeout"
47 #define SD_BUS_ERROR_NO_NETWORK "org\&.freedesktop\&.DBus\&.Error\&.NoNetwork"
48 #define SD_BUS_ERROR_ADDRESS_IN_USE "org\&.freedesktop\&.DBus\&.Error\&.AddressInUse"
49 #define SD_BUS_ERROR_DISCONNECTED "org\&.freedesktop\&.DBus\&.Error\&.Disconnected"
50 #define SD_BUS_ERROR_INVALID_ARGS "org\&.freedesktop\&.DBus\&.Error\&.InvalidArgs"
51 #define SD_BUS_ERROR_FILE_NOT_FOUND "org\&.freedesktop\&.DBus\&.Error\&.FileNotFound"
52 #define SD_BUS_ERROR_FILE_EXISTS "org\&.freedesktop\&.DBus\&.Error\&.FileExists"
53 #define SD_BUS_ERROR_UNKNOWN_METHOD "org\&.freedesktop\&.DBus\&.Error\&.UnknownMethod"
54 #define SD_BUS_ERROR_UNKNOWN_OBJECT "org\&.freedesktop\&.DBus\&.Error\&.UnknownObject"
55 #define SD_BUS_ERROR_UNKNOWN_INTERFACE "org\&.freedesktop\&.DBus\&.Error\&.UnknownInterface"
56 #define SD_BUS_ERROR_UNKNOWN_PROPERTY "org\&.freedesktop\&.DBus\&.Error\&.UnknownProperty"
57 #define SD_BUS_ERROR_PROPERTY_READ_ONLY "org\&.freedesktop\&.DBus\&.Error\&.PropertyReadOnly"
58 #define SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN "org\&.freedesktop\&.DBus\&.Error\&.UnixProcessIdUnknown"
59 #define SD_BUS_ERROR_INVALID_SIGNATURE "org\&.freedesktop\&.DBus\&.Error\&.InvalidSignature"
60 #define SD_BUS_ERROR_INCONSISTENT_MESSAGE "org\&.freedesktop\&.DBus\&.Error\&.InconsistentMessage"
61 #define SD_BUS_ERROR_TIMED_OUT "org\&.freedesktop\&.DBus\&.Error\&.TimedOut"
62 #define SD_BUS_ERROR_MATCH_RULE_NOT_FOUND "org\&.freedesktop\&.DBus\&.Error\&.MatchRuleNotFound"
63 #define SD_BUS_ERROR_MATCH_RULE_INVALID "org\&.freedesktop\&.DBus\&.Error\&.MatchRuleInvalid"
64 #define SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED \e
65 "org\&.freedesktop\&.DBus\&.Error\&.InteractiveAuthorizationRequired"
66 #define SD_BUS_ERROR_INVALID_FILE_CONTENT "org\&.freedesktop\&.DBus\&.Error\&.InvalidFileContent"
67 #define SD_BUS_ERROR_SELINUX_SECURITY_CONTEXT_UNKNOWN \e
68 "org\&.freedesktop\&.DBus\&.Error\&.SELinuxSecurityContextUnknown"
69 #define SD_BUS_ERROR_OBJECT_PATH_IN_USE "org\&.freedesktop\&.DBus\&.Error\&.ObjectPathInUse"
70
71 .fi
72 .ft
73 .SH "DESCRIPTION"
74 .PP
75 In addition to the error names user programs define, D\-Bus knows a number of generic, standardized error names that are listed below\&.
76 .PP
77 In addition to this list, in sd\-bus, the special error namespace
78 "System\&.Error\&."
79 is used to map arbitrary Linux system errors (as defined by
80 \fBerrno\fR(3)) to D\-Bus errors and back\&. For example, the error
81 \fBEUCLEAN\fR
82 is mapped to
83 "System\&.Error\&.EUCLEAN"
84 and back\&.
85 .PP
86 \fBSD_BUS_ERROR_FAILED\fR
87 .RS 4
88 A generic error indication\&. See the error message for further details\&. This error name should be avoided, in favor of a more expressive error name\&.
89 .sp
90 Added in version 223\&.
91 .RE
92 .PP
93 \fBSD_BUS_ERROR_NO_MEMORY\fR
94 .RS 4
95 A memory allocation failed, and the requested operation could not be completed\&.
96 .sp
97 Added in version 223\&.
98 .RE
99 .PP
100 \fBSD_BUS_ERROR_SERVICE_UNKNOWN\fR
101 .RS 4
102 The contacted bus service is unknown and cannot be activated\&.
103 .sp
104 Added in version 223\&.
105 .RE
106 .PP
107 \fBSD_BUS_ERROR_NAME_HAS_NO_OWNER\fR
108 .RS 4
109 The specified bus service name currently has no owner\&.
110 .sp
111 Added in version 223\&.
112 .RE
113 .PP
114 \fBSD_BUS_ERROR_NO_REPLY\fR
115 .RS 4
116 A message did not receive a reply\&. This error is usually generated after a timeout\&.
117 .sp
118 Added in version 223\&.
119 .RE
120 .PP
121 \fBSD_BUS_ERROR_IO_ERROR\fR
122 .RS 4
123 Generic input/output error, for example when accessing a socket or other I/O context\&.
124 .sp
125 Added in version 223\&.
126 .RE
127 .PP
128 \fBSD_BUS_ERROR_BAD_ADDRESS\fR
129 .RS 4
130 The specified D\-Bus bus address string is malformed\&.
131 .sp
132 Added in version 223\&.
133 .RE
134 .PP
135 \fBSD_BUS_ERROR_NOT_SUPPORTED\fR
136 .RS 4
137 The requested operation is not supported on the local system\&.
138 .sp
139 Added in version 223\&.
140 .RE
141 .PP
142 \fBSD_BUS_ERROR_LIMITS_EXCEEDED\fR
143 .RS 4
144 Some limited resource has been exhausted\&.
145 .sp
146 Added in version 223\&.
147 .RE
148 .PP
149 \fBSD_BUS_ERROR_ACCESS_DENIED\fR
150 .RS 4
151 Access to a resource has been denied due to security restrictions\&.
152 .sp
153 Added in version 223\&.
154 .RE
155 .PP
156 \fBSD_BUS_ERROR_AUTH_FAILED\fR
157 .RS 4
158 Authentication did not complete successfully\&.
159 .sp
160 Added in version 223\&.
161 .RE
162 .PP
163 \fBSD_BUS_ERROR_NO_SERVER\fR
164 .RS 4
165 Unable to connect to the specified server\&.
166 .sp
167 Added in version 223\&.
168 .RE
169 .PP
170 \fBSD_BUS_ERROR_TIMEOUT\fR
171 .RS 4
172 An operation timed out\&. Note that method calls which timeout generate a
173 \fBSD_BUS_ERROR_NO_REPLY\fR\&.
174 .sp
175 Added in version 223\&.
176 .RE
177 .PP
178 \fBSD_BUS_ERROR_NO_NETWORK\fR
179 .RS 4
180 No network available to execute requested network operation on\&.
181 .sp
182 Added in version 223\&.
183 .RE
184 .PP
185 \fBSD_BUS_ERROR_ADDRESS_IN_USE\fR
186 .RS 4
187 The specified network address is already being listened on\&.
188 .sp
189 Added in version 223\&.
190 .RE
191 .PP
192 \fBSD_BUS_ERROR_DISCONNECTED\fR
193 .RS 4
194 The connection has been terminated\&.
195 .sp
196 Added in version 223\&.
197 .RE
198 .PP
199 \fBSD_BUS_ERROR_INVALID_ARGS\fR
200 .RS 4
201 One or more invalid arguments have been passed\&.
202 .sp
203 Added in version 223\&.
204 .RE
205 .PP
206 \fBSD_BUS_ERROR_FILE_NOT_FOUND\fR
207 .RS 4
208 The requested file could not be found\&.
209 .sp
210 Added in version 223\&.
211 .RE
212 .PP
213 \fBSD_BUS_ERROR_FILE_EXISTS\fR
214 .RS 4
215 The requested file already exists\&.
216 .sp
217 Added in version 223\&.
218 .RE
219 .PP
220 \fBSD_BUS_ERROR_UNKNOWN_METHOD\fR
221 .RS 4
222 The requested method does not exist in the selected interface\&.
223 .sp
224 Added in version 223\&.
225 .RE
226 .PP
227 \fBSD_BUS_ERROR_UNKNOWN_OBJECT\fR
228 .RS 4
229 The requested object does not exist in the selected service\&.
230 .sp
231 Added in version 223\&.
232 .RE
233 .PP
234 \fBSD_BUS_ERROR_UNKNOWN_INTERFACE\fR
235 .RS 4
236 The requested interface does not exist on the selected object\&.
237 .sp
238 Added in version 223\&.
239 .RE
240 .PP
241 \fBSD_BUS_ERROR_UNKNOWN_PROPERTY\fR
242 .RS 4
243 The requested property does not exist in the selected interface\&.
244 .sp
245 Added in version 223\&.
246 .RE
247 .PP
248 \fBSD_BUS_ERROR_PROPERTY_READ_ONLY\fR
249 .RS 4
250 A write operation was requested on a read\-only property\&.
251 .sp
252 Added in version 223\&.
253 .RE
254 .PP
255 \fBSD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN\fR
256 .RS 4
257 The requested PID is not known\&.
258 .sp
259 Added in version 223\&.
260 .RE
261 .PP
262 \fBSD_BUS_ERROR_INVALID_SIGNATURE\fR
263 .RS 4
264 The specified message signature is not valid\&.
265 .sp
266 Added in version 223\&.
267 .RE
268 .PP
269 \fBSD_BUS_ERROR_INCONSISTENT_MESSAGE\fR
270 .RS 4
271 The passed message does not validate correctly\&.
272 .sp
273 Added in version 223\&.
274 .RE
275 .PP
276 \fBSD_BUS_ERROR_MATCH_RULE_NOT_FOUND\fR
277 .RS 4
278 The specified match rule does not exist\&.
279 .sp
280 Added in version 223\&.
281 .RE
282 .PP
283 \fBSD_BUS_ERROR_MATCH_RULE_INVALID\fR
284 .RS 4
285 The specified match rule is invalid\&.
286 .sp
287 Added in version 223\&.
288 .RE
289 .PP
290 \fBSD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED\fR
291 .RS 4
292 Access to the requested operation is not permitted\&. However, it might be available after interactive authentication\&. This is usually returned by method calls supporting a framework for additional interactive authorization, when interactive authorization was not enabled with the
293 \fBsd_bus_message_set_allow_interactive_authorization\fR(3)
294 for the method call message\&.
295 .sp
296 Added in version 223\&.
297 .RE
298 .SH "NOTES"
299 .PP
300 Functions described here are available as a shared library, which can be compiled against and linked to with the
301 \fBlibsystemd\fR\ \&\fBpkg-config\fR(1)
302 file\&.
303 .PP
304 The code described here uses
305 \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
306 \fBsetenv\fR(3)
307 from a parallel thread\&. It is recommended to only do calls to
308 \fBsetenv()\fR
309 from an early phase of the program when no other threads have been started\&.
310 .SH "SEE ALSO"
311 .PP
312 \fBsystemd\fR(1), \fBlibsystemd\fR(3), \fBsd-bus\fR(3), \fBsd_bus_error\fR(3), \fBsd_bus_message_set_allow_interactive_authorization\fR(3), \fBerrno\fR(3), \fBstrerror_r\fR(3)