cohttp_lwt_unix.mli

(*
 * Copyright (c) 2012-2013 Anil Madhavapeddy <anil@recoil.org>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *
 *)

(** HTTP client and server using the [Lwt_unix] interfaces. *)

(** The [Request] module holds the information about a HTTP request, and
    also includes the {! Cohttp_lwt_unix_io} functions to handle large 
    message bodies. *)
module Request : Cohttp_lwt.Request with module IO = Cohttp_lwt_unix_io

(** The [Response] module holds the information about a HTTP response, and
    also includes the {! Cohttp_lwt_unix_io} functions to handle large 
    message bodies. *)
module Response : Cohttp_lwt.Response with module IO = Cohttp_lwt_unix_io

(** The [Client] module implements an HTTP client interface. *)
module Client : Cohttp_lwt.Client with module IO = Cohttp_lwt_unix_io

(** This module type defines the additional UNIX-specific functions that are
  exposed in addition to the {! Cohttp_lwt.Server} interface.  These are
  primarily filesystem functions, and also {! create} to actually bind
  the server to a socket and respond to incoming requests. *)
module type S = sig
  include Cohttp_lwt.Server with module IO = Cohttp_lwt_unix_io

  val resolve_file : docroot:string -> uri:Uri.t -> string

  val respond_file :
    ?headers:Cohttp.Header.t ->
    fname:string -> unit -> (Cohttp.Response.t * Cohttp_lwt_body.t) Lwt.t

  val create : ?timeout:int -> address:string -> port:int -> 
    config -> unit Lwt.t
end

(** The [Server] module implement the full UNIX HTTP server interface,
  including the UNIX-specific functions defined in {! S }. *)
module Server : S