simon/tiny_httpd
1
0
Fork 0
mirror of https://github.com/c-cube/tiny_httpd.git synced 2025-12-06 03:05:29 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

deploy: 13bfbfa759

Browse source
This commit is contained in:
c-cube 2024-02-20 17:58:10 +00:00
parent de4ba0b1c8
commit 6b5dfa9200
6 changed files with 14428 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13681
ocaml/_doc-dir/Changes Normal file
View file

File diff suppressed because it is too large Load diff

203
ocaml/_doc-dir/LICENSE Normal file
View file

@ -0,0 +1,203 @@
In the following, "the OCaml Core System" refers to all files marked
"Copyright INRIA" in this distribution.
The OCaml Core System is distributed under the terms of the
GNU Lesser General Public License (LGPL) version 2.1 (included below).
As a special exception to the GNU Lesser General Public License, you
may link, statically or dynamically, a "work that uses the OCaml Core
System" with a publicly distributed version of the OCaml Core System
to produce an executable file containing portions of the OCaml Core
System, and distribute that executable file under terms of your
choice, without any of the additional requirements listed in clause 6
of the GNU Lesser General Public License. By "a publicly distributed
version of the OCaml Core System", we mean either the unmodified OCaml
Core System as distributed by INRIA, or a modified version of the
OCaml Core System that is distributed under the conditions defined in
clause 2 of the GNU Lesser General Public License. This exception
does not however invalidate any other reasons why the executable file
might be covered by the GNU Lesser General Public License.
----------------------------------------------------------------------
GNU LESSER GENERAL PUBLIC LICENSE
Version 2.1, February 1999
Copyright (C) 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.]
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 packages--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 "Lesser" General Public License because it does 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.
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. 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.
1. 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.
2. 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:
a) The modified work must itself be a software library.
b) You must cause the files modified to carry prominent notices stating that you changed the files and the date of any change.
c) You must cause the whole of the work to be licensed at no charge to all third parties under the terms of this License.
d) 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.)
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.
3. 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.
4. 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.
5. 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.
6. 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:
a) 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.)
b) 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.
c) 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.
d) 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.
e) Verify that the user has already received a copy of these materials or that you have already sent this user a copy.
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.
7. 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:
a) 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.
b) 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.
8. 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.
9. 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.
10. 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.
11. 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.
12. 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.
13. 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.
14. 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.
NO WARRANTY
15. 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.
16. 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 OF TERMS AND CONDITIONS
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.
one line to give the library's name and an idea of what it does.
Copyright (C) year 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
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:
Yoyodyne, Inc., hereby disclaims all copyright interest in
the library `Frob' (a library for tweaking knobs) written
by James Random Hacker.
signature of Ty Coon, 1 April 1990
Ty Coon, President of Vice
That's all there is to it!
--------------------------------------------------

157
ocaml/_doc-dir/README.adoc Normal file
View file

@ -0,0 +1,157 @@
=== ⚠️ CAUTION
The developer team released OCaml 5.0.0 in December 2022. This release sports a
full rewrite of its runtime system for shared-memory parallel programming using
domains and native support for concurrent programming using effect handlers.
Owing to the large number of changes, the initial 5.0 release is more
experimental than usual. It is recommended that all users wanting a stable
release use the 4.14 release which will continue to be supported and updated
while 5.x reaches feature and stability parity. Similarly, if you need one of
the ports not yet supported in the 5.0 release you must use the 4.14 release.
The initial release of OCaml 5.0 only supports the native compiler under ARM64
and x86-64 architectures under Linux, macOS and the BSDs. On Windows, only the
MinGW-w64 port is supported. Support for other 64-bit architectures and
systems will be added back in later releases. On 32-bit systems, only the
bytecode compiler will be supported.
|=====
| Branch `trunk` | Branch `5.0` | Branch `4.14` | Branch `4.13`
| image:https://github.com/ocaml/ocaml/workflows/Build/badge.svg?branch=trunk["Github CI Build Status (trunk branch)",
link="https://github.com/ocaml/ocaml/actions?query=workflow%3ABuild"]
image:https://github.com/ocaml/ocaml/workflows/Hygiene/badge.svg?branch=trunk["Github CI Hygiene Status (trunk branch)",
link="https://github.com/ocaml/ocaml/actions?query=workflow%3AHygiene"]
image:https://ci.appveyor.com/api/projects/status/github/ocaml/ocaml?branch=trunk&svg=true["AppVeyor Build Status (trunk branch)",
link="https://ci.appveyor.com/project/avsm/ocaml"]
| image:https://github.com/ocaml/ocaml/workflows/Build/badge.svg?branch=5.0["Github CI Build Status (5.0 branch)",
link="https://github.com/ocaml/ocaml/actions?query=workflow%3ABuild"]
image:https://ci.appveyor.com/api/projects/status/github/ocaml/ocaml?branch=5.0&svg=true["AppVeyor Build Status (5.0 branch)",
link="https://ci.appveyor.com/project/avsm/ocaml"]
| image:https://github.com/ocaml/ocaml/workflows/Build/badge.svg?branch=4.14["Github CI Build Status (4.14 branch)",
link="https://github.com/ocaml/ocaml/actions?query=workflow%3Amain"]
image:https://ci.appveyor.com/api/projects/status/github/ocaml/ocaml?branch=4.14&svg=true["AppVeyor Build Status (4.14 branch)",
link="https://ci.appveyor.com/project/avsm/ocaml"]
| image:https://travis-ci.org/ocaml/ocaml.svg?branch=4.13["TravisCI Build Status (4.13 branch)",
link="https://travis-ci.org/ocaml/ocaml"]
image:https://ci.appveyor.com/api/projects/status/github/ocaml/ocaml?branch=4.13&svg=true["AppVeyor Build Status (4.13 branch)",
link="https://ci.appveyor.com/project/avsm/ocaml"]
|=====
= README =
== Overview
OCaml is a functional, statically-typed programming language from the
ML family, offering a powerful module system extending that of
Standard ML and a feature-rich, class-based object system.
OCaml comprises two compilers. One generates bytecode which is then
interpreted by a C program. This compiler runs quickly, generates
compact code with moderate memory requirements, and is portable to
many 32 or 64 bit platforms. Performance of generated programs is
quite good for a bytecoded implementation. This compiler can be used
either as a standalone, batch-oriented compiler that produces
standalone programs, or as an interactive REPL system.
The other compiler generates high-performance native code for a number of
processors. Compilation takes longer and generates bigger code, but the
generated programs deliver excellent performance, while retaining the
moderate memory requirements of the bytecode compiler. The native-code
compiler currently runs on the following platforms:
|====
| | Tier 1 (actively maintained) | Tier 2 (maintained when possible)
| x86 64 bits | Linux, macOS, Windows, FreeBSD | NetBSD, OpenBSD
| ARM 64 bits | Linux, macOS | FreeBSD
| Power 64 bits | Linux |
| RISC-V 64 bits | Linux |
| IBM Z (s390x) | Linux |
|====
Other operating systems for the processors above have not been tested, but
the compiler may work under other operating systems with little work.
== Copyright
All files marked "Copyright INRIA" in this distribution are
Copyright (C) 1996-2022 Institut National de Recherche en Informatique et
en Automatique (INRIA) and distributed under the conditions stated in
file LICENSE.
== Installation
See the file link:INSTALL.adoc[] for installation instructions on
machines running Unix, Linux, macOS, WSL and Cygwin. For native Microsoft
Windows, see link:README.win32.adoc[].
== Documentation
The OCaml manual is distributed in HTML, PDF, and Emacs
Info files. It is available at
https://ocaml.org/releases/latest/manual.html
== Availability
The complete OCaml distribution can be accessed at
https://ocaml.org/docs/install.html
== Keeping in Touch with the Caml Community
There is an active and friendly discussion forum at
https://discuss.ocaml.org/
The OCaml mailing list is the longest-running forum for OCaml users.
You can email it at
mailto:caml-list@inria.fr[]
You can subscribe and access list archives via the Web interface at
https://sympa.inria.fr/sympa/subscribe/caml-list
An alternative archive of the mailing list is also available at
https://inbox.ocaml.org/
There also exist other mailing lists, chat channels, and various other forums
around the internet for getting in touch with the OCaml and ML family language
community. These can be accessed at
https://ocaml.org/community/
In particular, the IRC channel `#ocaml` on https://libera.chat/[Libera] has a
long history and welcomes questions.
== Bug Reports and User Feedback
Please report bugs using the issue tracker at
https://github.com/ocaml/ocaml/issues
To be effective, bug reports should include a complete program (preferably
small) that exhibits the unexpected behavior, and the configuration you are
using (machine type, etc).
For information on contributing to OCaml, see link:HACKING.adoc[] and
link:CONTRIBUTING.md[].
== Separately maintained components
Some libraries and tools which used to be part of the OCaml distribution are
now maintained separately. Please use the issue trackers at their respective
new homes:
- https://github.com/ocaml/camlp-streams/issues[The Stream and Genlex standard library modules] (removed in OCaml 5.0)
- https://github.com/ocaml/graphics/issues[The Graphics library] (removed in OCaml 4.09)
- https://github.com/ocaml/num/issues[The Num library] (removed in OCaml 4.06)
- https://github.com/ocaml/ocamlbuild/issues[The OCamlbuild tool] (removed in OCaml 4.03)
- https://github.com/camlp4/camlp4/issues[The camlp4 tool] (removed in OCaml 4.02)
- https://github.com/garrigue/labltk/issues[The LablTk library] (removed in OCaml 4.02)
- https://github.com/ocaml/dbm/issues[The CamlDBM library] (removed in OCaml 4.00)
- https://github.com/xavierleroy/ocamltopwin/issues[The OCamlWinTop Windows toplevel] (removed in OCaml 4.00)

385
ocaml/_doc-dir/README.win32.adoc Normal file
View file

@ -0,0 +1,385 @@
=== ⚠️ CAUTION
The developer team is currently preparing the release of OCaml 5.0. This release
sports a full rewrite of its runtime system for shared-memory parallel
programming using domains and native support for concurrent programming using
effect handlers.
Owing to the large number of changes, the initial 5.0 release will be more
experimental than usual. It is recommended that all users wanting a stable
release use the 4.14 release which will continue to be supported and updated
while 5.0 reaches feature and stability parity. Similarly, if you need one of
the ports not yet supported in the 5.0 release you must use the 4.14 release.
The MSVC port is presently not supported, but will hopefully be added back in
later releases. On 32-bit systems, only the bytecode compiler is supported.
Native-code support for these 32-bit systems is under discussion.
= Release notes for the Microsoft Windows ports of OCaml =
:toc: macro
There are no fewer than three ports of OCaml for Microsoft Windows, each
available in 32 and 64-bit versions:
- native Windows, built with the Microsoft C/C++ Optimizing Compiler
- native Windows, built using the MinGW-w64 version of GCC
- Cygwin (http://www.cygwin.com[www.cygwin.com])
Here is a summary of the main differences between these ports:
|=====
| | Native Microsoft | Native MinGW-w64 | Cygwin
4+^| Third-party software required
| for base bytecode system | none | none | none
| for `ocamlc -custom` | Microsoft Visual C++ | Cygwin | Cygwin
| for native-code generation | Microsoft Visual C++ | Cygwin | Cygwin
4+^| Features
| Speed of bytecode interpreter | 70% | 100% | 100%
| Replay debugger | yes <<tb2,(**)>> | yes <<tb2,(**)>> | yes
| The Unix library | partial | partial | full
| The Threads library | yes | yes | yes
| Restrictions on generated executables? | none | none | yes <<tb1,(*)>>
|=====
[[tb1]]
(*):: Executables generated by the native GCC package in Cygwin are linked with
the Cygwin DLL and require this to be distributed with your programs.
Executables generated by Microsoft Visual C++ or the MinGW-w64 compilers (even
when run in Cygwin as `i686-w64-mingw32-gcc` or `x86_64-w64-mingw32-gcc`) are
not linked against this DLL. Prior to Cygwin 2.5.2 (the Cygwin version can be
obtained with `uname -r`) the Cygwin DLL is distributed under the GPL, requiring
any programs linked with it to be distributed under a compatible licence. Since
version 2.5.2, the Cygwin DLL is distributed under the LGPLv3 with a static
linking exception meaning that, like executables generated by Microsoft Visual
C++ or the MinGW-w64 compilers, generated executables may be distributed under
terms of your choosing.
[[tb2]]
(**):: The debugger is supported but the "replay" functions are not enabled.
Other functions are available (step, goto, run...).
Cygwin aims to provide a Unix-like environment on Windows, and the build
procedure for it is the same as for other flavours of Unix. See
link:INSTALL.adoc[] for full instructions.
The native ports require Windows Vista or later and naturally the 64-bit versions
need a 64-bit edition of Windows (note that this is both to run *and* build).
The two native Windows ports have to be built differently, and the remainder of
this document gives more information.
toc::[]
== PREREQUISITES
All the Windows ports require a Unix-like build environment. Although other
methods are available, the officially supported environment for doing this is
64-bit (x86_64) Cygwin.
Only the `make` Cygwin package is required. `diffutils` is required if you wish
to be able to run the test suite.
Unless you are also compiling the Cygwin port of OCaml, you do not need the
`gcc-core` or `flexdll` packages.
[[bmflex]]
In addition to Cygwin, FlexDLL must also be installed, which is available from
https://github.com/alainfrisch/flexdll. A binary distribution is available;
instructions on how to build FlexDLL from sources, including how to bootstrap
FlexDLL and OCaml are given <<seflexdll,later in this document>>. Unless you
bootstrap FlexDLL, you will need to ensure that the directory to which you
install FlexDLL is included in your `PATH` environment variable. Note: binary
distributions of FlexDLL are compatible only with Visual Studio 2013 and
earlier; for Visual Studio 2015 and later, you will need to compile the C
objects from source, or configure ocaml with the `--with-flexdll` option.
The base bytecode system (ocamlc, ocaml, ocamllex, ocamlyacc, ...) of all three
ports runs without any additional tools.
== Microsoft Visual C/C++ Ports
=== REQUIREMENTS
The native-code compiler (`ocamlopt`) and static linking of OCaml bytecode with
C code (`ocamlc -custom`) require a Microsoft Visual C/C++ Compiler and the
`flexlink` tool (see <<bmflex,above>>).
Any edition (including Express/Community editions) of Microsoft Visual Studio
2008 or later may be used to provide the required Windows headers and the C
compiler. Additionally, some older Microsoft Windows SDKs include the
Visual C/C++ Compiler as well as the Build Tools for Visual Studio.
|=====
| | `cl` Version | Express | SDK/Build Tools
| Visual Studio 2008 | 15.00.x.x | 32-bit only | Windows SDK 7.0 also provides 32/64-bit compilers
| Visual Studio 2010 | 16.00.x.x | 32-bit only | Windows SDK 7.1 also provides 32/64-bit compilers
| Visual Studio 2012 | 17.00.x.x | 32/64-bit |
| Visual Studio 2013 | 18.00.x.x | 32/64-bit |
| Visual Studio 2015 | 19.00.x.x | 32/64-bit | Build Tools for Visual Studio 2015 also provides 32/64-bit compilers
| Visual Studio 2017 | 19.10.x.x | 32/64-bit | Build Tools for Visual Studio 2017 also provides 32/64-bit compilers
| Visual Studio 2019 | 19.20.x.x | 32/64-bit | Build Tools for Visual Studio 2019 also provides 32/64-bit compilers
|=====
=== COMPILATION FROM THE SOURCES
The command-line tools must be compiled from the Unix source distribution
(`ocaml-X.YY.Z.tar.gz`), which also contains the files modified for Windows.
(Note: you should use cygwin's `tar` command to unpack this archive. If you
use WinZip, you will need to deselect "TAR file smart CR/LF conversion" in
the WinZip Options Window.)
Microsoft Visual C/C++ is designed to be used from special developer mode
Command Prompts which set the environment variables for the required compiler.
There are multiple ways of setting up your environment ready for their use. The
simplest is to start the appropriate command prompt shortcut from the program
group of the compiler you have installed.
The details differ depending on whether you are using a Windows SDK to provide
the compiler or Microsoft Visual Studio itself.
For the Windows SDK, there is only one command prompt called "CMD Shell" in
versions 6.1 and 7.0 and "Windows SDK 7.1 Command Prompt" in version 7.1. This
launches a Command Prompt which will usually select a `DEBUG` build environment
for the operating system that you are running. You should then run:
SetEnv /Release /x86
for 32-bit or:
SetEnv /Release /x64
for 64-bit. For Visual Studio 2008-2013, you need to use one of the shortcuts in
the "Visual Studio Tools" program group under the main program group for the
version of Visual Studio you installed. For Visual Studio 2015 and 2017, you
need to use the shortcuts in the "Windows Desktop Command Prompts" (2015) or
"VC" (2017) group under the "Visual Studio Tools" group.
Unlike `SetEnv` for the Windows SDK, the architecture is selected by using a
different shortcut, rather than by running a command.
For Visual Studio 2008-2010, excluding version-specific prefixes, these are
named "Command Prompt" for 32-bit and "x64 Cross Tools Command Prompt" or
"x64 Win64 Command Prompt" for 64-bit. It does not matter whether you use a
"Cross Tools" or "Win64" version for x64, this simply refers to whether the
compiler itself is a 32-bit or 64-bit program; both produce 64-bit output and
work with OCaml.
For Visual Studio 2012 and 2013, both x86 and x64 Command Prompt shortcuts
indicate if they are the "Native Tools" or "Cross Tools" versions. Visual Studio
2015 and 2017 make the shortcuts even clearer by including the full name of the
architecture.
The Build Tools for Visual Studio 2015 and 2017 provide shortcuts similar to
the ones of their respective Visual Studio version.
You cannot at present use a cross-compiler to compile 64-bit OCaml on 32-bit
Windows.
Once you have started a Command Prompt, you can verify that you have the
compiler you are expecting simply by running:
cl
Microsoft (R) C/C++ Optimizing Compiler Version 19.00.23506 for x86
...
You then need to start Cygwin from this Command Prompt. Assuming you have
installed it to its default location of `C:\cygwin`, simply run:
C:\cygwin\bin\mintty -
(note the space and hyphen at the end of the command).
This should open a terminal window and start bash. You should be able to run
`cl` from this. You can now change to the top-level directory of the directory
of the OCaml distribution.
The Microsoft Linker is provided by a command called `link` which unfortunately
conflicts with a Cygwin command of the same name. It is therefore necessary to
ensure that the directory containing the Microsoft C/C++ Compiler appears at
the beginning of `PATH`, before Cygwin's `/usr/bin`. You can automate this from
the top-level of the OCaml distribution by running:
eval $(tools/msvs-promote-path)
If you forget to do this, `make` will fail relatively
quickly as it will be unable to link `ocamlrun`.
Now run:
./configure --build=x86_64-pc-cygwin --host=i686-pc-windows
for 32-bit, or:
./configure --build=x86_64-pc-cygwin --host=x86_64-pc-windows
for 64-bit.
Finally, use `make` to build the system, e.g.
make
make install
After installing, it is not necessary to keep the Cygwin installation (although
you may require it to build additional third party libraries and tools). You
will need to use `ocamlopt` (or `ocamlc -custom`) from the same Visual Studio or
Windows SDK Command Prompt as you compiled OCaml from, or `ocamlopt` will not
be able to find `cl`.
If you wish to use `ocamlopt` from Cygwin's bash on a regular basis, you may
like to copy the `tools/msvs-promote-path` script and add the `eval` line to
your `~/.bashrc` file.
* The Microsoft Visual C/C++ compiler does not implement "computed gotos", and
therefore generates inefficient code for `runtime/interp.c`. Consequently,
the performance of bytecode programs is about 2/3 of that obtained under
Unix/GCC, Cygwin or MinGW-w64 on similar hardware.
* Libraries available in this port: `dynlink`, `num`,
`str`, `threads`, and large parts of `unix`.
* The replay debugger is partially supported (no reverse execution).
=== CREDITS
The initial port of Caml Special Light (the ancestor of OCaml) to Windows NT
was done by Kevin Gallo at Microsoft Research, who kindly contributed his
changes to the OCaml project.
== MinGW-w64 Ports
=== REQUIREMENTS
The native-code compiler (`ocamlopt`) and static linking of OCaml bytecode with
C code (`ocamlc -custom`) require the appropriate MinGW-w64 gcc and the
`flexlink` tool (see <<bmflex,above>>). MinGW-w64 gcc is provided by the
`mingw64-i686-gcc-core` package for 32-bit and the `mingw64-x86_64-gcc-core`
package for 64-bit.
- The Cygwin version of flexdll does not work with this port.
- The standalone mingw toolchain from the MinGW-w64 project
(http://mingw-w64.org/) is not supported. Please use the version packaged in
Cygwin instead.
=== COMPILATION FROM THE SOURCES
The command-line tools must be compiled from the Unix source distribution
(`ocaml-X.YY.Z.tar.gz`), which also contains the files modified for Windows.
(Note: you should use cygwin's `tar` command to unpack this archive. If you
use WinZip, you will need to deselect "TAR file smart CR/LF conversion" in
the WinZip Options Window.)
Now run:
./configure --build=x86_64-pc-cygwin --host=i686-w64-mingw32
for 32-bit, or:
./configure --build=x86_64-pc-cygwin --host=x86_64-w64-mingw32
for 64-bit.
Finally, use `make` to build the system, e.g.
make
make install
After installing, you will need to ensure that `ocamlopt` (or `ocamlc -custom`)
can access the C compiler. You can do this either by using OCaml from Cygwin's
bash or by adding Cygwin's bin directory (e.g. `C:\cygwin\bin`) to your `PATH`.
* Libraries available in this port: `dynlink`, `num`,
`str`, `threads`, and large parts of `unix`.
* The replay debugger is partially supported (no reverse execution).
[[seflexdll]]
== FlexDLL
Although the core of FlexDLL is necessarily written in C, the `flexlink` program
is, naturally, written in OCaml. This creates a circular dependency if you wish
to build entirely from sources. Since OCaml 4.03 and FlexDLL 0.35, it is now
possible to bootstrap the two programs simultaneously. The process is identical
for both ports. If you choose to compile this way, it is not necessary to
install FlexDLL separately.
You must extract the FlexDLL sources for Version 0.35 or later in the directory
`flexdll/` at the top-level directory of the OCaml distribution. This can be
done in one of three ways:
* Extracting the sources from a tarball from
https://github.com/alainfrisch/flexdll/releases
* Cloning the git repository by running:
+
git clone https://github.com/alainfrisch/flexdll.git
* If you are compiling from a git clone of the OCaml repository, instead of
using a sources tarball, you can run:
+
git submodule update --init
OCaml is then compiled normally for the port you require.
make
make install
* `make install` will install FlexDLL by placing `flexlink.exe`
(and the default manifest file for the Microsoft port) in `bin/` and the
FlexDLL object files in `lib/`.
* If you have populated `flexdll/`, the build will always use it, ignoring
any externally installed FlexDLL. You can override this behaviour by either
erasing the contents of `flexdll/` or passing the `--without-flexdll` option
to `configure`.
== Unicode support
Prior to version 4.06, all filenames on the OCaml side were assumed
to be encoded using the current 8-bit code page of the system. Some
Unicode filenames could thus not be represented. Since version 4.06,
OCaml adds to this legacy mode a new "Unicode" mode, where filenames
are UTF-8 encoded strings. In addition to filenames,
this applies to environment variables and command-line arguments.
The mode must be decided before building the system, by tweaking
the `WINDOWS_UNICODE` variable in `Makefile.config`. A value of 1
enables the the new "Unicode" mode, while a value of 0 maintains
the legacy mode.
Technically, both modes use the Windows "wide" API, where filenames
and other strings are made of 16-bit entities, usually interpreted as
UTF-16 encoded strings.
Some more details about the two modes:
* Unicode mode: OCaml strings are interpreted as being UTF-8 encoded
and translated to UTF-16 when calling Windows; strings returned by
Windows are interpreted as UTF-16 and translated to UTF-8 on their
way back to OCaml. Additionally, an OCaml string which is not
valid UTF-8 will be interpreted as being in the current 8-bit code
page. This fallback works well in practice, since the chances of
non-ASCII string encoded in the a 8-bit code page to be a valid
UTF-8 string are tiny. This means that filenames
obtained from e.g. a 8-bit UI or database layer would continue to
work fine. Application written for the legacy mode or older
versions of OCaml might still break if strings returned by
Windows (e.g. for `Sys.readdir`) are sent to components expecting
strings encoded in the current code page.
* Legacy mode: this mode emulates closely the behavior of OCaml <
4.06 and is thus the safest choice in terms of backward
compatibility. In this mode, OCaml programs can only work with
filenames that can be encoded in the current code page, and the
same applies to ocaml tools themselves (ocamlc, ocamlopt, etc).
The legacy mode will be deprecated and then removed in future versions
of OCaml. Users are thus strongly encouraged to use the Unicode mode
and adapt their existing code bases accordingly.
Note: in order for ocaml tools to support Unicode pathnames, it is
necessary to use a version of FlexDLL which has itself been compiled
with OCaml >= 4.06 in Unicode mode. This is the case for binary distributions
of FlexDLL starting from version 0.37 and above.
== Trademarks
Microsoft, Visual C++, Visual Studio and Windows are registered trademarks of
Microsoft Corporation in the United States and/or other countries.

2
tiny_httpd/Tiny_httpd_prometheus/index.html
View file

@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Tiny_httpd_prometheus (tiny_httpd.Tiny_httpd_prometheus)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../index.html">tiny_httpd</a> &#x00BB; Tiny_httpd_prometheus</nav><header class="odoc-preamble"><h1>Module <code><span>Tiny_httpd_prometheus</span></code></h1><p>Expose metrics over HTTP in the prometheus format</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-tags"><a href="#type-tags" class="anchor"></a><code><span><span class="keyword">type</span> tags</span><span> = <span><span>(string * string)</span> list</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Registry"><a href="#module-Registry" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Registry/index.html">Registry</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Registry for metrics.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-global"><a href="#val-global" class="anchor"></a><code><span><span class="keyword">val</span> global : <a href="Registry/index.html#type-t">Registry.t</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Counter"><a href="#module-Counter" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Counter/index.html">Counter</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Counters</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Gauge"><a href="#module-Gauge" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Gauge/index.html">Gauge</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Gauges</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Histogram"><a href="#module-Histogram" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Histogram/index.html">Histogram</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-http_middleware"><a href="#val-http_middleware" class="anchor"></a><code><span><span class="keyword">val</span> http_middleware : <span><a href="Registry/index.html#type-t">Registry.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="../Tiny_httpd_server/Middleware/index.html#type-t">Tiny_httpd.Middleware.t</a></span></code></div><div class="spec-doc"><p>Middleware to get basic metrics about HTTP requests</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_route_to_server"><a href="#val-add_route_to_server" class="anchor"></a><code><span><span class="keyword">val</span> add_route_to_server : <span><a href="../Tiny_httpd/index.html#type-t">Tiny_httpd.t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="Registry/index.html#type-t">Registry.t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Add a &quot;/metrics&quot; route to the server</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-instrument_server"><a href="#val-instrument_server" class="anchor"></a><code><span><span class="keyword">val</span> instrument_server : <span><a href="../Tiny_httpd/index.html#type-t">Tiny_httpd.t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="Registry/index.html#type-t">Registry.t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Add middleware and route</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-GC_metrics"><a href="#module-GC_metrics" class="anchor"></a><code><span><span class="keyword">module</span> <a href="GC_metrics/index.html">GC_metrics</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Tiny_httpd_prometheus (tiny_httpd.Tiny_httpd_prometheus)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../index.html">tiny_httpd</a> &#x00BB; Tiny_httpd_prometheus</nav><header class="odoc-preamble"><h1>Module <code><span>Tiny_httpd_prometheus</span></code></h1><p>Expose metrics over HTTP in the prometheus format.</p><p>This sub-library <code>tiny_httpd.prometheus</code> provides definitions for counters, gauges, and histogram, and endpoints to expose them for <a href="https://prometheus.io/">Prometheus</a> to scrape them.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.16</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-tags"><a href="#type-tags" class="anchor"></a><code><span><span class="keyword">type</span> tags</span><span> = <span><span>(string * string)</span> list</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Registry"><a href="#module-Registry" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Registry/index.html">Registry</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Registry for metrics.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-global"><a href="#val-global" class="anchor"></a><code><span><span class="keyword">val</span> global : <a href="Registry/index.html#type-t">Registry.t</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Counter"><a href="#module-Counter" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Counter/index.html">Counter</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Counters</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Gauge"><a href="#module-Gauge" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Gauge/index.html">Gauge</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Gauges</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Histogram"><a href="#module-Histogram" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Histogram/index.html">Histogram</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-http_middleware"><a href="#val-http_middleware" class="anchor"></a><code><span><span class="keyword">val</span> http_middleware : <span><a href="Registry/index.html#type-t">Registry.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="../Tiny_httpd_server/Middleware/index.html#type-t">Tiny_httpd.Middleware.t</a></span></code></div><div class="spec-doc"><p>Middleware to get basic metrics about HTTP requests</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_route_to_server"><a href="#val-add_route_to_server" class="anchor"></a><code><span><span class="keyword">val</span> add_route_to_server : <span><a href="../Tiny_httpd/index.html#type-t">Tiny_httpd.t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="Registry/index.html#type-t">Registry.t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Add a &quot;/metrics&quot; route to the server</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-instrument_server"><a href="#val-instrument_server" class="anchor"></a><code><span><span class="keyword">val</span> instrument_server : <span><a href="../Tiny_httpd/index.html#type-t">Tiny_httpd.t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="Registry/index.html#type-t">Registry.t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Add middleware and route</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-GC_metrics"><a href="#module-GC_metrics" class="anchor"></a><code><span><span class="keyword">module</span> <a href="GC_metrics/index.html">GC_metrics</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>

2
tiny_httpd/index.html
View file

@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (tiny_httpd.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – tiny_httpd</nav><header class="odoc-preamble"><h1 id="package-tiny_httpd"><a href="#package-tiny_httpd" class="anchor"></a>Package tiny_httpd <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><ul class="modules"><li><a href="Tiny_httpd/index.html"><code>Tiny_httpd</code></a> <span class="synopsis">Tiny Http Server</span></li><li><a href="Tiny_httpd_atomic_/index.html"><code>Tiny_httpd_atomic_</code></a> </li><li><a href="Tiny_httpd_buf/index.html"><code>Tiny_httpd_buf</code></a> <span class="synopsis">Simple buffer.</span></li><li><a href="Tiny_httpd_dir/index.html"><code>Tiny_httpd_dir</code></a> <span class="synopsis">Serving static content from directories</span></li><li><a href="Tiny_httpd_html/index.html"><code>Tiny_httpd_html</code></a> <span class="synopsis">HTML combinators.</span></li><li><a href="Tiny_httpd_html_/index.html"><code>Tiny_httpd_html_</code></a> </li><li><a href="Tiny_httpd_io/index.html"><code>Tiny_httpd_io</code></a> <span class="synopsis">IO abstraction.</span></li><li><a href="Tiny_httpd_log/index.html"><code>Tiny_httpd_log</code></a> <span class="synopsis">Logging for tiny_httpd</span></li><li><a href="Tiny_httpd_pool/index.html"><code>Tiny_httpd_pool</code></a> <span class="synopsis">Resource pool.</span></li><li><a href="Tiny_httpd_prometheus/index.html"><code>Tiny_httpd_prometheus</code></a> <span class="synopsis">Expose metrics over HTTP in the prometheus format</span></li><li><a href="Tiny_httpd_server/index.html"><code>Tiny_httpd_server</code></a> <span class="synopsis">HTTP server.</span></li><li><a href="Tiny_httpd_stream/index.html"><code>Tiny_httpd_stream</code></a> <span class="synopsis">Byte streams.</span></li><li><a href="Tiny_httpd_util/index.html"><code>Tiny_httpd_util</code></a> </li><li><a href="Tiny_httpd_ws/index.html"><code>Tiny_httpd_ws</code></a> <span class="synopsis">Websockets for Tiny_httpd.</span></li></ul></header><nav class="odoc-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav><div class="odoc-content"><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (tiny_httpd.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – tiny_httpd</nav><header class="odoc-preamble"><h1 id="package-tiny_httpd"><a href="#package-tiny_httpd" class="anchor"></a>Package tiny_httpd <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><ul class="modules"><li><a href="Tiny_httpd/index.html"><code>Tiny_httpd</code></a> <span class="synopsis">Tiny Http Server</span></li><li><a href="Tiny_httpd_atomic_/index.html"><code>Tiny_httpd_atomic_</code></a> </li><li><a href="Tiny_httpd_buf/index.html"><code>Tiny_httpd_buf</code></a> <span class="synopsis">Simple buffer.</span></li><li><a href="Tiny_httpd_dir/index.html"><code>Tiny_httpd_dir</code></a> <span class="synopsis">Serving static content from directories</span></li><li><a href="Tiny_httpd_html/index.html"><code>Tiny_httpd_html</code></a> <span class="synopsis">HTML combinators.</span></li><li><a href="Tiny_httpd_html_/index.html"><code>Tiny_httpd_html_</code></a> </li><li><a href="Tiny_httpd_io/index.html"><code>Tiny_httpd_io</code></a> <span class="synopsis">IO abstraction.</span></li><li><a href="Tiny_httpd_log/index.html"><code>Tiny_httpd_log</code></a> <span class="synopsis">Logging for tiny_httpd</span></li><li><a href="Tiny_httpd_pool/index.html"><code>Tiny_httpd_pool</code></a> <span class="synopsis">Resource pool.</span></li><li><a href="Tiny_httpd_prometheus/index.html"><code>Tiny_httpd_prometheus</code></a> <span class="synopsis">Expose metrics over HTTP in the prometheus format.</span></li><li><a href="Tiny_httpd_server/index.html"><code>Tiny_httpd_server</code></a> <span class="synopsis">HTTP server.</span></li><li><a href="Tiny_httpd_stream/index.html"><code>Tiny_httpd_stream</code></a> <span class="synopsis">Byte streams.</span></li><li><a href="Tiny_httpd_util/index.html"><code>Tiny_httpd_util</code></a> </li><li><a href="Tiny_httpd_ws/index.html"><code>Tiny_httpd_ws</code></a> <span class="synopsis">Websockets for Tiny_httpd.</span></li></ul></header><nav class="odoc-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav><div class="odoc-content"><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>