Add some more callbacks to agent documentation
authorMarcel Holtmann <marcel@holtmann.org>
Sun, 30 Aug 2009 05:40:23 +0000 (22:40 -0700)
committerMarcel Holtmann <marcel@holtmann.org>
Sun, 30 Aug 2009 05:40:23 +0000 (22:40 -0700)
doc/agent-api.txt

index f39c966..c68dd2c 100644 (file)
@@ -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.