diff options
author | Christian Grothoff <christian@grothoff.org> | 2008-03-30 04:36:05 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2008-03-30 04:36:05 +0000 |
commit | a69c23c79d5385a1c5c6da1587db1c8bcc6ba975 (patch) | |
tree | 2e442244150280b6c11910ce959286b0796b040c | |
parent | a7ea20473a18f5a88028c7245e8e4eaad5982a5a (diff) |
updating docs
-rw-r--r-- | doc/Makefile.am | 6 | ||||
-rw-r--r-- | doc/lgpl.texi | 561 | ||||
-rw-r--r-- | doc/microhttpd.texi | 505 |
3 files changed, 773 insertions, 299 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index b0e78e11..2d8f5578 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,7 +1,7 @@ man_MANS = libmicrohttpd.3 EXTRA_DIST = $(man_MANS) -#DISTCLEANFILES = microhttpd.cps -#info_TEXINFOS = microhttpd.texi -#microhttpd_TEXINFOS = gpl.texi +DISTCLEANFILES = microhttpd.cps +info_TEXINFOS = microhttpd.texi +microhttpd_TEXINFOS = lgpl.texi diff --git a/doc/lgpl.texi b/doc/lgpl.texi new file mode 100644 index 00000000..260c0ce0 --- /dev/null +++ b/doc/lgpl.texi @@ -0,0 +1,561 @@ +@c The GNU Lesser General Public License. +@center Version 2.1, February 1999 + +@c This file is intended to be included within another document, +@c hence no sectioning command or @node. + +@display +Copyright @copyright{} 1991, 1999 Free Software Foundation, Inc. +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts +as the successor of the GNU Library Public License, version 2, hence the +version number 2.1.] +@end display + +@subheading Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software---to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software---typically libraries---of the Free +Software Foundation and other authors who decide to use it. You can use +it too, but we suggest you first think carefully about whether this +license or the ordinary General Public License is the better strategy to +use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of it +in new free programs; and that you are informed that you can do these +things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the @dfn{Lesser} General Public License because it +does @emph{Less} to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +``work based on the library'' and a ``work that uses the library''. The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + +@subheading TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +@enumerate 0 +@item +This License Agreement applies to any software library or other program +which contains a notice placed by the copyright holder or other +authorized party saying it may be distributed under the terms of this +Lesser General Public License (also called ``this License''). Each +licensee is addressed as ``you''. + + A ``library'' means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The ``Library'', below, refers to any such software library or work +which has been distributed under these terms. A ``work based on the +Library'' means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term ``modification''.) + + ``Source code'' for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + +@item +You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + +@item +You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + +@enumerate a +@item +The modified work must itself be a software library. + +@item +You must cause the files modified to carry prominent notices +stating that you changed the files and the date of any change. + +@item +You must cause the whole of the work to be licensed at no +charge to all third parties under the terms of this License. + +@item +If a facility in the modified Library refers to a function or a +table of data to be supplied by an application program that uses +the facility, other than as an argument passed when the facility +is invoked, then you must make a good faith effort to ensure that, +in the event an application does not supply such function or +table, the facility still operates, and performs whatever part of +its purpose remains meaningful. + +(For example, a function in a library to compute square roots has +a purpose that is entirely well-defined independent of the +application. Therefore, Subsection 2d requires that any +application-supplied function or table used by this function must +be optional: if the application does not supply it, the square +root function must still compute square roots.) +@end enumerate + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + +@item +You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + +@item +You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + +@item +A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a ``work that uses the Library''. Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a ``work that uses the Library'' with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a ``work that uses the +library''. The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a ``work that uses the Library'' uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + +@item +As an exception to the Sections above, you may also combine or +link a ``work that uses the Library'' with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + +@enumerate a +@item +Accompany the work with the complete corresponding +machine-readable source code for the Library including whatever +changes were used in the work (which must be distributed under +Sections 1 and 2 above); and, if the work is an executable linked +with the Library, with the complete machine-readable ``work that +uses the Library'', as object code and/or source code, so that the +user can modify the Library and then relink to produce a modified +executable containing the modified Library. (It is understood +that the user who changes the contents of definitions files in the +Library will not necessarily be able to recompile the application +to use the modified definitions.) + +@item +Use a suitable shared library mechanism for linking with the Library. A +suitable mechanism is one that (1) uses at run time a copy of the +library already present on the user's computer system, rather than +copying library functions into the executable, and (2) will operate +properly with a modified version of the library, if the user installs +one, as long as the modified version is interface-compatible with the +version that the work was made with. + +@item +Accompany the work with a written offer, valid for at +least three years, to give the same user the materials +specified in Subsection 6a, above, for a charge no more +than the cost of performing this distribution. + +@item +If distribution of the work is made by offering access to copy +from a designated place, offer equivalent access to copy the above +specified materials from the same place. + +@item +Verify that the user has already received a copy of these +materials or that you have already sent this user a copy. +@end enumerate + + For an executable, the required form of the ``work that uses the +Library'' must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies the +executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + +@item +You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + +@enumerate a +@item +Accompany the combined library with a copy of the same work +based on the Library, uncombined with any other library +facilities. This must be distributed under the terms of the +Sections above. + +@item +Give prominent notice with the combined library of the fact +that part of it is a work based on the Library, and explaining +where to find the accompanying uncombined form of the same work. +@end enumerate + +@item +You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + +@item +You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + +@item +Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + +@item +If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + +@item +If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + +@item +The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +``any later version'', you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + +@item +If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + +@iftex +@heading NO WARRANTY +@end iftex +@ifinfo +@center NO WARRANTY + +@end ifinfo + +@item +BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY ``AS IS'' WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +@item +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. +@end enumerate + +@iftex +@heading END OF TERMS AND CONDITIONS +@end iftex +@ifinfo +@center END OF TERMS AND CONDITIONS + +@end ifinfo + +@page +@subheading How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +``copyright'' line and a pointer to where the full notice is found. + +@smallexample +@var{one line to give the library's name and an idea of what it does.} +Copyright (C) @var{year} @var{name of author} + +This library is free software; you can redistribute it and/or modify it +under the terms of the GNU Lesser General Public License as published by +the Free Software Foundation; either version 2.1 of the License, or (at +your option) any later version. + +This library is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +Lesser General Public License for more details. + +You should have received a copy of the GNU Lesser General Public +License along with this library; if not, write to the Free Software +Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, +USA. +@end smallexample + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a ``copyright disclaimer'' for the library, if +necessary. Here is a sample; alter the names: + +@smallexample +Yoyodyne, Inc., hereby disclaims all copyright interest in the library +`Frob' (a library for tweaking knobs) written by James Random Hacker. + +@var{signature of Ty Coon}, 1 April 1990 +Ty Coon, President of Vice +@end smallexample + +That's all there is to it! diff --git a/doc/microhttpd.texi b/doc/microhttpd.texi index 8d061179..4e0ad512 100644 --- a/doc/microhttpd.texi +++ b/doc/microhttpd.texi @@ -1,4 +1,48 @@ +\input texinfo @setfilename microhttpd.info +@include version.texi +@settitle The libmicrohttpd Reference Manual +@c Unify some of the indices. +@c %**end of header +@copying +This manual documents libmicrohttpd version @value{VERSION}, last +updated @value{UPDATED}. It is built upon the documentation in the +header file @file{microhttpd.h}. + +@noindent + +Copyright @copyright{} 2007, 2008 Christian Grothoff + +@quotation +FIXME: add license terms here! +@end quotation +@end copying + +@dircategory GNU Libraries +@direntry +* libmicrohttpd: (microhttpd). Embedded HTTP server library. +@end direntry + +@c +@c Titlepage +@c +@setchapternewpage odd +@titlepage +@title The libmicrohttpd Reference Manual +@subtitle Version @value{VERSION} +@subtitle @value{UPDATED} +@author Marco Maggi (@email{marco.maggi-ipsu@@poste.it}) +@author Christian Grothoff (@email{christian@@grothoff.org}) + +@page +@vskip 0pt plus 1filll +@insertcopying +@end titlepage + +@summarycontents +@contents +@page + @macro gnu{} @acronym{GNU} @@ -34,14 +78,18 @@ @c ............................................................ -@macro cfunction{NAME} -@code{\NAME\()} +@macro cfunction{arg} +@code{\arg\()} @end macro -@macro null{} +@macro mynull{} @code{NULL} @end macro +@macro mhd{} +@acronym{MHD} +@end macro + @c ............................................................ @macro glibcref{NODE, NODE} @@ -52,36 +100,40 @@ @c ------------------------------------------------------------ -@node microhttpd -@appendix Libmicrohttpd documentation - - -@macro mhd{} -@acronym{MHD} -@end macro - - -@noindent -This appendix documents Libmicrohttpd version 0.1.2. It is built upon -the documentation in the header file @file{microhttpd.h}. +@ifnottex +@node Top +@top The libmicrohttpd Library +@insertcopying +@end ifnottex @menu -* microhttpd intro:: Introduction. -* microhttpd const:: Constants. -* microhttpd struct:: Structures type definition. -* microhttpd cb:: Callback functions definition. -* microhttpd init:: Starting and stopping the server. -* microhttpd inspect:: Inspection. -* microhttpd requests:: Handling requests. -* microhttpd responses:: Building responses to requests. -* microhttpd post:: Adding a @code{POST} processor. +* microhttpd-intro:: Introduction. +* microhttpd-const:: Constants. +* microhttpd-struct:: Structures type definition. +* microhttpd-cb:: Callback functions definition. +* microhttpd-init:: Starting and stopping the server. +* microhttpd-inspect:: Implementing external @code{select}. +* microhttpd-requests:: Handling requests. +* microhttpd-responses:: Building responses to requests. +* microhttpd-post:: Adding a @code{POST} processor. + +Appendices + +* Copying:: The GNU Lesser General Public License says how you + can copy and share some parts of `libmicrohttpd'. + +Indices + +* Concept Index:: Index of concepts and programs. +* Function and Data Index:: Index of functions, variables and data types. +* Type Index:: Index of data types. @end menu @c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ @c ------------------------------------------------------------ -@node microhttpd intro -@appendixsec Introduction +@node microhttpd-intro +@chapter Introduction @noindent @@ -103,11 +155,11 @@ library also understands headers that control connection management are understood and handled automatically). @mhd{} understands @code{POST} data and is able to decode certain -formats (at the moment only @code{application/x-www-form-urlencoded}) if -the entire data fits into the allowed amount of memory for the -connection. Unsupported encodings and large @code{POST} submissions are -provided as a stream to the main application (and thus can be processed, -just not conveniently by @mhd{}). +formats (at the moment only @code{application/x-www-form-urlencoded} +and @code{multipart/form-data}) using the post processor API. The +data stream of a POST is also provided directly to the main +application, so unsupported encodings could still be processed, just +not conveniently by @mhd{}. The header file defines various constants used by the @http{} protocol. This does not mean that @mhd{} actually interprets all of these values. @@ -118,15 +170,19 @@ define their own extensions of the @http{} standard and use those with @mhd{}. All functions are guaranteed to be completely reentrant and -thread-safe. +thread-safe. @mhd{} checks for allocation failures and tries to +recover gracefully (for example, by closing the connection). +Additionally, clients can specify resource limits on the overall +number of connections, number of connections per IP address and memory +used per connection to avoid resource exhaustion. @c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ @c ------------------------------------------------------------ -@node microhttpd const -@appendixsec Constants +@node microhttpd-const +@chapter Constants @deftp {Enumeration} MHD_FLAG @@ -146,10 +202,12 @@ No options selected. @item MHD_USE_DEBUG Run in debug mode. If this flag is used, the library should print error -messages and warnings to stderr. +messages and warnings to stderr. Note that @mhd{} also needs to be +compiled with the configure option @code{--enable-messages} for this +run-time option to have any effect. @item MHD_USE_SSL -Run in https mode. +Run in https mode (this is not yet supported). @item MHD_USE_THREAD_PER_CONNECTION Run using one thread per connection. @@ -204,7 +262,21 @@ notifications. This option should be followed by @strong{TWO} pointers. First a pointer to a function of type @cfunction{MHD_RequestCompletedCallback} and second a pointer to a closure to pass to the request completed -callback. The second pointer maybe @null{}. +callback. The second pointer maybe @mynull{}. + + +@item MHD_OPTION_PER_IP_CONNECTION_LIMIT +Limit on the number of (concurrent) connections made to the +server from the same IP address. Can be used to prevent one +IP from taking over all of the allowed connections. If the +same IP tries to establish more than the specified number of +connections, they will be immediately rejected. The option +should be followed by an @code{unsigned int}. The default is +zero, which means no limit on the number of connections +from the same IP address. + + + @end table @end deftp @@ -234,6 +306,10 @@ already been processed). @item MHD_GET_ARGUMENT_KIND @code{GET} (@uri{}) arguments. + +@item MHD_HEADER_KIND +@http{} footer (only for http 1.1 chunked encodings). + @end table @end deftp @@ -263,8 +339,8 @@ We had to close the session since @mhd{} was being shut down. @c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ @c ------------------------------------------------------------ -@node microhttpd struct -@appendixsec Structures type definition +@node microhttpd-struct +@chapter Structures type definition @deftp {C Struct} MHD_Daemon @@ -292,8 +368,8 @@ Handle for @code{POST} processing. @c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ @c ------------------------------------------------------------ -@node microhttpd cb -@appendixsec Callback functions definition +@node microhttpd-cb +@chapter Callback functions definition @deftypefn {Function Pointer} int {*MHD_AcceptPolicyCallback} (void *cls, const struct sockaddr * addr, socklen_t addrlen) @@ -319,7 +395,7 @@ client. This callback must call @mhd{} functions (example: the and return an @http{} status code (i.e. @code{200} for OK, @code{404}, etc.). -@ref{microhttpd post}, for details on how to code this callback. +@ref{microhttpd-post}, for details on how to code this callback. Must return @code{MHD_YES} if the connection was handled successfully, @code{MHD_NO} if the socket must be closed due to a serious error while @@ -360,7 +436,7 @@ callback must update this value to the number of bytes @strong{NOT} processed; @item con_cls -reference to a pointer, initially set to @null{}, that this callback can +reference to a pointer, initially set to @mynull{}, that this callback can set to some address and that will be preserved by @mhd{} for future calls for this request; @@ -459,13 +535,13 @@ type of the value; zero-terminated key for the value; @item filename -name of the uploaded file, @null{} if not known; +name of the uploaded file, @mynull{} if not known; @item content_type -mime-type of the data, @null{} if not known; +mime-type of the data, @mynull{} if not known; @item transfer_encoding -encoding of the data, @null{} if not known; +encoding of the data, @mynull{} if not known; @item data pointer to size bytes of data at the specified offset; @@ -485,8 +561,8 @@ iteration. @c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ @c ------------------------------------------------------------ -@node microhttpd init -@appendixsec Starting and stopping the server +@node microhttpd-init +@chapter Starting and stopping the server @deftypefun {struct MHD_Daemon *} MHD_start_daemon (unsigned int flags, unsigned short port, MHD_AcceptPolicyCallback apc, void *apc_cls, MHD_AccessHandlerCallback dh, void *dh_cls, ...) @@ -501,7 +577,7 @@ port to bind to; @item apc callback to call to check which clients will be allowed to connect; you -can pass @null{} in which case connections from any @acronym{IP} will be +can pass @mynull{} in which case connections from any @acronym{IP} will be accepted; @item apc_cls @@ -519,7 +595,7 @@ terminated with @code{MHD_OPTION_END}). It is mandatory to use @code{MHD_OPTION_END} as last argument, even when there are no additional arguments. -Return @null{} on error, handle to daemon on success. +Return @mynull{} on error, handle to daemon on success. @end deftypefun @@ -542,8 +618,8 @@ started with the right options for this call. @c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ @c ----------------------------------------------------------- -@node microhttpd inspect -@appendixsec Inspection +@node microhttpd-inspect +@chapter Implementing external @code{select} @deftypefun int MHD_get_fdset (struct MHD_Daemon *daemon, fd_set * read_fd_set, fd_set * write_fd_set, fd_set * except_fd_set, int *max_fd) @@ -560,7 +636,7 @@ identifier. The variable must be set to zero before invoking this function. Return @code{MHD_YES} on success, @code{MHD_NO} if: the arguments are -invalid (example: @null{} pointers); this daemon was not started with +invalid (example: @mynull{} pointers); this daemon was not started with the right options for this call. @end deftypefun @@ -585,71 +661,8 @@ right now). @c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ @c ----------------------------------------------------------- -@node microhttpd requests -@appendixsec Handling requests - - -@menu -* microhttpd handlers:: @uri{} specific handlers. -* microhttpd values:: Connection headers and small - @code{POST} data. -@end menu - - -@c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ - -@c ------------------------------------------------------------ -@node microhttpd handlers -@appendixsubsec @uri{} specific handlers - - -@noindent -A set of callbacks can be registered in the state of a daemon -(@code{MHD_Daemon}) to handle request for specific sets of -resources. The set is selected by specifying the prefix string of the -@uri{}, example: - -@example -/bookcase -@end example - -@noindent -matches all of the following: - -@example -/bookcase/book.html -/bookcase/pencil.html -/bookcase/strawberry.html -@end example - -Handlers are stored in a linked list (managed with @cfunction{malloc} -and @cfunction{free}). Prefixes are compared with @cfunction{strcmp}. - - -@deftypefun int MHD_register_handler (struct MHD_Daemon *daemon, const char *uri_prefix, MHD_AccessHandlerCallback dh, void *dh_cls) -Register an access handler for all @uri{}s beginning with -@var{uri_prefix}, a zero-terminated @ascii{}-coded string. - -Return @code{MRI_NO} if: the arguments are invalid (example: @null{} -pointers); a handler for this exact prefix already exists; an error -allocating memory happens. -@end deftypefun - - -@deftypefun int MHD_unregister_handler (struct MHD_Daemon *daemon, const char *uri_prefix, MHD_AccessHandlerCallback dh, void *dh_cls) -Unregister an access handler for the @uri{}s beginning with -@var{uri_prefix}. - -Return @code{MHD_NO} if: the arguments are invalid (example: @null{} -pointers); a handler for this exact prefix is not known for this daemon. -@end deftypefun - - -@c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ - -@c ------------------------------------------------------------ -@node microhttpd values -@appendixsubsec Connection headers and small @code{POST} data +@node microhttpd-requests +@chapter Handling requests @deftypefun int MHD_get_connection_values (struct MHD_Connection *connection, enum MHD_ValueKind kind, MHD_KeyValueIterator iterator, void *iterator_cls) @@ -660,7 +673,7 @@ The @var{iterator} callback is invoked once for each header, with iterated over; this can be less than the number of headers if, while iterating, @var{iterator} returns @code{MHD_NO}. -@var{iterator} can be @null{}: in this case this function just counts +@var{iterator} can be @mynull{}: in this case this function just counts and returns the number of headers. @end deftypefun @@ -670,7 +683,7 @@ Get a particular header value. If multiple values match the @var{kind}, return one of them (the ``first'', whatever that means). @var{key} must reference a zero-terminated @ascii{}-coded string representing the header to look for: it is compared against the headers using -@cfunction{strcasecmp}, so case is ignored. Return @null{} if no such +@cfunction{strcasecmp}, so case is ignored. Return @mynull{} if no such item was found. @end deftypefun @@ -678,15 +691,15 @@ item was found. @c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ @c ------------------------------------------------------------ -@node microhttpd responses -@appendixsec Building answers to responses +@node microhttpd-responses +@chapter Building answers to responses @menu -* microhttpd response enqueue:: Enqueuing a response. -* microhttpd response create:: Creating a response object. -* microhttpd response headers:: Adding headers to a response. -* microhttpd response inspect:: Inspecting a response object. +* microhttpd-response enqueue:: Enqueuing a response. +* microhttpd-response create:: Creating a response object. +* microhttpd-response headers:: Adding headers to a response. +* microhttpd-response inspect:: Inspecting a response object. @end menu @@ -709,8 +722,8 @@ responce and we finally destroy it only when the daemon shuts down. @c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ @c ------------------------------------------------------------ -@node microhttpd response enqueue -@appendixsubsec Enqueuing a response +@node microhttpd-response enqueue +@@section Enqueuing a response @deftypefun int MHD_queue_response (struct MHD_Connection *connection, unsigned int status_code, struct MHD_Response *response) @@ -729,7 +742,7 @@ response to transmit. @end table Return @code{MHD_YES} on success or if message has been queued. Return -@code{MHD_NO}: if arguments are invalid (example: @null{} pointer); on +@code{MHD_NO}: if arguments are invalid (example: @mynull{} pointer); on error (i.e. reply already sent). @end deftypefun @@ -784,8 +797,8 @@ the @code{MHD_Response} object is released. @c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ @c ------------------------------------------------------------ -@node microhttpd response create -@appendixsubsec Creating response objects +@node microhttpd-response create +@@section Creating response objects @deftypefun {struct MHD_Response *} MHD_create_response_from_callback (size_t size, unsigned int block_size, MHD_ContentReaderCallback crc, void *crc_cls, MHD_ContentReaderFreeCallback crfc) @@ -812,7 +825,7 @@ extra argument to @var{crc}; callback to call to free @var{crc_cls} resources. @end table -Return @null{} on error (i.e. invalid arguments, out of memory). +Return @mynull{} on error (i.e. invalid arguments, out of memory). @end deftypefun @@ -837,7 +850,7 @@ handling of the embedded memory is responsibility of @mhd{}; @var{data} can be released anytime after this call returns. @end table -Return @null{} on error (i.e. invalid arguments, out of memory). +Return @mynull{} on error (i.e. invalid arguments, out of memory). @end deftypefun @@ -860,8 +873,8 @@ MHD_destroy_response(response); @c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ @c ------------------------------------------------------------ -@node microhttpd response headers -@appendixsubsec Adding headers to a response +@node microhttpd-response headers +@@section Adding headers to a response @deftypefun int MHD_add_response_header (struct MHD_Response *response, const char *header, const char *content) @@ -886,8 +899,8 @@ Delete a header line from the response. Return @code{MHD_NO} on error @c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ @c ------------------------------------------------------------ -@node microhttpd response inspect -@appendixsubsec Inspecting a response object +@node microhttpd-response inspect +@@section Inspecting a response object @deftypefun int MHD_get_response_headers (struct MHD_Response *response, MHD_KeyValueIterator iterator, void *iterator_cls) @@ -895,7 +908,7 @@ Get all of the headers added to a response. Invoke the @var{iterator} callback for each header in the response, using @var{iterator_cls} as first argument. Return number of entries -iterated over. @var{iterator} can be @null{}: in this case the function +iterated over. @var{iterator} can be @mynull{}: in this case the function just counts headers. @var{iterator} should not modify the its key and value arguments, unless @@ -907,7 +920,7 @@ we know what we are doing. Find and return a pointer to the value of a particular header from the response. @var{key} must reference a zero-terminated string representing the header to look for. The search is case sensitive. -Return @null{} if header does not exist or @var{key} is @null{}. +Return @mynull{} if header does not exist or @var{key} is @mynull{}. We should not modify the value, unless we know what we are doing. @end deftypefun @@ -916,35 +929,33 @@ We should not modify the value, unless we know what we are doing. @c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ @c ------------------------------------------------------------ -@node microhttpd post -@appendixsec Adding a @code{POST} processor +@node microhttpd-post +@chapter Adding a @code{POST} processor @menu -* microhttpd post api:: Programming interface for the +* microhttpd-post api:: Programming interface for the @code{POST} processor. @end menu @noindent -When a small amount of data comes from a client's @code{POST} request: -the data is available through the values interface. @ref{microhttpd -values}, for details. In this case @mhd{} invokes -@code{MHD_AccessHandlerCallback} only once and the callback must process -all the data during that invocation. - -When a big amount of data comes from a client's @code{POST} request: the +@mhd{} provides the post procesor API to make it easier for applications to +parse the data of a client's @code{POST} request: the @code{MHD_AccessHandlerCallback} will be invoked multiple times to process data as it arrives; at each invocation a new chunk of data must be processed. The arguments @var{upload_data} and @var{upload_data_size} are used to reference the chunk of data. When @code{MHD_AccessHandlerCallback} is invoked for a new connection: -its @code{*@var{con_cls}} argument is set to @null{}. When @code{POST} +its @code{*@var{con_cls}} argument is set to @mynull{}. When @code{POST} data comes in the upload buffer it is @strong{mandatory} to use the -@var{con_cls} to hold data or to mark an ongoing process. +@var{con_cls} to store a reference to per-connection data. The fact +that the pointer was initially @mynull{} can be used to detect that +this is a new request. -To detect that a new connection has come with the @code{POST} method: +One method to detect that a new connection was established is +to set @code{*con_cls} to anunused integer: @example int @@ -956,10 +967,9 @@ access_handler (void *cls, void **con_cls) @{ static int old_connection_marker; - int new_connection = (NULL == *con_cls); - int method_is_post = strcmp("POST",method); + int new_connection = (MYNULL == *con_cls); - if (new_connection && method_is_post) + if (new_connection) @{ /* new connection with POST */ *con_cls = &old_connection_marker; @@ -970,12 +980,10 @@ access_handler (void *cls, @end example @noindent -in this example the value of @code{*con_cls} is just an unused pointer -to an unused integer: its purpose is to make @code{*con_cls} different -from @null{}. When serious processing of @code{POST} data is needed: it -can be a pointer to a dynamically allocated data structure. - -To detect that @code{POST} data is in the upload buffer: +In contrast to the previous example, for @code{POST} requests in particular, +it is more common to use the value of @code{*con_cls} to keep track of +actual state used during processing, such as the post processor (or a +struct containing a post processor): @example int @@ -986,156 +994,38 @@ access_handler (void *cls, const char *upload_data, unsigned int *upload_data_size, void **con_cls) @{ - static int old_connection_marker; - int new_connection = (NULL == *con_cls); - int method_is_post = strcmp("POST",method); + struct MHD_PostProcessor * pp = *con_cls; - if (new_connection && method_is_post) + if (pp == NULL) @{ - int data_in_upload_buffer = (0 != *upload_data_size); - - if (data_in_upload_buffer) - @{ - *con_cls = &old_connection_marker; - /* POST data in the buffer */ - @} - else - /* POST data accessible with the values API */ - @} - - ... -@} -@end example - - -At each invocation there are two options: - -@enumerate -@item -the callback can process the whole chunk by itself; every time @mhd{} -invokes it a new chunk is fully processed; with this mode the callback -has to @code{*upload_data_size = 0} before returning @code{MHD_YES}; - -@item -the callback can process a section of the chunk by itself; every time -@mhd{} invokes it the buffer holds the old data as well as new data -coming from the client; with this mode the callback has to set -@code{*upload_data_size} to the numbe of bytes still to process before -returning @code{MHD_YES}; - -example: @mhd{} invokes the callback with @code{100 == -*upload_data_size}; the callback processes the first 80 bytes and before -returning the callback sets @code{*upload_data_size = 20}; the last -unprocessed 20 bytes will be the first 20 at the next invocation; - -@item -when a new connection with @code{POST} data in the buffer comes: the -callback allocates a PostProcessor and hand to it the responsibility of -processing data; a pointer to the PostProcessor structure is saved in -@code{*con_cls}, so that it is available at each subsequent invocation; - -the post processor data can be freed by a later invocation to an -appropriate callback. -@end enumerate - - -Let's see how to implement strategy 1: - -@example -int -access_handler (void *cls, - struct MHD_Connection * connection, - const char *url, - const char *method, const char *version, - const char *upload_data, unsigned int *upload_data_size, - void **con_cls) -@{ - static int old_connection_marker; - int new_connection = (NULL == *con_cls); - int method_is_post = strcmp("POST",method); - - if (new_connection && method_is_post) - @{ - int data_in_upload_buffer = (0 != *upload_data_size); - - if (data_in_upload_buffer) - @{ - *con_cls = &old_connection_marker; - @} - else - @{ - /* POST data accessible with the values API */ - return MHD_YES; - @} + pp = MHD_create_post_processor(connection, ...); + *con_cls = pp; + return MHD_YES; @} - - if (&old_connection_marker == *con_cls) + if (*upload_data_size) @{ - consume_data(upload_data, *upload_data_size); + MHD_post_process(pp, upload_data, *upload_data_size); *upload_data_size = 0; return MHD_YES; @} - - /* process other methods */ - return MHD_YES; -@} -@end example - -Let's see how to implement strategy 2: - -@example -int -access_handler (void *cls, - struct MHD_Connection * connection, - const char *url, - const char *method, const char *version, - const char *upload_data, unsigned int *upload_data_size, - void **con_cls) -@{ - static int old_connection_marker; - int new_connection = (NULL == *con_cls); - int method_is_post = strcmp("POST",method); - - if (new_connection && method_is_post) + else @{ - int data_in_upload_buffer = (0 != *upload_data_size); - - if (data_in_upload_buffer) - @{ - *con_cls = &old_connection_marker; - @} - else - @{ - /* POST data accessible with the values API */ - return MHD_YES; - @} + return MHD_queue_response(...); @} - - if (&old_connection_marker == *con_cls) - @{ - int number_of_bytes_to_consume = 100; - - if (number_of_bytes_to_consume > *upload_data_size) - number_of_bytes_to_consume = *upload_data_size; - - consume_some_data(upload_data, number_of_bytes_to_consume); - *upload_data_size -= number_of_bytes_to_consume; - return MHD_YES; - @} - - /* process other methods */ - return MHD_YES; @} - @end example +Note that the callback from @code{MHD_OPTION_NOTIFY_COMPLETED} +should be used to destroy the post processor. This cannot be +done inside of the access handler since the connection may not +always terminate normally. @c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ @c ------------------------------------------------------------ -@node microhttpd post api -@appendixsubsec Programming interface for the @code{POST} processor +@node microhttpd-post api +@@section Programming interface for the @code{POST} processor @@ -1155,13 +1045,13 @@ should be sufficient; do @strong{NOT} use a value smaller than 256; @item iterator iterator to be called with the parsed data; must @strong{NOT} be -@null{}; +@mynull{}; @item iterator_cls custom value to be used as first argument to @var{iterator}. @end table -Return @null{} on error (out of memory, unsupported encoding), otherwise +Return @mynull{} on error (out of memory, unsupported encoding), otherwise a PP handle. @end deftypefun @@ -1196,3 +1086,26 @@ Release PostProcessor resources. @c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +@c ********************************************************** +@c ******************* Appendices ************************* +@c ********************************************************** + +@include lgpl.texi + +@node Concept Index +@unnumbered Concept Index + +@printindex cp + +@node Function and Data Index +@unnumbered Function and Data Index + +@printindex fn + +@node Type Index +@unnumbered Type Index + +@printindex tp + +@bye |