summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man3/sd-bus-errors.3
blob: 2d002d9879344b17d50bf633abf31f68414fd160 (plain)
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
'\" t
.TH "SD\-BUS\-ERRORS" "3" "" "systemd 256~rc3" "sd-bus-errors"
.\" -----------------------------------------------------------------
.\" * 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-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
.SH "SYNOPSIS"
.sp
.ft B
.nf
#include <systemd/sd\-bus\&.h>
.fi
.ft
.sp
.ft B
.nf
#define SD_BUS_ERROR_FAILED                  "org\&.freedesktop\&.DBus\&.Error\&.Failed"
#define SD_BUS_ERROR_NO_MEMORY               "org\&.freedesktop\&.DBus\&.Error\&.NoMemory"
#define SD_BUS_ERROR_SERVICE_UNKNOWN         "org\&.freedesktop\&.DBus\&.Error\&.ServiceUnknown"
#define SD_BUS_ERROR_NAME_HAS_NO_OWNER       "org\&.freedesktop\&.DBus\&.Error\&.NameHasNoOwner"
#define SD_BUS_ERROR_NO_REPLY                "org\&.freedesktop\&.DBus\&.Error\&.NoReply"
#define SD_BUS_ERROR_IO_ERROR                "org\&.freedesktop\&.DBus\&.Error\&.IOError"
#define SD_BUS_ERROR_BAD_ADDRESS             "org\&.freedesktop\&.DBus\&.Error\&.BadAddress"
#define SD_BUS_ERROR_NOT_SUPPORTED           "org\&.freedesktop\&.DBus\&.Error\&.NotSupported"
#define SD_BUS_ERROR_LIMITS_EXCEEDED         "org\&.freedesktop\&.DBus\&.Error\&.LimitsExceeded"
#define SD_BUS_ERROR_ACCESS_DENIED           "org\&.freedesktop\&.DBus\&.Error\&.AccessDenied"
#define SD_BUS_ERROR_AUTH_FAILED             "org\&.freedesktop\&.DBus\&.Error\&.AuthFailed"
#define SD_BUS_ERROR_NO_SERVER               "org\&.freedesktop\&.DBus\&.Error\&.NoServer"
#define SD_BUS_ERROR_TIMEOUT                 "org\&.freedesktop\&.DBus\&.Error\&.Timeout"
#define SD_BUS_ERROR_NO_NETWORK              "org\&.freedesktop\&.DBus\&.Error\&.NoNetwork"
#define SD_BUS_ERROR_ADDRESS_IN_USE          "org\&.freedesktop\&.DBus\&.Error\&.AddressInUse"
#define SD_BUS_ERROR_DISCONNECTED            "org\&.freedesktop\&.DBus\&.Error\&.Disconnected"
#define SD_BUS_ERROR_INVALID_ARGS            "org\&.freedesktop\&.DBus\&.Error\&.InvalidArgs"
#define SD_BUS_ERROR_FILE_NOT_FOUND          "org\&.freedesktop\&.DBus\&.Error\&.FileNotFound"
#define SD_BUS_ERROR_FILE_EXISTS             "org\&.freedesktop\&.DBus\&.Error\&.FileExists"
#define SD_BUS_ERROR_UNKNOWN_METHOD          "org\&.freedesktop\&.DBus\&.Error\&.UnknownMethod"
#define SD_BUS_ERROR_UNKNOWN_OBJECT          "org\&.freedesktop\&.DBus\&.Error\&.UnknownObject"
#define SD_BUS_ERROR_UNKNOWN_INTERFACE       "org\&.freedesktop\&.DBus\&.Error\&.UnknownInterface"
#define SD_BUS_ERROR_UNKNOWN_PROPERTY        "org\&.freedesktop\&.DBus\&.Error\&.UnknownProperty"
#define SD_BUS_ERROR_PROPERTY_READ_ONLY      "org\&.freedesktop\&.DBus\&.Error\&.PropertyReadOnly"
#define SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN "org\&.freedesktop\&.DBus\&.Error\&.UnixProcessIdUnknown"
#define SD_BUS_ERROR_INVALID_SIGNATURE       "org\&.freedesktop\&.DBus\&.Error\&.InvalidSignature"
#define SD_BUS_ERROR_INCONSISTENT_MESSAGE    "org\&.freedesktop\&.DBus\&.Error\&.InconsistentMessage"
#define SD_BUS_ERROR_TIMED_OUT               "org\&.freedesktop\&.DBus\&.Error\&.TimedOut"
#define SD_BUS_ERROR_MATCH_RULE_NOT_FOUND    "org\&.freedesktop\&.DBus\&.Error\&.MatchRuleNotFound"
#define SD_BUS_ERROR_MATCH_RULE_INVALID      "org\&.freedesktop\&.DBus\&.Error\&.MatchRuleInvalid"
#define SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED \e
                                             "org\&.freedesktop\&.DBus\&.Error\&.InteractiveAuthorizationRequired"
#define SD_BUS_ERROR_INVALID_FILE_CONTENT    "org\&.freedesktop\&.DBus\&.Error\&.InvalidFileContent"
#define SD_BUS_ERROR_SELINUX_SECURITY_CONTEXT_UNKNOWN \e
                                             "org\&.freedesktop\&.DBus\&.Error\&.SELinuxSecurityContextUnknown"
#define SD_BUS_ERROR_OBJECT_PATH_IN_USE      "org\&.freedesktop\&.DBus\&.Error\&.ObjectPathInUse"
      
.fi
.ft
.SH "DESCRIPTION"
.PP
In addition to the error names user programs define, D\-Bus knows a number of generic, standardized error names that are listed below\&.
.PP
In addition to this list, in sd\-bus, the special error namespace
"System\&.Error\&."
is used to map arbitrary Linux system errors (as defined by
\fBerrno\fR(3)) to D\-Bus errors and back\&. For example, the error
\fBEUCLEAN\fR
is mapped to
"System\&.Error\&.EUCLEAN"
and back\&.
.PP
\fBSD_BUS_ERROR_FAILED\fR
.RS 4
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\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_NO_MEMORY\fR
.RS 4
A memory allocation failed, and the requested operation could not be completed\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_SERVICE_UNKNOWN\fR
.RS 4
The contacted bus service is unknown and cannot be activated\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_NAME_HAS_NO_OWNER\fR
.RS 4
The specified bus service name currently has no owner\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_NO_REPLY\fR
.RS 4
A message did not receive a reply\&. This error is usually generated after a timeout\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_IO_ERROR\fR
.RS 4
Generic input/output error, for example when accessing a socket or other I/O context\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_BAD_ADDRESS\fR
.RS 4
The specified D\-Bus bus address string is malformed\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_NOT_SUPPORTED\fR
.RS 4
The requested operation is not supported on the local system\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_LIMITS_EXCEEDED\fR
.RS 4
Some limited resource has been exhausted\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_ACCESS_DENIED\fR
.RS 4
Access to a resource has been denied due to security restrictions\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_AUTH_FAILED\fR
.RS 4
Authentication did not complete successfully\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_NO_SERVER\fR
.RS 4
Unable to connect to the specified server\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_TIMEOUT\fR
.RS 4
An operation timed out\&. Note that method calls which timeout generate a
\fBSD_BUS_ERROR_NO_REPLY\fR\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_NO_NETWORK\fR
.RS 4
No network available to execute requested network operation on\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_ADDRESS_IN_USE\fR
.RS 4
The specified network address is already being listened on\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_DISCONNECTED\fR
.RS 4
The connection has been terminated\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_INVALID_ARGS\fR
.RS 4
One or more invalid arguments have been passed\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_FILE_NOT_FOUND\fR
.RS 4
The requested file could not be found\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_FILE_EXISTS\fR
.RS 4
The requested file already exists\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_UNKNOWN_METHOD\fR
.RS 4
The requested method does not exist in the selected interface\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_UNKNOWN_OBJECT\fR
.RS 4
The requested object does not exist in the selected service\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_UNKNOWN_INTERFACE\fR
.RS 4
The requested interface does not exist on the selected object\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_UNKNOWN_PROPERTY\fR
.RS 4
The requested property does not exist in the selected interface\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_PROPERTY_READ_ONLY\fR
.RS 4
A write operation was requested on a read\-only property\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN\fR
.RS 4
The requested PID is not known\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_INVALID_SIGNATURE\fR
.RS 4
The specified message signature is not valid\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_INCONSISTENT_MESSAGE\fR
.RS 4
The passed message does not validate correctly\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_MATCH_RULE_NOT_FOUND\fR
.RS 4
The specified match rule does not exist\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_MATCH_RULE_INVALID\fR
.RS 4
The specified match rule is invalid\&.
.sp
Added in version 223\&.
.RE
.PP
\fBSD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED\fR
.RS 4
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
\fBsd_bus_message_set_allow_interactive_authorization\fR(3)
for the method call message\&.
.sp
Added in version 223\&.
.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 "SEE ALSO"
.PP
\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)