summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2009-08-29 22:40:23 -0700
committerMarcel Holtmann <marcel@holtmann.org>2009-08-29 22:40:23 -0700
commitcc9ef4d64c25b22f056c6e0e5c096f0d32841f47 (patch)
tree1109598e6f9797fe8547fef678d79a023595d83a /doc
parent29ff3552e43a2fe58a1e49ca469ff50932146509 (diff)
downloadconnman-cc9ef4d64c25b22f056c6e0e5c096f0d32841f47.tar.gz
connman-cc9ef4d64c25b22f056c6e0e5c096f0d32841f47.tar.bz2
connman-cc9ef4d64c25b22f056c6e0e5c096f0d32841f47.zip
Add some more callbacks to agent documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/agent-api.txt25
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/agent-api.txt b/doc/agent-api.txt
index f39c9664..c68dd2ce 100644
--- a/doc/agent-api.txt
+++ b/doc/agent-api.txt
@@ -12,3 +12,28 @@ Methods void Release()
cleanup tasks. There is no need to unregister the
agent, because when this method gets called it has
already been unregistered.
+
+ void ReportError(object service, string error)
+
+ This method gets called when an error has to be
+ reported to the user.
+
+ A special return value can be used to trigger a
+ retry of the failed transaction.
+
+ Possible Errors: [service].Error.Retry
+
+ string RequestPassphrase(object service)
+
+ This method gets called when trying to connect to
+ a service and a passphrase is missing.
+
+ The return value should be the passphrase string or
+ an error indicating that the request got cannceled.
+
+ Possible Errors: [service].Error.Canceled
+
+ void Cancel()
+
+ This method gets called to indicate that the agent
+ request failed before a reply was returned.