[taler-anastasis] branch master updated: document plugin

[gnunet]

This is an automated email from the git hooks/post-receive script.

grothoff pushed a commit to branch master
in repository anastasis.

The following commit(s) were added to refs/heads/master by this push:
     new bbd4d9a  document plugin
bbd4d9a is described below

commit bbd4d9a463af0b18586bb308df8edbac5072d0ae
Author: Christian Grothoff <christian@grothoff.org>
AuthorDate: Tue Oct 20 10:39:53 2020 +0200

    document plugin
---
 src/include/anastasis_authorization_plugin.h | 46 +++++++++++++++++++++++++---
 1 file changed, 42 insertions(+), 4 deletions(-)

diff --git a/src/include/anastasis_authorization_plugin.h 
b/src/include/anastasis_authorization_plugin.h
index 852c308..05e95ae 100644
--- a/src/include/anastasis_authorization_plugin.h
+++ b/src/include/anastasis_authorization_plugin.h
@@ -35,12 +35,50 @@
 struct ANASTASIS_AUTHORIZATION_State;
 
 
+/**
+ * Enumeration values indicating the various possible
+ * outcomes of the plugin's `process` function.
+ */
 enum ANASTASIS_AUTHORIZATION_Result
 {
-  ANASTASIS_AUTHORIZATION_RES_SUCCESS,
-  ANASTASIS_AUTHORIZATION_RES_FAILED,
-  ANASTASIS_AUTHORIZATION_RES_SUSPENDED,
-  ANASTASIS_AUTHORIZATION_RES_REPLY_FAILED
+  /**
+   * We successfully sent the authorization challenge
+   * and queued a reply to MHD.
+   */
+  ANASTASIS_AUTHORIZATION_RES_SUCCESS = 0,
+
+  /**
+   * We failed to transmit the authorization challenge,
+   * but successfully queued a failure response to MHD.
+   */
+  ANASTASIS_AUTHORIZATION_RES_FAILED = 1,
+
+  /**
+   * The plugin suspended the MHD connection as it needs some more
+   * time to do its (asynchronous) work before we can proceed. The
+   * plugin will resume the MHD connection when its work is done, and
+   * then the `process` function should be called again.
+   */
+  ANASTASIS_AUTHORIZATION_RES_SUSPENDED = 2,
+
+  /**
+   * The plugin tried to queue a reply on the MHD connection and
+   * failed to do so.  We should return #MHD_NO to MHD to cause the
+   * HTTP connection to be closed without any reply.
+   *
+   * However, we were successful at transmitting the challenge,
+   * so the challenge should be marked as sent.
+   */
+  ANASTASIS_AUTHORIZATION_RES_SUCCESS_REPLY_FAILED = 4,
+
+  /**
+   * The plugin tried to queue a reply on the MHD connection and
+   * failed to do so.  We should return #MHD_NO to MHD to cause the
+   * HTTP connection to be closed without any reply.
+   *
+   * Additionally, we failed to transmit the challenge.
+   */
+  ANASTASIS_AUTHORIZATION_RES_FAILED_REPLY_FAILED = 5
 };
 
 

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.