aboutsummaryrefslogtreecommitdiff
path: root/src/include/microhttpd.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/include/microhttpd.h')
-rw-r--r--src/include/microhttpd.h28
1 files changed, 14 insertions, 14 deletions
diff --git a/src/include/microhttpd.h b/src/include/microhttpd.h
index 811b2fc0..87d2f86e 100644
--- a/src/include/microhttpd.h
+++ b/src/include/microhttpd.h
@@ -1629,12 +1629,12 @@ enum MHD_OPTION
1629 * void * my_logger(void *cls, const char *uri, struct MHD_Connection *con) 1629 * void * my_logger(void *cls, const char *uri, struct MHD_Connection *con)
1630 * 1630 *
1631 * where the return value will be passed as 1631 * where the return value will be passed as
1632 * (`* con_cls`) in calls to the #MHD_AccessHandlerCallback 1632 * (`* req_cls`) in calls to the #MHD_AccessHandlerCallback
1633 * when this request is processed later; returning a 1633 * when this request is processed later; returning a
1634 * value of NULL has no special significance (however, 1634 * value of NULL has no special significance (however,
1635 * note that if you return non-NULL, you can no longer 1635 * note that if you return non-NULL, you can no longer
1636 * rely on the first call to the access handler having 1636 * rely on the first call to the access handler having
1637 * `NULL == *con_cls` on entry;) 1637 * `NULL == *req_cls` on entry;)
1638 * "cls" will be set to the second argument following 1638 * "cls" will be set to the second argument following
1639 * #MHD_OPTION_URI_LOG_CALLBACK. Finally, uri will 1639 * #MHD_OPTION_URI_LOG_CALLBACK. Finally, uri will
1640 * be the 0-terminated URI of the request. 1640 * be the 0-terminated URI of the request.
@@ -2252,10 +2252,10 @@ enum MHD_ConnectionInfoType
2252 /** 2252 /**
2253 * Returns the client-specific pointer to a `void *` that was (possibly) 2253 * Returns the client-specific pointer to a `void *` that was (possibly)
2254 * set during a #MHD_NotifyConnectionCallback when the socket was 2254 * set during a #MHD_NotifyConnectionCallback when the socket was
2255 * first accepted. Note that this is NOT the same as the "con_cls" 2255 * first accepted.
2256 * argument of the #MHD_AccessHandlerCallback. The "con_cls" is 2256 * Note that this is NOT the same as the "req_cls" argument of
2257 * fresh for each HTTP request, while the "socket_context" is fresh 2257 * the #MHD_AccessHandlerCallback. The "req_cls" is fresh for each
2258 * for each socket. 2258 * HTTP request, while the "socket_context" is fresh for each socket.
2259 */ 2259 */
2260 MHD_CONNECTION_INFO_SOCKET_CONTEXT, 2260 MHD_CONNECTION_INFO_SOCKET_CONTEXT,
2261 2261
@@ -2428,7 +2428,7 @@ typedef enum MHD_Result
2428 * @param[in,out] upload_data_size set initially to the size of the 2428 * @param[in,out] upload_data_size set initially to the size of the
2429 * @a upload_data provided; the method must update this 2429 * @a upload_data provided; the method must update this
2430 * value to the number of bytes NOT processed; 2430 * value to the number of bytes NOT processed;
2431 * @param[in,out] con_cls pointer that the callback can set to some 2431 * @param[in,out] req_cls pointer that the callback can set to some
2432 * address and that will be preserved by MHD for future 2432 * address and that will be preserved by MHD for future
2433 * calls for this request; since the access handler may 2433 * calls for this request; since the access handler may
2434 * be called many times (i.e., for a PUT/POST operation 2434 * be called many times (i.e., for a PUT/POST operation
@@ -2437,7 +2437,7 @@ typedef enum MHD_Result
2437 * If necessary, this state can be cleaned up in the 2437 * If necessary, this state can be cleaned up in the
2438 * global #MHD_RequestCompletedCallback (which 2438 * global #MHD_RequestCompletedCallback (which
2439 * can be set with the #MHD_OPTION_NOTIFY_COMPLETED). 2439 * can be set with the #MHD_OPTION_NOTIFY_COMPLETED).
2440 * Initially, `*con_cls` will be NULL. 2440 * Initially, `*req_cls` will be NULL.
2441 * @return #MHD_YES if the connection was handled successfully, 2441 * @return #MHD_YES if the connection was handled successfully,
2442 * #MHD_NO if the socket must be closed due to a serious 2442 * #MHD_NO if the socket must be closed due to a serious
2443 * error while handling the request 2443 * error while handling the request
@@ -2452,7 +2452,7 @@ typedef enum MHD_Result
2452 const char *version, 2452 const char *version,
2453 const char *upload_data, 2453 const char *upload_data,
2454 size_t *upload_data_size, 2454 size_t *upload_data_size,
2455 void **con_cls); 2455 void **req_cls);
2456 2456
2457 2457
2458/** 2458/**
@@ -2461,7 +2461,7 @@ typedef enum MHD_Result
2461 * 2461 *
2462 * @param cls client-defined closure 2462 * @param cls client-defined closure
2463 * @param connection connection handle 2463 * @param connection connection handle
2464 * @param con_cls value as set by the last call to 2464 * @param req_cls value as set by the last call to
2465 * the #MHD_AccessHandlerCallback 2465 * the #MHD_AccessHandlerCallback
2466 * @param toe reason for request termination 2466 * @param toe reason for request termination
2467 * @see #MHD_OPTION_NOTIFY_COMPLETED 2467 * @see #MHD_OPTION_NOTIFY_COMPLETED
@@ -2470,7 +2470,7 @@ typedef enum MHD_Result
2470typedef void 2470typedef void
2471(*MHD_RequestCompletedCallback) (void *cls, 2471(*MHD_RequestCompletedCallback) (void *cls,
2472 struct MHD_Connection *connection, 2472 struct MHD_Connection *connection,
2473 void **con_cls, 2473 void **req_cls,
2474 enum MHD_RequestTerminationCode toe); 2474 enum MHD_RequestTerminationCode toe);
2475 2475
2476 2476
@@ -2483,7 +2483,7 @@ typedef void
2483 * @param socket_context socket-specific pointer where the 2483 * @param socket_context socket-specific pointer where the
2484 * client can associate some state specific 2484 * client can associate some state specific
2485 * to the TCP connection; note that this is 2485 * to the TCP connection; note that this is
2486 * different from the "con_cls" which is per 2486 * different from the "req_cls" which is per
2487 * HTTP request. The client can initialize 2487 * HTTP request. The client can initialize
2488 * during #MHD_CONNECTION_NOTIFY_STARTED and 2488 * during #MHD_CONNECTION_NOTIFY_STARTED and
2489 * cleanup during #MHD_CONNECTION_NOTIFY_CLOSED 2489 * cleanup during #MHD_CONNECTION_NOTIFY_CLOSED
@@ -3790,7 +3790,7 @@ MHD_upgrade_action (struct MHD_UpgradeResponseHandle *urh,
3790 * @param connection original HTTP connection handle, 3790 * @param connection original HTTP connection handle,
3791 * giving the function a last chance 3791 * giving the function a last chance
3792 * to inspect the original HTTP request 3792 * to inspect the original HTTP request
3793 * @param con_cls last value left in `con_cls` of the `MHD_AccessHandlerCallback` 3793 * @param req_cls last value left in `req_cls` of the `MHD_AccessHandlerCallback`
3794 * @param extra_in if we happened to have read bytes after the 3794 * @param extra_in if we happened to have read bytes after the
3795 * HTTP header already (because the client sent 3795 * HTTP header already (because the client sent
3796 * more than the HTTP header of the request before 3796 * more than the HTTP header of the request before
@@ -3815,7 +3815,7 @@ MHD_upgrade_action (struct MHD_UpgradeResponseHandle *urh,
3815typedef void 3815typedef void
3816(*MHD_UpgradeHandler)(void *cls, 3816(*MHD_UpgradeHandler)(void *cls,
3817 struct MHD_Connection *connection, 3817 struct MHD_Connection *connection,
3818 void *con_cls, 3818 void *req_cls,
3819 const char *extra_in, 3819 const char *extra_in,
3820 size_t extra_in_size, 3820 size_t extra_in_size,
3821 MHD_socket sock, 3821 MHD_socket sock,