diff options
author | Christian Grothoff <christian@grothoff.org> | 2012-09-28 11:39:38 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2012-09-28 11:39:38 +0000 |
commit | d1d5bf7cb9e99860fb0e9657b36436ac48690dbb (patch) | |
tree | fb10800c57a379129a1e1387646e4b641e25ae71 /doc | |
parent | 54f9e798f2123d22c284f5ce55524018c8dea098 (diff) | |
download | libmicrohttpd-d1d5bf7cb9e99860fb0e9657b36436ac48690dbb.tar.gz libmicrohttpd-d1d5bf7cb9e99860fb0e9657b36436ac48690dbb.zip |
-introduce MHD_UNSIGNED_LONG_LONG, deprecate MHD_LONG_LONG, check for invalid options on start, document
Diffstat (limited to 'doc')
-rw-r--r-- | doc/examples/sessions.c | 2 | ||||
-rw-r--r-- | doc/libmicrohttpd.texi | 43 |
2 files changed, 32 insertions, 13 deletions
diff --git a/doc/examples/sessions.c b/doc/examples/sessions.c index 5961037a..63abfc27 100644 --- a/doc/examples/sessions.c +++ b/doc/examples/sessions.c | |||
@@ -683,7 +683,7 @@ main (int argc, char *const *argv) | |||
683 | fd_set ws; | 683 | fd_set ws; |
684 | fd_set es; | 684 | fd_set es; |
685 | int max; | 685 | int max; |
686 | unsigned MHD_LONG_LONG mhd_timeout; | 686 | MHD_UNSIGNED_LONG_LONG mhd_timeout; |
687 | 687 | ||
688 | if (argc != 2) | 688 | if (argc != 2) |
689 | { | 689 | { |
diff --git a/doc/libmicrohttpd.texi b/doc/libmicrohttpd.texi index f9b99bea..fed59f3b 100644 --- a/doc/libmicrohttpd.texi +++ b/doc/libmicrohttpd.texi | |||
@@ -262,20 +262,32 @@ ignore_sigpipe () | |||
262 | } | 262 | } |
263 | @end verbatim | 263 | @end verbatim |
264 | 264 | ||
265 | @section MHD_LONG_LONG | 265 | @section MHD_UNSIGNED_LONG_LONG |
266 | @cindex long long | 266 | @cindex long long |
267 | @cindex MHD_LONG_LONG | ||
267 | @cindex IAR | 268 | @cindex IAR |
268 | @cindex ARM | 269 | @cindex ARM |
269 | @cindex cortex m3 | 270 | @cindex cortex m3 |
270 | @cindex embedded systems | 271 | @cindex embedded systems |
271 | 272 | ||
272 | Some platforms do not support @code{long long}. Hence MHD defines | 273 | Some platforms do not support @code{long long}. Hence MHD defines a |
273 | a macro @code{MHD_LONG_LONG} which will default to @code{long long}. | 274 | macro @code{MHD_UNSIGNED LONG_LONG} which will default to |
274 | If your platform does not support @code{long long}, you should | 275 | @code{unsigned long long}. For standard desktop operating systems, |
275 | change "platform.h" to define @code{MHD_LONG_LONG} to an appropriate | 276 | this is all you need to know. |
276 | alternative type and also define @code{MHD_LONG_LONG_PRINTF} to the | 277 | |
277 | corresponding format string for printing such a data type (without | 278 | However, if your platform does not support @code{unsigned long long}, |
278 | the percent sign). | 279 | you should change "platform.h" to define @code{MHD_LONG_LONG} and |
280 | @code{MHD_UNSIGNED_LONG_LONG} to an appropriate alternative type and | ||
281 | also define @code{MHD_LONG_LONG_PRINTF} and | ||
282 | @code{MHD_UNSIGNED_LONG_LONG_PRINTF} to the corresponding format | ||
283 | string for printing such a data type. Note that the ``signed'' | ||
284 | versions are deprecated. Also, for historical reasons, | ||
285 | @code{MHD_LONG_LONG_PRINTF} is without the percent sign, whereas | ||
286 | @code{MHD_UNSIGNED_LONG_LONG_PRINTF} is with the percent sign. Newly | ||
287 | written code should only use the unsigned versions. However, you need | ||
288 | to define both in "platform.h" if you need to change the definition | ||
289 | for the specific platform. | ||
290 | |||
279 | 291 | ||
280 | @c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ | 292 | @c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
281 | 293 | ||
@@ -311,7 +323,11 @@ compiled with messages enabled. This is done by default except you ran | |||
311 | configure with the @code{--disable-messages} flag set. | 323 | configure with the @code{--disable-messages} flag set. |
312 | 324 | ||
313 | @item MHD_USE_SSL | 325 | @item MHD_USE_SSL |
314 | Run in https mode (this option may not work with all threading modes yet). | 326 | @cindex TLS |
327 | @cindex SSL | ||
328 | Run in HTTPS-mode. If you specify @code{MHD_USE_SSL} and MHD was | ||
329 | compiled without SSL support, @code{MHD_start_daemon} will return | ||
330 | NULL. | ||
315 | 331 | ||
316 | @item MHD_USE_THREAD_PER_CONNECTION | 332 | @item MHD_USE_THREAD_PER_CONNECTION |
317 | Run using one thread per connection. | 333 | Run using one thread per connection. |
@@ -322,7 +338,8 @@ Run using an internal thread doing @code{SELECT}. | |||
322 | @item MHD_USE_IPv6 | 338 | @item MHD_USE_IPv6 |
323 | @cindex IPv6 | 339 | @cindex IPv6 |
324 | Run using the IPv6 protocol (otherwise, MHD will just support IPv4). | 340 | Run using the IPv6 protocol (otherwise, MHD will just support IPv4). |
325 | 341 | If you specify @code{MHD_USE_IPV6} and the local platform does not | |
342 | support it, @code{MHD_start_daemon} will return NULL. | ||
326 | 343 | ||
327 | @item MHD_USE_PEDANTIC_CHECKS | 344 | @item MHD_USE_PEDANTIC_CHECKS |
328 | Be pedantic about the protocol (as opposed to as tolerant as possible). | 345 | Be pedantic about the protocol (as opposed to as tolerant as possible). |
@@ -339,7 +356,9 @@ production. | |||
339 | @cindex select | 356 | @cindex select |
340 | Use poll instead of select. This allows sockets with descriptors | 357 | Use poll instead of select. This allows sockets with descriptors |
341 | @code{>= FD_SETSIZE}. This option only works in conjunction with | 358 | @code{>= FD_SETSIZE}. This option only works in conjunction with |
342 | @code{MHD_USE_THREAD_PER_CONNECTION} (at this point). | 359 | @code{MHD_USE_THREAD_PER_CONNECTION} (at this point). If you |
360 | specify @code{MHD_USE_POLL} and the local platform does not support | ||
361 | it, @code{MHD_start_daemon} will return NULL. | ||
343 | 362 | ||
344 | @item MHD_SUPPRESS_DATE_NO_CLOCK | 363 | @item MHD_SUPPRESS_DATE_NO_CLOCK |
345 | @cindex date | 364 | @cindex date |
@@ -581,7 +600,7 @@ Number (unsigned int) of threads in thread pool. Enable | |||
581 | thread pooling by setting this value to to something | 600 | thread pooling by setting this value to to something |
582 | greater than 1. Currently, thread model must be | 601 | greater than 1. Currently, thread model must be |
583 | MHD_USE_SELECT_INTERNALLY if thread pooling is enabled | 602 | MHD_USE_SELECT_INTERNALLY if thread pooling is enabled |
584 | (MHD_start_daemon returns @code{NULL} for an unsupported thread | 603 | (@code{MHD_start_daemon} returns @code{NULL} for an unsupported thread |
585 | model). | 604 | model). |
586 | 605 | ||
587 | @item MHD_OPTION_ARRAY | 606 | @item MHD_OPTION_ARRAY |