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.h41
1 files changed, 26 insertions, 15 deletions
diff --git a/src/include/microhttpd.h b/src/include/microhttpd.h
index a09cddf3..40545452 100644
--- a/src/include/microhttpd.h
+++ b/src/include/microhttpd.h
@@ -2178,8 +2178,13 @@ MHD_add_connection (struct MHD_Daemon *daemon,
2178 * before calling this function. FD_SETSIZE is assumed 2178 * before calling this function. FD_SETSIZE is assumed
2179 * to be platform's default. 2179 * to be platform's default.
2180 * 2180 *
2181 * This function could be called only for daemon started 2181 * This function should only be called in when MHD is configured to
2182 * without MHD_USE_INTERNAL_POLLING_THREAD flag. 2182 * use external select with @code{select()} or with @code{epoll()}.
2183 * In the latter case, it will only add the single @code{epoll()} file
2184 * descriptor used by MHD to the sets.
2185 *
2186 * This function must be called only for daemon started
2187 * without #MHD_USE_INTERNAL_POLLING_THREAD flag.
2183 * 2188 *
2184 * @param daemon daemon to get sets from 2189 * @param daemon daemon to get sets from
2185 * @param read_fd_set read set 2190 * @param read_fd_set read set
@@ -2205,12 +2210,18 @@ MHD_get_fdset (struct MHD_Daemon *daemon,
2205 * Obtain the `select()` sets for this daemon. 2210 * Obtain the `select()` sets for this daemon.
2206 * Daemon's FDs will be added to fd_sets. To get only 2211 * Daemon's FDs will be added to fd_sets. To get only
2207 * daemon FDs in fd_sets, call FD_ZERO for each fd_set 2212 * daemon FDs in fd_sets, call FD_ZERO for each fd_set
2208 * before calling this function. Passing custom FD_SETSIZE 2213 * before calling this function.
2209 * as @a fd_setsize allow usage of larger/smaller than
2210 * platform's default fd_sets.
2211 * 2214 *
2212 * This function could be called only for daemon started 2215 * Passing custom FD_SETSIZE as @a fd_setsize allow usage of
2213 * without MHD_USE_INTERNAL_POLLING_THREAD flag. 2216 * larger/smaller than platform's default fd_sets.
2217 *
2218 * This function should only be called in when MHD is configured to
2219 * use external select with @code{select()} or with @code{epoll()}.
2220 * In the latter case, it will only add the single @code{epoll()} file
2221 * descriptor used by MHD to the sets.
2222 *
2223 * This function must be called only for daemon started
2224 * without #MHD_USE_INTERNAL_POLLING_THREAD flag.
2214 * 2225 *
2215 * @param daemon daemon to get sets from 2226 * @param daemon daemon to get sets from
2216 * @param read_fd_set read set 2227 * @param read_fd_set read set
@@ -2227,11 +2238,11 @@ MHD_get_fdset (struct MHD_Daemon *daemon,
2227 */ 2238 */
2228_MHD_EXTERN int 2239_MHD_EXTERN int
2229MHD_get_fdset2 (struct MHD_Daemon *daemon, 2240MHD_get_fdset2 (struct MHD_Daemon *daemon,
2230 fd_set *read_fd_set, 2241 fd_set *read_fd_set,
2231 fd_set *write_fd_set, 2242 fd_set *write_fd_set,
2232 fd_set *except_fd_set, 2243 fd_set *except_fd_set,
2233 MHD_socket *max_fd, 2244 MHD_socket *max_fd,
2234 unsigned int fd_setsize); 2245 unsigned int fd_setsize);
2235 2246
2236 2247
2237/** 2248/**
@@ -2242,7 +2253,7 @@ MHD_get_fdset2 (struct MHD_Daemon *daemon,
2242 * determined by current value of FD_SETSIZE. 2253 * determined by current value of FD_SETSIZE.
2243 * 2254 *
2244 * This function could be called only for daemon started 2255 * This function could be called only for daemon started
2245 * without MHD_USE_INTERNAL_POLLING_THREAD flag. 2256 * without #MHD_USE_INTERNAL_POLLING_THREAD flag.
2246 * 2257 *
2247 * @param daemon daemon to get sets from 2258 * @param daemon daemon to get sets from
2248 * @param read_fd_set read set 2259 * @param read_fd_set read set
@@ -2288,7 +2299,7 @@ MHD_get_timeout (struct MHD_Daemon *daemon,
2288 * fd_sets from #MHD_get_fdset were not directly passed to `select()`; 2299 * fd_sets from #MHD_get_fdset were not directly passed to `select()`;
2289 * with this function, MHD will internally do the appropriate `select()` 2300 * with this function, MHD will internally do the appropriate `select()`
2290 * call itself again. While it is always safe to call #MHD_run (if 2301 * call itself again. While it is always safe to call #MHD_run (if
2291 * ::MHD_USE_INTERNAL_POLLING_THREAD is not set), you should call 2302 * #MHD_USE_INTERNAL_POLLING_THREAD is not set), you should call
2292 * #MHD_run_from_select if performance is important (as it saves an 2303 * #MHD_run_from_select if performance is important (as it saves an
2293 * expensive call to `select()`). 2304 * expensive call to `select()`).
2294 * 2305 *
@@ -2315,7 +2326,7 @@ MHD_run (struct MHD_Daemon *daemon);
2315 * ready. 2326 * ready.
2316 * 2327 *
2317 * This function cannot be used with daemon started with 2328 * This function cannot be used with daemon started with
2318 * MHD_USE_INTERNAL_POLLING_THREAD flag. 2329 * #MHD_USE_INTERNAL_POLLING_THREAD flag.
2319 * 2330 *
2320 * @param daemon daemon to run select loop for 2331 * @param daemon daemon to run select loop for
2321 * @param read_fd_set read set 2332 * @param read_fd_set read set