diff --git a/tiny_httpd/Tiny_httpd/index.html b/tiny_httpd/Tiny_httpd/index.html index d2727499..ed02f451 100644 --- a/tiny_httpd/Tiny_httpd/index.html +++ b/tiny_httpd/Tiny_httpd/index.html @@ -1,5 +1,5 @@ -Tiny_httpd (tiny_httpd.Tiny_httpd)

Module Tiny_httpd

Tiny Http Server

This library implements a very simple, basic HTTP/1.1 server using blocking IOs and threads. Basic routing based on Scanf is provided for convenience, so that several handlers can be registered.

It is possible to use a thread pool, see create's argument new_thread.

The echo example (see src/examples/echo.ml) demonstrates some of the features by declaring a few endpoints, including one for uploading files:

module S = Tiny_httpd
+Tiny_httpd (tiny_httpd.Tiny_httpd)
Module Tiny_httpd
Tiny Http Server
This library implements a very simple, basic HTTP/1.1 server using blocking IOs and threads. Basic routing based is provided for convenience, so that several handlers can be registered.
It is possible to use a thread pool, see create's argument new_thread.
The echo example (see src/examples/echo.ml) demonstrates some of the features by declaring a few endpoints, including one for uploading files:
module S = Tiny_httpd
 
 let () =
   let server = S.create () in
diff --git a/tiny_httpd/Tiny_httpd_io/Input/index.html b/tiny_httpd/Tiny_httpd_io/Input/index.html
index e1303293..20b2d40d 100644
--- a/tiny_httpd/Tiny_httpd_io/Input/index.html
+++ b/tiny_httpd/Tiny_httpd_io/Input/index.html
@@ -1,2 +1,2 @@
 
-Input (tiny_httpd.Tiny_httpd_io.Input)
Module Tiny_httpd_io.Input
Input channel (byte source)
type t = {
  1. input : bytes -> int -> int -> int;
    (*
    Read into the slice. Returns 0 only if the channel is closed.
    *)
  2. close : unit -> unit;
    (*
    Close the input. Must be idempotent.
    *)
}
An input channel, i.e an incoming stream of bytes.
This can be a string, an int_channel, an Unix.file_descr, a decompression wrapper around another input channel, etc.
val of_in_channel : ?close_noerr:bool -> in_channel -> t
val of_unix_fd : ?close_noerr:bool -> Unix.file_descr -> t
val of_slice : bytes -> int -> int -> t
val input : t -> bytes -> int -> int -> int
Read into the given slice.
  • returns 
    the number of bytes read, 0 means end of input.
val really_input : t -> bytes -> int -> int -> unit
Read exactly len bytes.
  • raises End_of_file 
    if the input did not contain enough data.
val close : t -> unit
Close the channel.
val append : t -> t -> t

+Input (tiny_httpd.Tiny_httpd_io.Input)
Module Tiny_httpd_io.Input
Input channel (byte source)
type t = {
  1. input : bytes -> int -> int -> int;
    (*
    Read into the slice. Returns 0 only if the channel is closed.
    *)
  2. close : unit -> unit;
    (*
    Close the input. Must be idempotent.
    *)
}
An input channel, i.e an incoming stream of bytes.
This can be a string, an int_channel, an Unix.file_descr, a decompression wrapper around another input channel, etc.
val of_in_channel : ?close_noerr:bool -> in_channel -> t
val of_unix_fd : ?close_noerr:bool -> closed:bool ref -> Unix.file_descr -> t
val of_slice : bytes -> int -> int -> t
val input : t -> bytes -> int -> int -> int
Read into the given slice.
  • returns 
    the number of bytes read, 0 means end of input.
val really_input : t -> bytes -> int -> int -> unit
Read exactly len bytes.
  • raises End_of_file 
    if the input did not contain enough data.
val close : t -> unit
Close the channel.
val append : t -> t -> t

diff --git a/tiny_httpd/Tiny_httpd_io/Output/index.html b/tiny_httpd/Tiny_httpd_io/Output/index.html
index c0e31c32..8abcbcae 100644
--- a/tiny_httpd/Tiny_httpd_io/Output/index.html
+++ b/tiny_httpd/Tiny_httpd_io/Output/index.html
@@ -1,2 +1,7 @@
 
-Output (tiny_httpd.Tiny_httpd_io.Output)
Module Tiny_httpd_io.Output
Output channel (byte sink)
type t = {
  1. output_char : char -> unit;
    (*
    Output a single char
    *)
  2. output : bytes -> int -> int -> unit;
    (*
    Output slice
    *)
  3. flush : unit -> unit;
    (*
    Flush underlying buffer
    *)
  4. close : unit -> unit;
    (*
    Close the output. Must be idempotent.
    *)
}
An output channel, ie. a place into which we can write bytes.
This can be a Buffer.t, an out_channel, a Unix.file_descr, etc.
val of_out_channel : ?close_noerr:bool -> out_channel -> t
of_out_channel oc wraps the channel into a Output.t.
  • parameter close_noerr 
    if true, then closing the result uses close_out_noerr instead of close_out to close oc
val of_buffer : Stdlib.Buffer.t -> t
of_buffer buf is an output channel that writes directly into buf. flush and close have no effect.
val output_char : t -> char -> unit
Output the buffer slice into this channel
val output : t -> bytes -> int -> int -> unit
Output the buffer slice into this channel
val output_string : t -> string -> unit
val close : t -> unit
Close the channel.
val flush : t -> unit
Flush (ie. force write) any buffered bytes.
val output_buf : t -> Buf.t -> unit
val chunk_encoding : ?buf:Buf.t -> close_rec:bool -> t -> t
chunk_encoding oc makes a new channel that outputs its content into oc in chunk encoding form.
  • parameter close_rec 
    if true, closing the result will also close oc
  • parameter buf 
    a buffer used to accumulate data into chunks. Chunks are emitted when buf's size gets over a certain threshold, or when flush is called.

+Output (tiny_httpd.Tiny_httpd_io.Output)
Module Tiny_httpd_io.Output
Output channel (byte sink)
type t = {
  1. output_char : char -> unit;
    (*
    Output a single char
    *)
  2. output : bytes -> int -> int -> unit;
    (*
    Output slice
    *)
  3. flush : unit -> unit;
    (*
    Flush underlying buffer
    *)
  4. close : unit -> unit;
    (*
    Close the output. Must be idempotent.
    *)
}
An output channel, ie. a place into which we can write bytes.
This can be a Buffer.t, an out_channel, a Unix.file_descr, etc.
val of_unix_fd : 
+  ?close_noerr:bool ->
+  closed:bool ref ->
+  buf:Buf.t ->
+  Unix.file_descr ->
+  t
val of_out_channel : ?close_noerr:bool -> out_channel -> t
of_out_channel oc wraps the channel into a Output.t.
  • parameter close_noerr 
    if true, then closing the result uses close_out_noerr instead of close_out to close oc
val of_buffer : Stdlib.Buffer.t -> t
of_buffer buf is an output channel that writes directly into buf. flush and close have no effect.
val output_char : t -> char -> unit
Output the buffer slice into this channel
val output : t -> bytes -> int -> int -> unit
Output the buffer slice into this channel
val output_string : t -> string -> unit
val close : t -> unit
Close the channel.
val flush : t -> unit
Flush (ie. force write) any buffered bytes.
val output_buf : t -> Buf.t -> unit
val chunk_encoding : ?buf:Buf.t -> close_rec:bool -> t -> t
chunk_encoding oc makes a new channel that outputs its content into oc in chunk encoding form.
  • parameter close_rec 
    if true, closing the result will also close oc
  • parameter buf 
    a buffer used to accumulate data into chunks. Chunks are emitted when buf's size gets over a certain threshold, or when flush is called.

diff --git a/tiny_httpd/Tiny_httpd_server/Request/index.html b/tiny_httpd/Tiny_httpd_server/Request/index.html
index 60d386c5..61e5ed9f 100644
--- a/tiny_httpd/Tiny_httpd_server/Request/index.html
+++ b/tiny_httpd/Tiny_httpd_server/Request/index.html
@@ -1,5 +1,5 @@
 
-Request (tiny_httpd.Tiny_httpd_server.Request)
Module Tiny_httpd_server.Request
type 'body t = private {
  1. meth : Meth.t;
    (*
    HTTP method for this request.
    *)
  2. host : string;
    (*
    Host header, mandatory. It can also be found in headers.
    *)
  3. client_addr : Unix.sockaddr;
    (*
    Client address. Available since 0.14.
    *)
  4. headers : Headers.t;
    (*
    List of headers.
    *)
  5. http_version : int * int;
    (*
    HTTP version. This should be either 1, 0 or 1, 1.
    *)
  6. path : string;
    (*
    Full path of the requested URL.
    *)
  7. path_components : string list;
    (*
    Components of the path of the requested URL.
    *)
  8. query : (string * string) list;
    (*
    Query part of the requested URL.
    *)
  9. body : 'body;
    (*
    Body of the request.
    *)
  10. start_time : float;
    (*
    Obtained via get_time_s in create
    • since 0.11
    *)
}
A request with method, path, host, headers, and a body, sent by a client.
The body is polymorphic because the request goes through several transformations. First it has no body, as only the request and headers are read; then it has a stream body; then the body might be entirely read as a string via read_body_full.
  • since 0.6 The field [query] was added and contains the query parameters in ["?foo=bar,x=y"]
  • since 0.6 The field [path_components] is the part of the path that precedes [query] and is split on ["/"].
  • since 0.11 the type is a private alias
  • since 0.11 the field [start_time] was added
val pp : Stdlib.Format.formatter -> string t -> unit
Pretty print the request and its body. The exact format of this printing is not specified.
val pp_ : Stdlib.Format.formatter -> _ t -> unit
Pretty print the request without its body. The exact format of this printing is not specified.
val headers : _ t -> Headers.t
List of headers of the request, including "Host".
val get_header : ?f:(string -> string) -> _ t -> string -> string option
get_header req h looks up header h in req. It returns None if the header is not present. This is case insensitive and should be used rather than looking up h verbatim in headers.
val get_header_int : _ t -> string -> int option
Same as get_header but also performs a string to integer conversion.
val set_header : string -> string -> 'a t -> 'a t
set_header k v req sets k: v in the request req's headers.
val update_headers : (Headers.t -> Headers.t) -> 'a t -> 'a t
Modify headers using the given function.
  • since 0.11
val set_body : 'a -> _ t -> 'a t
set_body b req returns a new query whose body is b.
  • since 0.11
val host : _ t -> string
Host field of the request. It also appears in the headers.
val client_addr : _ t -> Unix.sockaddr
Client address of the request.
  • since 0.16
val meth : _ t -> Meth.t
Method for the request.
val path : _ t -> string
Request path.
val query : _ t -> (string * string) list
Decode the query part of the path field.
  • since 0.4
val body : 'b t -> 'b
Request body, possibly empty.
val start_time : _ t -> float
time stamp (from Unix.gettimeofday) after parsing the first line of the request
  • since 0.11
val limit_body_size : max_size:int -> byte_stream t -> byte_stream t
Limit the body size to max_size bytes, or return a 413 error.
  • since 0.3
val read_body_full : 
+Request (tiny_httpd.Tiny_httpd_server.Request)
Module Tiny_httpd_server.Request
type 'body t = private {
  1. meth : Meth.t;
    (*
    HTTP method for this request.
    *)
  2. host : string;
    (*
    Host header, mandatory. It can also be found in headers.
    *)
  3. client_addr : Unix.sockaddr;
    (*
    Client address. Available since 0.14.
    *)
  4. headers : Headers.t;
    (*
    List of headers.
    *)
  5. http_version : int * int;
    (*
    HTTP version. This should be either 1, 0 or 1, 1.
    *)
  6. path : string;
    (*
    Full path of the requested URL.
    *)
  7. path_components : string list;
    (*
    Components of the path of the requested URL.
    *)
  8. query : (string * string) list;
    (*
    Query part of the requested URL.
    *)
  9. body : 'body;
    (*
    Body of the request.
    *)
  10. start_time : float;
    (*
    Obtained via get_time_s in create
    • since 0.11
    *)
}
A request with method, path, host, headers, and a body, sent by a client.
The body is polymorphic because the request goes through several transformations. First it has no body, as only the request and headers are read; then it has a stream body; then the body might be entirely read as a string via read_body_full.
  • since 0.6 The field [query] was added and contains the query parameters in ["?foo=bar,x=y"]
  • since 0.6 The field [path_components] is the part of the path that precedes [query] and is split on ["/"].
  • since 0.11 the type is a private alias
  • since 0.11 the field [start_time] was added
val pp : Stdlib.Format.formatter -> string t -> unit
Pretty print the request and its body. The exact format of this printing is not specified.
val pp_ : Stdlib.Format.formatter -> _ t -> unit
Pretty print the request without its body. The exact format of this printing is not specified.
val headers : _ t -> Headers.t
List of headers of the request, including "Host".
val get_header : ?f:(string -> string) -> _ t -> string -> string option
get_header req h looks up header h in req. It returns None if the header is not present. This is case insensitive and should be used rather than looking up h verbatim in headers.
val get_header_int : _ t -> string -> int option
Same as get_header but also performs a string to integer conversion.
val set_header : string -> string -> 'a t -> 'a t
set_header k v req sets k: v in the request req's headers.
val remove_header : string -> 'a t -> 'a t
Remove one instance of this header.
  • since NEXT_RELEASE
val update_headers : (Headers.t -> Headers.t) -> 'a t -> 'a t
Modify headers using the given function.
  • since 0.11
val set_body : 'a -> _ t -> 'a t
set_body b req returns a new query whose body is b.
  • since 0.11
val host : _ t -> string
Host field of the request. It also appears in the headers.
val client_addr : _ t -> Unix.sockaddr
Client address of the request.
  • since 0.16
val meth : _ t -> Meth.t
Method for the request.
val path : _ t -> string
Request path.
val query : _ t -> (string * string) list
Decode the query part of the path field.
  • since 0.4
val body : 'b t -> 'b
Request body, possibly empty.
val start_time : _ t -> float
time stamp (from Unix.gettimeofday) after parsing the first line of the request
  • since 0.11
val limit_body_size : max_size:int -> byte_stream t -> byte_stream t
Limit the body size to max_size bytes, or return a 413 error.
  • since 0.3
val read_body_full : 
   ?buf:Tiny_httpd_buf.t ->
   ?buf_size:int ->
   byte_stream t ->
diff --git a/tiny_httpd/Tiny_httpd_server/Response/index.html b/tiny_httpd/Tiny_httpd_server/Response/index.html
index db3fcf8e..c2020022 100644
--- a/tiny_httpd/Tiny_httpd_server/Response/index.html
+++ b/tiny_httpd/Tiny_httpd_server/Response/index.html
@@ -1,5 +1,5 @@
 
-Response (tiny_httpd.Tiny_httpd_server.Response)
Module Tiny_httpd_server.Response
type body = [ 
  1. | `String of string
  2. | `Stream of byte_stream
  3. | `Writer of Tiny_httpd_io.Writer.t
  4. | `Void
 ]
Body of a response, either as a simple string, or a stream of bytes, or nothing (for server-sent events notably).
  • `String str replies with a body set to this string, and a known content-length.
  • `Stream str replies with a body made from this string, using chunked encoding.
  • `Void replies with no body.
  • `Writer w replies with a body created by the writer w, using a chunked encoding. It is available since 0.14.
type t = private {
  1. code : Response_code.t;
    (*
    HTTP response code. See Response_code.
    *)
  2. headers : Headers.t;
    (*
    Headers of the reply. Some will be set by Tiny_httpd automatically.
    *)
  3. body : body;
    (*
    Body of the response. Can be empty.
    *)
}
A response to send back to a client.
val set_body : body -> t -> t
Set the body of the response.
  • since 0.11
val set_header : string -> string -> t -> t
Set a header.
  • since 0.11
val update_headers : (Headers.t -> Headers.t) -> t -> t
Modify headers.
  • since 0.11
val set_headers : Headers.t -> t -> t
Set all headers.
  • since 0.11
val set_code : Response_code.t -> t -> t
Set the response code.
  • since 0.11
val make_raw : ?headers:Headers.t -> code:Response_code.t -> string -> t
Make a response from its raw components, with a string body. Use "" to not send a body at all.
val make_raw_stream : 
+Response (tiny_httpd.Tiny_httpd_server.Response)
Module Tiny_httpd_server.Response
type body = [ 
  1. | `String of string
  2. | `Stream of byte_stream
  3. | `Writer of Tiny_httpd_io.Writer.t
  4. | `Void
 ]
Body of a response, either as a simple string, or a stream of bytes, or nothing (for server-sent events notably).
  • `String str replies with a body set to this string, and a known content-length.
  • `Stream str replies with a body made from this string, using chunked encoding.
  • `Void replies with no body.
  • `Writer w replies with a body created by the writer w, using a chunked encoding. It is available since 0.14.
type t = private {
  1. code : Response_code.t;
    (*
    HTTP response code. See Response_code.
    *)
  2. headers : Headers.t;
    (*
    Headers of the reply. Some will be set by Tiny_httpd automatically.
    *)
  3. body : body;
    (*
    Body of the response. Can be empty.
    *)
}
A response to send back to a client.
val set_body : body -> t -> t
Set the body of the response.
  • since 0.11
val set_header : string -> string -> t -> t
Set a header.
  • since 0.11
val update_headers : (Headers.t -> Headers.t) -> t -> t
Modify headers.
  • since 0.11
val remove_header : string -> t -> t
Remove one instance of this header.
  • since NEXT_RELEASE
val set_headers : Headers.t -> t -> t
Set all headers.
  • since 0.11
val set_code : Response_code.t -> t -> t
Set the response code.
  • since 0.11
val make_raw : ?headers:Headers.t -> code:Response_code.t -> string -> t
Make a response from its raw components, with a string body. Use "" to not send a body at all.
val make_raw_stream : 
   ?headers:Headers.t ->
   code:Response_code.t ->
   byte_stream ->
diff --git a/tiny_httpd/Tiny_httpd_stream/index.html b/tiny_httpd/Tiny_httpd_stream/index.html
index d935611b..4fbc2908 100644
--- a/tiny_httpd/Tiny_httpd_stream/index.html
+++ b/tiny_httpd/Tiny_httpd_stream/index.html
@@ -6,7 +6,11 @@
     Bytes.blit self.bs self.off buf offset len;
     self.consume len;
   );
-  len
val close : t -> unit
Close stream
val empty : t
Stream with 0 bytes inside
val of_input : ?buf_size:int -> Tiny_httpd_io.Input.t -> t
Make a buffered stream from the given channel.
  • since 0.14
val of_chan : ?buf_size:int -> in_channel -> t
Make a buffered stream from the given channel.
val of_chan_close_noerr : ?buf_size:int -> in_channel -> t
Same as of_chan but the close method will never fail.
val of_fd : ?buf_size:int -> Unix.file_descr -> t
Make a buffered stream from the given file descriptor.
val of_fd_close_noerr : ?buf_size:int -> Unix.file_descr -> t
Same as of_fd but the close method will never fail.
val of_bytes : ?i:int -> ?len:int -> bytes -> t
A stream that just returns the slice of bytes starting from i and of length len.
val of_string : string -> t
val iter : (bytes -> int -> int -> unit) -> t -> unit
Iterate on the chunks of the stream
  • since 0.3
val to_chan : out_channel -> t -> unit
Write the stream to the channel.
  • since 0.3
val to_chan' : Tiny_httpd_io.Output.t -> t -> unit
Write to the IO channel.
  • since 0.14
val to_writer : t -> Tiny_httpd_io.Writer.t
Turn this stream into a writer.
  • since 0.14
val make : 
+  len
val close : t -> unit

Close stream

val empty : t

Stream with 0 bytes inside

val of_input : ?buf_size:int -> Tiny_httpd_io.Input.t -> t

Make a buffered stream from the given channel.

  • since 0.14
val of_chan : ?buf_size:int -> in_channel -> t

Make a buffered stream from the given channel.

val of_chan_close_noerr : ?buf_size:int -> in_channel -> t

Same as of_chan but the close method will never fail.

val of_fd : ?buf_size:int -> closed:bool ref -> Unix.file_descr -> t

Make a buffered stream from the given file descriptor.

val of_fd_close_noerr : + ?buf_size:int -> + closed:bool ref -> + Unix.file_descr -> + t

Same as of_fd but the close method will never fail.

val of_bytes : ?i:int -> ?len:int -> bytes -> t

A stream that just returns the slice of bytes starting from i and of length len.

val of_string : string -> t
val iter : (bytes -> int -> int -> unit) -> t -> unit

Iterate on the chunks of the stream

  • since 0.3
val to_chan : out_channel -> t -> unit

Write the stream to the channel.

  • since 0.3
val to_chan' : Tiny_httpd_io.Output.t -> t -> unit

Write to the IO channel.

  • since 0.14
val to_writer : t -> Tiny_httpd_io.Writer.t

Turn this stream into a writer.

  • since 0.14
val make : ?bs:bytes -> ?close:(t -> unit) -> consume:(t -> int -> unit) ->