diff options
author | Evgeny Grin (Karlson2k) <k2k@narod.ru> | 2016-08-24 15:02:16 +0000 |
---|---|---|
committer | Evgeny Grin (Karlson2k) <k2k@narod.ru> | 2016-08-24 15:02:16 +0000 |
commit | cd030ca9cae26ecc21a916fb8e51a26bf3a7f9c4 (patch) | |
tree | 1cf810bc2e7c8167fc6b1acf709c84ed18617e87 /doc | |
parent | 9826ad54e0de815ca9a2b071717dc8aed1ce1a5c (diff) | |
download | libmicrohttpd-cd030ca9cae26ecc21a916fb8e51a26bf3a7f9c4.tar.gz libmicrohttpd-cd030ca9cae26ecc21a916fb8e51a26bf3a7f9c4.zip |
epoll is now supported on non-Linux platforms (namely illumos).
Renamed MHD options and updated documentation.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/libmicrohttpd.texi | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/doc/libmicrohttpd.texi b/doc/libmicrohttpd.texi index 49a74b4c..b95e27b8 100644 --- a/doc/libmicrohttpd.texi +++ b/doc/libmicrohttpd.texi | |||
@@ -168,9 +168,9 @@ thread-per-connection (MHD creates one listen thread and then one | |||
168 | thread per accepted connection). | 168 | thread per accepted connection). |
169 | 169 | ||
170 | These thread modes are then combined with the event loop styles. | 170 | These thread modes are then combined with the event loop styles. |
171 | MHD support select, poll and epoll. epoll is only available on | 171 | MHD support select, poll and epoll. select is available on all |
172 | Linux, poll may not be available on some platforms. Note that | 172 | platforms, epoll and poll may not be available on some platforms. |
173 | it is possible to combine MHD using epoll with an external | 173 | Note that it is possible to combine MHD using epoll with an external |
174 | select-based event loop. | 174 | select-based event loop. |
175 | 175 | ||
176 | The default (if no other option is passed) is ``external select''. | 176 | The default (if no other option is passed) is ``external select''. |
@@ -203,8 +203,8 @@ request within the callbacks from MHD must use a thread per | |||
203 | connection. This is typically rather costly. Applications that do | 203 | connection. This is typically rather costly. Applications that do |
204 | not support threads or that must run on embedded devices without | 204 | not support threads or that must run on embedded devices without |
205 | thread-support must use the external mode. Using @code{epoll} is only | 205 | thread-support must use the external mode. Using @code{epoll} is only |
206 | supported on Linux, thus portable applications must at least have a | 206 | supported on some platform, thus portable applications must at least |
207 | fallback option available. @ref{tbl:supported} lists the sane | 207 | have a fallback option available. @ref{tbl:supported} lists the sane |
208 | combinations. | 208 | combinations. |
209 | 209 | ||
210 | @float Table,tbl:supported | 210 | @float Table,tbl:supported |
@@ -265,7 +265,7 @@ do not include the post processor API (results in binary incompatibility) | |||
265 | do not include the authentication APIs (results in binary incompatibility) | 265 | do not include the authentication APIs (results in binary incompatibility) |
266 | 266 | ||
267 | @item ``--disable-epoll | 267 | @item ``--disable-epoll |
268 | do not include epoll support, even on Linux (minimally smaller binary size, good for testing portability to non-Linux systems) | 268 | do not include epoll support, even if it supported (minimally smaller binary size, good for portability testing) |
269 | 269 | ||
270 | @item ``--enable-coverage'' | 270 | @item ``--enable-coverage'' |
271 | set flags for analysis of code-coverage with gcc/gcov (results in slow, large binaries) | 271 | set flags for analysis of code-coverage with gcc/gcov (results in slow, large binaries) |
@@ -504,15 +504,15 @@ conjunction with @code{MHD_USE_THREAD_PER_CONNECTION} or | |||
504 | @code{MHD_USE_POLL} and the local platform does not support it, | 504 | @code{MHD_USE_POLL} and the local platform does not support it, |
505 | @code{MHD_start_daemon} will return NULL. | 505 | @code{MHD_start_daemon} will return NULL. |
506 | 506 | ||
507 | @item MHD_USE_EPOLL_LINUX_ONLY | 507 | @item MHD_USE_EPOLL |
508 | @cindex FD_SETSIZE | 508 | @cindex FD_SETSIZE |
509 | @cindex epoll | 509 | @cindex epoll |
510 | @cindex select | 510 | @cindex select |
511 | Use @code{epoll()} instead of @code{poll()} or @code{select()}. This | 511 | Use @code{epoll()} instead of @code{poll()} or @code{select()}. This |
512 | allows sockets with descriptors @code{>= FD_SETSIZE}. This option is | 512 | allows sockets with descriptors @code{>= FD_SETSIZE}. This option is |
513 | only available on Linux systems and does not work in conjunction with | 513 | only available on some systems and does not work in conjunction with |
514 | @code{MHD_USE_THREAD_PER_CONNECTION} (at this point). If you specify | 514 | @code{MHD_USE_THREAD_PER_CONNECTION} (at this point). If you specify |
515 | @code{MHD_USE_EPOLL_LINUX_ONLY} and the local platform does not | 515 | @code{MHD_USE_EPOLL} and the local platform does not |
516 | support it, @code{MHD_start_daemon} will return NULL. Using | 516 | support it, @code{MHD_start_daemon} will return NULL. Using |
517 | @code{epoll()} instead of @code{select()} or @code{poll()} can in some | 517 | @code{epoll()} instead of @code{select()} or @code{poll()} can in some |
518 | situations result in significantly higher performance as the system | 518 | situations result in significantly higher performance as the system |
@@ -524,7 +524,7 @@ open connections). | |||
524 | @cindex performance | 524 | @cindex performance |
525 | Enable optimizations to aggressively improve performance. Note that | 525 | Enable optimizations to aggressively improve performance. Note that |
526 | the option is a slight misnomer, as these days it also enables optimziations | 526 | the option is a slight misnomer, as these days it also enables optimziations |
527 | that are unrelated to @code{MHD_USE_EPOLL_LINUX_ONLY}. Hence it is OK to | 527 | that are unrelated to @code{MHD_USE_EPOLL}. Hence it is OK to |
528 | use this option with other event loops. | 528 | use this option with other event loops. |
529 | 529 | ||
530 | Currently, the optimizations this option enables are based on | 530 | Currently, the optimizations this option enables are based on |
@@ -2550,7 +2550,7 @@ No extra arguments should be passed. | |||
2550 | Request the file-descriptor number that MHD is using for epoll. If | 2550 | Request the file-descriptor number that MHD is using for epoll. If |
2551 | the build is not supporting epoll, NULL is returned; if we are using a | 2551 | the build is not supporting epoll, NULL is returned; if we are using a |
2552 | thread pool or this daemon was not started with | 2552 | thread pool or this daemon was not started with |
2553 | @code{MHD_USE_EPOLL_LINUX_ONLY}, (a pointer to) -1 is returned. If we are | 2553 | @code{MHD_USE_EPOLL}, (a pointer to) -1 is returned. If we are |
2554 | using @code{MHD_USE_SELECT_INTERNALLY} or are in 'external' select mode, the | 2554 | using @code{MHD_USE_SELECT_INTERNALLY} or are in 'external' select mode, the |
2555 | internal epoll FD is returned. This function must be used in external | 2555 | internal epoll FD is returned. This function must be used in external |
2556 | select mode with epoll to obtain the FD to call epoll on. No extra | 2556 | select mode with epoll to obtain the FD to call epoll on. No extra |
@@ -2763,8 +2763,8 @@ MHD_USE_POLL can be used. | |||
2763 | 2763 | ||
2764 | @item MHD_FEATURE_EPOLL | 2764 | @item MHD_FEATURE_EPOLL |
2765 | Get whether @code{epoll()} is supported. If supported then Flags | 2765 | Get whether @code{epoll()} is supported. If supported then Flags |
2766 | MHD_USE_EPOLL_LINUX_ONLY and | 2766 | MHD_USE_EPOLL and |
2767 | MHD_USE_EPOLL_INTERNALLY_LINUX_ONLY can be used. | 2767 | MHD_USE_EPOLL_INTERNALLY can be used. |
2768 | 2768 | ||
2769 | @item MHD_FEATURE_SHUTDOWN_LISTEN_SOCKET | 2769 | @item MHD_FEATURE_SHUTDOWN_LISTEN_SOCKET |
2770 | Get whether shutdown on listen socket to signal other | 2770 | Get whether shutdown on listen socket to signal other |