gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[GNUnet-SVN] [libmicrohttpd] branch master updated (9b6340ff -> 4233bad6


From: gnunet
Subject: [GNUnet-SVN] [libmicrohttpd] branch master updated (9b6340ff -> 4233bad6)
Date: Sun, 13 Aug 2017 12:50:26 +0200

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

grothoff pushed a change to branch master
in repository libmicrohttpd.

    from 9b6340ff microhttpd2.h: fixed c/p errors
     new 1a5a035c expand justifications
     new 8a60c4cf improve comments, cosmetic
     new 4233bad6 merge

The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 src/include/microhttpd2.h | 26 ++++++++++++++++++--------
 1 file changed, 18 insertions(+), 8 deletions(-)

diff --git a/src/include/microhttpd2.h b/src/include/microhttpd2.h
index 91f5b258..ec15d5dd 100644
--- a/src/include/microhttpd2.h
+++ b/src/include/microhttpd2.h
@@ -54,6 +54,11 @@
  *   at the same time avoid symbol conflict with legacy names
  *   (so we can have one binary implementing old and new 
  *   library API at the same time via compatibility layer).
+ * - make it impossible to queue a response at the wrong time
+ * - make it clear which response status codes are "properly" 
+ *   supported (include the descriptive string) by using an enum;
+ * - simplify API for common-case of one-shot responses by
+ *   eliminating need for destroy response in those cases;
  * - improve thread-safety
  */
 
@@ -101,7 +106,10 @@ enum MHD_OptionValue;
 
 
 /**
- * Option configuring the service.
+ * Option configuring the service.  This struct should be treated as
+ * completely opaque by the application.  It is declared in the header
+ * to support applications allocating arrays of this struct (in
+ * particular on the stack).
  */
 struct MHD_Option
 {
@@ -112,17 +120,17 @@ struct MHD_Option
   enum MHD_OptionValue option;
 
   /**
-   * Option value.
+   * Option value.  Internal-use only!
    */
   intptr_t value1;
 
   /**
-   * Option value.
+   * Option value.  Internal-use only!
    */
   intptr_t value2;
   
   /**
-   * Option value.
+   * Option value.  Internal-use only!
    */
   intptr_t value3;
 
@@ -175,7 +183,7 @@ MHD_option_suppress_date_no_clock (void);
  * enforced by #MHD_option_allow_suspend_resume() and if there is no
  * listen socket.  #MHD_option_enable_itc() is always used
  * automatically on platforms where select()/poll()/other ignore
- * shutdown of listen socket.
+ * shutdown() of a listen socket.
  *
  * @return MHD option
  */
@@ -490,7 +498,7 @@ MHD_option_gnutls_credentials (int gnutls_credentials);
  * the SNI information provided.  The callback is expected to access
  * the SNI data using `gnutls_server_name_get()`.  Using this option
  * requires GnuTLS 3.0 or higher.
-   *
+ *
  * @param cb must be of type `gnutls_certificate_retrieve_function2 *`.
  * @return MHD option
  */
@@ -1274,8 +1282,10 @@ enum MHD_HTTP_StatusCode {
  * request is suspended, MHD will not detect disconnects by the
  * client.
  *
- * The only safe time to suspend a request is from the
- * #MHD_AccessHandlerCallback.
+ * The only safe time to suspend a request is from either a
+ * #MHD_RequestHeaderCallback, #MHD_UploadCallback, or a
+ * #MHD_RequestfetchResponseCallback.  Suspending a request
+ * at any other time will cause an assertion failure.
  *
  * Finally, it is an API violation to call #MHD_stop_daemon while
  * having suspended requests (this will at least create memory and

-- 
To stop receiving notification emails like this one, please contact
address@hidden



reply via email to

[Prev in Thread] Current Thread [Next in Thread]