package cohttp-lwt

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package cohttp-lwt

cohttp-lwt
- CHANGES
- LICENSE
- README
- Library cohttp-lwt
  - Cohttp_lwt
    
    IO
    
    Request
    
    Response
    
    Connection
    
    Make
    
    Net
    
    Connection_cache
    
    Make_no_cache
    
    Make
    
    Make_proxy
    
    Client
    
    Make
    
    Server
    
    Make
    
    IO
    
    Make_client
    
    Make_server
    
    S
    
    IO
    
    Net
    
    IO
    
    Sleep
    
    Connection
    
    Net
    
    IO
    
    Connection_cache
    
    Client
    
    Server
    
    IO
    
    Body
    
    Private
    
    Bytebuffer
    
    Make
    
    String_io
- Sources
  - cohttp-lwt
    
    body.ml
    
    bytebuffer.ml
    
    client.ml
    
    cohttp_lwt.ml
    
    cohttp_lwt__.ml
    
    connection.ml
    
    connection_cache.ml
    
    make.ml
    
    s.ml
    
    server.ml
    
    string_io.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Server.Make`Source

Parameters

module IO : S.IO

Signature

Sourcemodule IO = IO

include Cohttp.Generic.Server.S
  with type body = Body.t
   and module IO := IO
   and type response = Http.Response.t * Body.t

Sourcetype body = Body.t

Sourcetype conn = IO.conn * Cohttp.Connection.t

Sourcetype response = Http.Response.t * Body.t

Sourcetype response_action = [

| `Expert of Http.Response.t * (IO.ic -> IO.oc -> unit IO.t)
| `Response of response

]

A request handler can respond in two ways:

Using `Response, with a Response.t and a body.
Using `Expert, with a Response.t and an IO function that is expected to write the response body. The IO function has access to the underlying IO.ic and IO.oc, which allows writing a response body more efficiently, stream a response or to switch protocols entirely (e.g. websockets). Processing of pipelined requests continue after the unit IO.t is resolved. The connection can be closed by closing the IO.ic.

Sourcetype t

Source

val make_response_action : 
  ?conn_closed:(conn -> unit) ->
  callback:(conn -> Http.Request.t -> body -> response_action IO.t) ->
  unit ->
  t

Source

val make_expert : 
  ?conn_closed:(conn -> unit) ->
  callback:
    (conn ->
      Http.Request.t ->
      body ->
      (Http.Response.t * (IO.ic -> IO.oc -> unit IO.t)) IO.t) ->
  unit ->
  t

Source

val make : 
  ?conn_closed:(conn -> unit) ->
  callback:(conn -> Http.Request.t -> body -> response IO.t) ->
  unit ->
  t

Source

val respond : 
  ?headers:Http.Header.t ->
  status:Http.Status.t ->
  body:body ->
  unit ->
  response IO.t

respond ?headers ~status ~body will respond to an HTTP request with the given status code and response body. The transfer encoding will be detected from the body value and set to chunked encoding if it cannot be determined immediately. You can override the encoding by supplying an appropriate Content-length or Transfer-encoding in the headers parameter.

Source

val respond_string : 
  ?headers:Http.Header.t ->
  status:Http.Status.t ->
  body:string ->
  unit ->
  response IO.t

Sourceval callback : t -> IO.conn -> IO.ic -> IO.oc -> unit IO.t

Sourceval resolve_local_file : docroot:string -> uri:Uri.t -> string

Resolve a URI and a docroot into a concrete local filename.

deprecated Please use Cohttp.Path.resolve_local_file.

Source

val respond_error : 
  ?headers:Http.Header.t ->
  ?status:Http.Status.t ->
  body:string ->
  unit ->
  (Http.Response.t * body) IO.t

Source

val respond_redirect : 
  ?headers:Http.Header.t ->
  uri:Uri.t ->
  unit ->
  (Http.Response.t * body) IO.t

Source

val respond_need_auth : 
  ?headers:Http.Header.t ->
  auth:Cohttp.Auth.challenge ->
  unit ->
  (Http.Response.t * body) IO.t

Sourceval respond_not_found : ?uri:Uri.t -> unit -> (Http.Response.t * body) IO.t

package cohttp-lwt

Module Server.MakeSource

Parameters

Signature

Module `Server.Make`Source