summaryrefslogtreecommitdiff
path: root/Software/DBusBindingErrors.mdwn
blob: 696f30ec2821a9dab008e112487b72a152884077 (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

This page is for bindings authors to discuss what generic errors should be sent by the binding: 
[[!table header="no" class="mointable" data="""
**Name** | **Description** | **Comments**
ServiceUnknown | The recipient bus name is not taken | In Core
UnknownObject | The sender has called a method on an object not exported on this connection (the service name is valid) | Used by Java
UnknownInterface | The sender has specified an interface this object does not implement (but the object is valid) | Requested by Thiago
UnknownMethod | The specified method is not implemented on this object (but the object and the interface names are valid) | In core
InvalidParameters | Method was called with an invalid number or type of parameters. (Comment: org.freedesktop.DBus.Error.InvalidArgs seems more suitable for this use, especially considering there is no "parameter" in D-Bus terminology -- alp) | Suggested by Matt
"""]]

Please add other errors you think should, or could possibly, be useful 

Other comments: 

* What about errors in executing the method within the binding? There could be problems with marshalling and so on? At the moment I send an internal error with a specific message, should there be a generic error type? - Matt 
* About InvalidParameters: some bindings could not implement it and use only UnknownMethod. Methods in those bindings are recognised by both the method name and signature. The bindings that support overloading through parameters are the case (C++ and Java especially). 
* Objects that have children must never reply with UnknownObject. 

## The format of error messages

The spec suggests that error messages can contain different arguments and aren't restricted to a single string. Do any core errors or binding errors make use of this? Would this be useful when mapping exceptions thrown by an object binding, say for the stack trace etc.? 

The spec should specifically say whether the string is mandatory as the first parameter or not. It should also make it clear if more parameters are permitted or not. 


## Well-known core errors

This is a list of core errors for reference. They are usually kept in order because it seems the glib binding puts them in an enumeration. Are these documented anywhere? 

* org.freedesktop.DBus.Error.Failed
* org.freedesktop.DBus.Error.NoMemory
* org.freedesktop.DBus.Error.ServiceUnknown
* org.freedesktop.DBus.Error.NameHasNoOwner
* org.freedesktop.DBus.Error.NoReply
* org.freedesktop.DBus.Error.IOError
* org.freedesktop.DBus.Error.BadAddress
* org.freedesktop.DBus.Error.NotSupported
* org.freedesktop.DBus.Error.LimitsExceeded
* org.freedesktop.DBus.Error.AccessDenied
* org.freedesktop.DBus.Error.AuthFailed
* org.freedesktop.DBus.Error.NoServer
* org.freedesktop.DBus.Error.Timeout
* org.freedesktop.DBus.Error.NoNetwork
* org.freedesktop.DBus.Error.AddressInUse
* org.freedesktop.DBus.Error.Disconnected
* org.freedesktop.DBus.Error.InvalidArgs
* org.freedesktop.DBus.Error.FileNotFound
* org.freedesktop.DBus.Error.UnknownMethod
* org.freedesktop.DBus.Error.TimedOut
* org.freedesktop.DBus.Error.MatchRuleNotFound
* org.freedesktop.DBus.Error.MatchRuleInvalid
* org.freedesktop.DBus.Error.Spawn.ExecFailed
* org.freedesktop.DBus.Error.Spawn.ForkFailed
* org.freedesktop.DBus.Error.Spawn.ChildExited
* org.freedesktop.DBus.Error.Spawn.ChildSignaled
* org.freedesktop.DBus.Error.Spawn.Failed
* org.freedesktop.DBus.Error.UnixProcessIdUnknown
* org.freedesktop.DBus.Error.InvalidSignature
* org.freedesktop.DBus.Error.SELinuxSecurityContextUnknown