package tiny_httpd

  1. Overview
  2. Docs

Module Tiny_httpd.RequestSource

Sourcetype 'body t = private {
  1. meth : Meth.t;
  2. host : string;
  3. headers : Headers.t;
  4. http_version : int * int;
  5. path : string;
  6. path_components : string list;
  7. query : (string * string) list;
  8. body : 'body;
  9. 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
Sourceval pp : Format.formatter -> string t -> unit

Pretty print the request and its body

Sourceval pp_ : Format.formatter -> _ t -> unit

Pretty print the request without its body

Sourceval headers : _ t -> Headers.t

List of headers of the request, including "Host"

Sourceval get_header : ?f:(string -> string) -> _ t -> string -> string option
Sourceval get_header_int : _ t -> string -> int option
Sourceval set_header : string -> string -> 'a t -> 'a t

set_header k v req sets k: v in the request req's headers.

Sourceval update_headers : (Headers.t -> Headers.t) -> 'a t -> 'a t

Modify headers

  • since 0.11
Sourceval set_body : 'a -> _ t -> 'a t

set_body b req returns a new query whose body is b.

  • since 0.11
Sourceval host : _ t -> string

Host field of the request. It also appears in the headers.

Sourceval meth : _ t -> Meth.t

Method for the request.

Sourceval path : _ t -> string

Request path.

Sourceval query : _ t -> (string * string) list

Decode the query part of the path field

  • since 0.4
Sourceval body : 'b t -> 'b

Request body, possibly empty.

Sourceval start_time : _ t -> float

time stamp (from Unix.gettimeofday) after parsing the first line of the request

  • since 0.11
Sourceval 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
Sourceval read_body_full : ?buf_size:int -> byte_stream t -> string t

Read the whole body into a string. Potentially blocking.

  • parameter buf_size

    initial size of underlying buffer (since 0.11)