diff options
Diffstat (limited to 'src/include/microhttpd.h')
| -rw-r--r-- | src/include/microhttpd.h | 62 |
1 files changed, 42 insertions, 20 deletions
diff --git a/src/include/microhttpd.h b/src/include/microhttpd.h index 621ce705..975611bf 100644 --- a/src/include/microhttpd.h +++ b/src/include/microhttpd.h | |||
| @@ -2,20 +2,19 @@ | |||
| 2 | This file is part of libmicrohttpd | 2 | This file is part of libmicrohttpd |
| 3 | (C) 2006, 2007 Christian Grothoff (and other contributing authors) | 3 | (C) 2006, 2007 Christian Grothoff (and other contributing authors) |
| 4 | 4 | ||
| 5 | libmicrohttpd is free software; you can redistribute it and/or modify | 5 | This library is free software; you can redistribute it and/or |
| 6 | it under the terms of the GNU General Public License as published | 6 | modify it under the terms of the GNU Lesser General Public |
| 7 | by the Free Software Foundation; either version 2, or (at your | 7 | License as published by the Free Software Foundation; either |
| 8 | option) any later version. | 8 | version 2.1 of the License, or (at your option) any later version. |
| 9 | 9 | ||
| 10 | libmicrohttpd is distributed in the hope that it will be useful, but | 10 | This library is distributed in the hope that it will be useful, |
| 11 | WITHOUT ANY WARRANTY; without even the implied warranty of | 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 13 | General Public License for more details. | 13 | Lesser General Public License for more details. |
| 14 | 14 | ||
| 15 | You should have received a copy of the GNU General Public License | 15 | You should have received a copy of the GNU Lesser General Public |
| 16 | along with libmicrohttpd; see the file COPYING. If not, write to the | 16 | License along with this library; if not, write to the Free Software |
| 17 | Free Software Foundation, Inc., 59 Temple Place - Suite 330, | 17 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
| 18 | Boston, MA 02111-1307, USA. | ||
| 19 | */ | 18 | */ |
| 20 | 19 | ||
| 21 | /** | 20 | /** |
| @@ -24,20 +23,43 @@ | |||
| 24 | * @author Christian Grothoff | 23 | * @author Christian Grothoff |
| 25 | * @author Chris GauthierDickey | 24 | * @author Chris GauthierDickey |
| 26 | * | 25 | * |
| 27 | * All symbols defined in this header start with MHD. MHD is a | 26 | * All symbols defined in this header start with MHD. MHD is a small |
| 28 | * micro-httpd library. As such, it does not have any API for logging | 27 | * HTTP daemon library. As such, it does not have any API for logging |
| 29 | * errors. Also, it may not support all of the HTTP features directly, | 28 | * errors (you can only enable or disable logging to stderr). Also, |
| 30 | * where applicable, portions of HTTP may have to be handled by | 29 | * it may not support all of the HTTP features directly, where |
| 31 | * clients of the library (the library is supposed to handle | 30 | * applicable, portions of HTTP may have to be handled by clients of |
| 32 | * everything that it must handle, such as basic connection | 31 | * the library.<p> |
| 33 | * management; however, detailed interpretations of headers | 32 | * |
| 34 | * and methods are left to clients).<p> | 33 | * The library is supposed to handle everything that it must handle |
| 34 | * (because the API would not allow clients to do this), such as basic | ||
| 35 | * connection management; however, detailed interpretations of headers | ||
| 36 | * -- such as range requests -- and HTTP methods are left to clients. | ||
| 37 | * The library does understand HEAD and will only send the headers of | ||
| 38 | * the response and not the body, even if the client supplied a body. | ||
| 39 | * The library also understands headers that control connection | ||
| 40 | * management (specifically, "Connection: close" and "Expect: 100 | ||
| 41 | * continue" are understood and handled automatically).<p> | ||
| 42 | * | ||
| 43 | * MHD understands POST data and is able to decode certain formats | ||
| 44 | * (at the moment only "application/x-www-form-urlencoded") if the | ||
| 45 | * entire data fits into the allowed amount of memory for the | ||
| 46 | * connection. Unsupported encodings and large POST submissions are | ||
| 47 | * provided as a stream to the main application (and thus can be | ||
| 48 | * processed, just not conveniently by MHD).<p> | ||
| 49 | * | ||
| 50 | * The header file defines various constants used by the HTTP protocol. | ||
| 51 | * This does not mean that MHD actually interprets all of these | ||
| 52 | * values. The provided constants are exported as a convenience | ||
| 53 | * for users of the library. MHD does not verify that transmitted | ||
| 54 | * HTTP headers are part of the standard specification; users of the | ||
| 55 | * library are free to define their own extensions of the HTTP | ||
| 56 | * standard and use those with MHD.<p> | ||
| 35 | * | 57 | * |
| 36 | * All functions are guaranteed to be completely reentrant and | 58 | * All functions are guaranteed to be completely reentrant and |
| 37 | * thread-safe.<p> | 59 | * thread-safe.<p> |
| 38 | * | 60 | * |
| 39 | * TODO: | 61 | * TODO: |
| 40 | * - Add option codes for buffer sizes and SSL support | 62 | * - Add option codes for SSL support |
| 41 | */ | 63 | */ |
| 42 | 64 | ||
| 43 | #ifndef MHD_MICROHTTPD_H | 65 | #ifndef MHD_MICROHTTPD_H |