aboutsummaryrefslogtreecommitdiff
path: root/src/microhttpd/connection.c
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2013-08-22 06:16:06 +0000
committerChristian Grothoff <christian@grothoff.org>2013-08-22 06:16:06 +0000
commit4f6aa30eb0bb5ffe9052e4a87aefef2d16d33868 (patch)
tree1fe19f96fcb5c3d90163c8029a0e31343aa70c40 /src/microhttpd/connection.c
parent131368c7194d776adae1263aba4868f041694b42 (diff)
downloadlibmicrohttpd-4f6aa30eb0bb5ffe9052e4a87aefef2d16d33868.tar.gz
libmicrohttpd-4f6aa30eb0bb5ffe9052e4a87aefef2d16d33868.zip
-more doxygen improvements
Diffstat (limited to 'src/microhttpd/connection.c')
-rw-r--r--src/microhttpd/connection.c42
1 files changed, 24 insertions, 18 deletions
diff --git a/src/microhttpd/connection.c b/src/microhttpd/connection.c
index c16ee571..4b30a4c0 100644
--- a/src/microhttpd/connection.c
+++ b/src/microhttpd/connection.c
@@ -113,8 +113,9 @@
113 * @param kind types of values to iterate over 113 * @param kind types of values to iterate over
114 * @param iterator callback to call on each header; 114 * @param iterator callback to call on each header;
115 * maybe NULL (then just count headers) 115 * maybe NULL (then just count headers)
116 * @param iterator_cls extra argument to iterator 116 * @param iterator_cls extra argument to @a iterator
117 * @return number of entries iterated over 117 * @return number of entries iterated over
118 * @ingroup request
118 */ 119 */
119int 120int
120MHD_get_connection_values (struct MHD_Connection *connection, 121MHD_get_connection_values (struct MHD_Connection *connection,
@@ -141,15 +142,15 @@ MHD_get_connection_values (struct MHD_Connection *connection,
141 142
142 143
143/** 144/**
144 * This function can be used to append an entry to the list of HTTP 145 * This function can be used to add an entry to the HTTP headers of a
145 * headers of a connection (so that the MHD_get_connection_values 146 * connection (so that the #MHD_get_connection_values function will
146 * function will return them -- and the MHD PostProcessor will also 147 * return them -- and the `struct MHD_PostProcessor` will also see
147 * see them). This maybe required in certain situations (see Mantis 148 * them). This maybe required in certain situations (see Mantis
148 * #1399) where (broken) HTTP implementations fail to supply values 149 * #1399) where (broken) HTTP implementations fail to supply values
149 * needed by the post processor (or other parts of the application). 150 * needed by the post processor (or other parts of the application).
150 * 151 *
151 * This function MUST only be called from within the 152 * This function MUST only be called from within the
152 * MHD_AccessHandlerCallback (otherwise, access maybe improperly 153 * #MHD_AccessHandlerCallback (otherwise, access maybe improperly
153 * synchronized). Furthermore, the client must guarantee that the key 154 * synchronized). Furthermore, the client must guarantee that the key
154 * and value arguments are 0-terminated strings that are NOT freed 155 * and value arguments are 0-terminated strings that are NOT freed
155 * until the connection is closed. (The easiest way to do this is by 156 * until the connection is closed. (The easiest way to do this is by
@@ -160,9 +161,10 @@ MHD_get_connection_values (struct MHD_Connection *connection,
160 * @param kind kind of the value 161 * @param kind kind of the value
161 * @param key key for the value 162 * @param key key for the value
162 * @param value the value itself 163 * @param value the value itself
163 * @return MHD_NO if the operation could not be 164 * @return #MHD_NO if the operation could not be
164 * performed due to insufficient memory; 165 * performed due to insufficient memory;
165 * MHD_YES on success 166 * #MHD_YES on success
167 * @ingroup request
166 */ 168 */
167int 169int
168MHD_set_connection_value (struct MHD_Connection *connection, 170MHD_set_connection_value (struct MHD_Connection *connection,
@@ -202,6 +204,7 @@ MHD_set_connection_value (struct MHD_Connection *connection,
202 * @param kind what kind of value are we looking for 204 * @param kind what kind of value are we looking for
203 * @param key the header to look for, NULL to lookup 'trailing' value without a key 205 * @param key the header to look for, NULL to lookup 'trailing' value without a key
204 * @return NULL if no such item was found 206 * @return NULL if no such item was found
207 * @ingroup request
205 */ 208 */
206const char * 209const char *
207MHD_lookup_connection_value (struct MHD_Connection *connection, 210MHD_lookup_connection_value (struct MHD_Connection *connection,
@@ -2561,15 +2564,16 @@ MHD_set_http_callbacks_ (struct MHD_Connection *connection)
2561 * 2564 *
2562 * @param connection what connection to get information about 2565 * @param connection what connection to get information about
2563 * @param infoType what information is desired? 2566 * @param infoType what information is desired?
2564 * @param ... depends on infoType 2567 * @param ... depends on @a info_type
2565 * @return NULL if this information is not available 2568 * @return NULL if this information is not available
2566 * (or if the infoType is unknown) 2569 * (or if the @a info_type is unknown)
2570 * @ingroup specialized
2567 */ 2571 */
2568const union MHD_ConnectionInfo * 2572const union MHD_ConnectionInfo *
2569MHD_get_connection_info (struct MHD_Connection *connection, 2573MHD_get_connection_info (struct MHD_Connection *connection,
2570 enum MHD_ConnectionInfoType infoType, ...) 2574 enum MHD_ConnectionInfoType info_type, ...)
2571{ 2575{
2572 switch (infoType) 2576 switch (info_type)
2573 { 2577 {
2574#if HTTPS_SUPPORT 2578#if HTTPS_SUPPORT
2575 case MHD_CONNECTION_INFO_CIPHER_ALGO: 2579 case MHD_CONNECTION_INFO_CIPHER_ALGO:
@@ -2605,7 +2609,8 @@ MHD_get_connection_info (struct MHD_Connection *connection,
2605 * @param connection connection to modify 2609 * @param connection connection to modify
2606 * @param option option to set 2610 * @param option option to set
2607 * @param ... arguments to the option, depending on the option type 2611 * @param ... arguments to the option, depending on the option type
2608 * @return MHD_YES on success, MHD_NO if setting the option failed 2612 * @return #MHD_YES on success, #MHD_NO if setting the option failed
2613 * @ingroup specialized
2609 */ 2614 */
2610int 2615int
2611MHD_set_connection_option (struct MHD_Connection *connection, 2616MHD_set_connection_option (struct MHD_Connection *connection,
@@ -2653,13 +2658,14 @@ MHD_set_connection_option (struct MHD_Connection *connection,
2653 2658
2654/** 2659/**
2655 * Queue a response to be transmitted to the client (as soon as 2660 * Queue a response to be transmitted to the client (as soon as
2656 * possible but after MHD_AccessHandlerCallback returns). 2661 * possible but after #MHD_AccessHandlerCallback returns).
2657 * 2662 *
2658 * @param connection the connection identifying the client 2663 * @param connection the connection identifying the client
2659 * @param status_code HTTP status code (i.e. 200 for OK) 2664 * @param status_code HTTP status code (i.e. #MHD_HTTP_OK)
2660 * @param response response to transmit 2665 * @param response response to transmit
2661 * @return MHD_NO on error (i.e. reply already sent), 2666 * @return #MHD_NO on error (i.e. reply already sent),
2662 * MHD_YES on success or if message has been queued 2667 * #MHD_YES on success or if message has been queued
2668 * @ingroup response
2663 */ 2669 */
2664int 2670int
2665MHD_queue_response (struct MHD_Connection *connection, 2671MHD_queue_response (struct MHD_Connection *connection,