diff options
| author | Evgeny Grin (Karlson2k) <k2k@narod.ru> | 2022-04-27 22:24:23 +0300 |
|---|---|---|
| committer | Evgeny Grin (Karlson2k) <k2k@narod.ru> | 2022-04-27 22:24:23 +0300 |
| commit | d14fc3b3d7e4b3a55e85bab2bd2d9895d0543933 (patch) | |
| tree | a6d5a4ad44ddcd05ed8bada40991d8fe7728cb36 /src/include | |
| parent | dc9a8c4180ff361d963fe9bd70ca4ee0e84fcf12 (diff) | |
| download | libmicrohttpd-d14fc3b3d7e4b3a55e85bab2bd2d9895d0543933.tar.gz libmicrohttpd-d14fc3b3d7e4b3a55e85bab2bd2d9895d0543933.zip | |
MHD_get_timeout*(): improved doxy
Diffstat (limited to 'src/include')
| -rw-r--r-- | src/include/microhttpd.h | 23 |
1 files changed, 13 insertions, 10 deletions
diff --git a/src/include/microhttpd.h b/src/include/microhttpd.h index 023a44ad..0563e907 100644 --- a/src/include/microhttpd.h +++ b/src/include/microhttpd.h | |||
| @@ -2902,10 +2902,11 @@ MHD_get_fdset2 (struct MHD_Daemon *daemon, | |||
| 2902 | * return #MHD_YES will break MHD processing logic and result in "hung" | 2902 | * return #MHD_YES will break MHD processing logic and result in "hung" |
| 2903 | * connections with data pending in network buffers and other problems. | 2903 | * connections with data pending in network buffers and other problems. |
| 2904 | * | 2904 | * |
| 2905 | * It is important to always use this function when "external" polling is | 2905 | * It is important to always use this function (or #MHD_get_timeout64(), |
| 2906 | * used. If this function returns #MHD_YES then #MHD_run() (or | 2906 | * #MHD_get_timeout64s() functions) when "external" polling is used. |
| 2907 | * #MHD_run_from_select()) must be called right after return from polling | 2907 | * If this function returns #MHD_YES then #MHD_run() (or #MHD_run_from_select()) |
| 2908 | * function, regardless of the states of MHD fds. | 2908 | * must be called right after return from polling function, regardless of |
| 2909 | * the states of MHD FDs. | ||
| 2909 | * | 2910 | * |
| 2910 | * In practice, if #MHD_YES is returned then #MHD_run() (or | 2911 | * In practice, if #MHD_YES is returned then #MHD_run() (or |
| 2911 | * #MHD_run_from_select()) must be called not later than @a timeout | 2912 | * #MHD_run_from_select()) must be called not later than @a timeout |
| @@ -2937,10 +2938,11 @@ MHD_get_timeout (struct MHD_Daemon *daemon, | |||
| 2937 | * return #MHD_YES will break MHD processing logic and result in "hung" | 2938 | * return #MHD_YES will break MHD processing logic and result in "hung" |
| 2938 | * connections with data pending in network buffers and other problems. | 2939 | * connections with data pending in network buffers and other problems. |
| 2939 | * | 2940 | * |
| 2940 | * It is important to always use this function when "external" polling is | 2941 | * It is important to always use this function (or #MHD_get_timeout(), |
| 2941 | * used. If this function returns #MHD_YES then #MHD_run() (or | 2942 | * #MHD_get_timeout64s() functions) when "external" polling is used. |
| 2942 | * #MHD_run_from_select()) must be called right after return from polling | 2943 | * If this function returns #MHD_YES then #MHD_run() (or #MHD_run_from_select()) |
| 2943 | * function, regardless of the states of MHD fds. | 2944 | * must be called right after return from polling function, regardless of |
| 2945 | * the states of MHD FDs. | ||
| 2944 | * | 2946 | * |
| 2945 | * In practice, if #MHD_YES is returned then #MHD_run() (or | 2947 | * In practice, if #MHD_YES is returned then #MHD_run() (or |
| 2946 | * #MHD_run_from_select()) must be called not later than @a timeout | 2948 | * #MHD_run_from_select()) must be called not later than @a timeout |
| @@ -2975,8 +2977,9 @@ MHD_get_timeout64 (struct MHD_Daemon *daemon, | |||
| 2975 | * processing logic and result in "hung" connections with data pending in | 2977 | * processing logic and result in "hung" connections with data pending in |
| 2976 | * network buffers and other problems. | 2978 | * network buffers and other problems. |
| 2977 | * | 2979 | * |
| 2978 | * It is important to always use this function when "external" polling is | 2980 | * It is important to always use this function (or #MHD_get_timeout(), |
| 2979 | * used. If this function returns non-negative value then #MHD_run() (or | 2981 | * #MHD_get_timeout64() functions) when "external" polling is used. |
| 2982 | * If this function returns non-negative value then #MHD_run() (or | ||
| 2980 | * #MHD_run_from_select()) must be called right after return from polling | 2983 | * #MHD_run_from_select()) must be called right after return from polling |
| 2981 | * function, regardless of the states of MHD FDs. | 2984 | * function, regardless of the states of MHD FDs. |
| 2982 | * | 2985 | * |