diff options
author | Christian Grothoff <christian@grothoff.org> | 2014-04-24 19:41:30 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2014-04-24 19:41:30 +0000 |
commit | c94a82388f7f483f9b77023ce5a0abf1b68c7e33 (patch) | |
tree | d8e5f4ecb6a2c445ba794463cfcfe6f0d348b2f5 | |
parent | f1f821746b9a46aec53318bfa3a58925f66f0166 (diff) | |
download | libmicrohttpd-c94a82388f7f483f9b77023ce5a0abf1b68c7e33.tar.gz libmicrohttpd-c94a82388f7f483f9b77023ce5a0abf1b68c7e33.zip |
improve documentation for key-value iterator
-rw-r--r-- | doc/libmicrohttpd.texi | 15 | ||||
-rw-r--r-- | src/include/microhttpd.h | 4 | ||||
-rw-r--r-- | src/microhttpd/daemon.c | 1 |
3 files changed, 20 insertions, 0 deletions
diff --git a/doc/libmicrohttpd.texi b/doc/libmicrohttpd.texi index 52c8e19d..f229b033 100644 --- a/doc/libmicrohttpd.texi +++ b/doc/libmicrohttpd.texi | |||
@@ -1123,6 +1123,21 @@ over all of the cookies, headers, or @code{POST}-data fields of a | |||
1123 | request, and also to iterate over the headers that have been added to a | 1123 | request, and also to iterate over the headers that have been added to a |
1124 | response. | 1124 | response. |
1125 | 1125 | ||
1126 | @table @var | ||
1127 | @item cls | ||
1128 | custom value specified when iteration was triggered; | ||
1129 | |||
1130 | @item kind | ||
1131 | kind of the header we are looking at | ||
1132 | |||
1133 | @item key | ||
1134 | key for the value, can be an empty string | ||
1135 | |||
1136 | @item value | ||
1137 | value corresponding value, can be NULL | ||
1138 | |||
1139 | @end table | ||
1140 | |||
1126 | Return @code{MHD_YES} to continue iterating, @code{MHD_NO} to abort the | 1141 | Return @code{MHD_YES} to continue iterating, @code{MHD_NO} to abort the |
1127 | iteration. | 1142 | iteration. |
1128 | @end deftypefn | 1143 | @end deftypefn |
diff --git a/src/include/microhttpd.h b/src/include/microhttpd.h index b5d6b054..46346097 100644 --- a/src/include/microhttpd.h +++ b/src/include/microhttpd.h | |||
@@ -1218,6 +1218,10 @@ typedef void | |||
1218 | * also to iterate over the headers that have been | 1218 | * also to iterate over the headers that have been |
1219 | * added to a response. | 1219 | * added to a response. |
1220 | * | 1220 | * |
1221 | * @param cls closure | ||
1222 | * @param kind kind of the header we are looking at | ||
1223 | * @param key key for the value, can be an empty string | ||
1224 | * @param value corresponding value, can be NULL | ||
1221 | * @return #MHD_YES to continue iterating, | 1225 | * @return #MHD_YES to continue iterating, |
1222 | * #MHD_NO to abort the iteration | 1226 | * #MHD_NO to abort the iteration |
1223 | * @ingroup request | 1227 | * @ingroup request |
diff --git a/src/microhttpd/daemon.c b/src/microhttpd/daemon.c index a65aca8f..55bd363c 100644 --- a/src/microhttpd/daemon.c +++ b/src/microhttpd/daemon.c | |||
@@ -1589,6 +1589,7 @@ MHD_resume_connection (struct MHD_Connection *connection) | |||
1589 | MHD_PANIC ("Failed to release cleanup mutex\n"); | 1589 | MHD_PANIC ("Failed to release cleanup mutex\n"); |
1590 | } | 1590 | } |
1591 | 1591 | ||
1592 | |||
1592 | /** | 1593 | /** |
1593 | * Run through the suspended connections and move any that are no | 1594 | * Run through the suspended connections and move any that are no |
1594 | * longer suspended back to the active state. | 1595 | * longer suspended back to the active state. |