package cohttp-mirage

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

cohttp-mirage
- Cohttp_mirage
  - Client
    
    Make
    
    Connection
    
    Net
    
    IO
    
    R
    
    S
    
    Flow
  - IO
    
    Channel
  - Server
    
    Flow
    
    F
    
    IO
    
    Make
    
    IO
    
    S
    
    Flow
    
    S
    
    IO
  - Static
    
    HTTP
    
    FS
    
    S
    
    IO

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module F : Mirage_flow.S

Signature

include Cohttp_lwt.S.Server with type IO.conn = F.flow

module IO : Cohttp_lwt.S.IO with type conn = F.flow

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

type response_action = [

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

]

A request handler can respond in two ways:

Using `Response, with a Response.t and a Body.t.
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 unitLwt.t is resolved. The connection can be closed by closing the IO.ic.

type t

val make_response_action : 
  ?conn_closed:(conn -> unit) ->
  callback:
    (conn -> Http.Request.t -> Cohttp_lwt.Body.t -> response_action Lwt.t) ->
  unit ->
  t

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

val make : 
  ?conn_closed:(conn -> unit) ->
  callback:
    (conn ->
      Http.Request.t ->
      Cohttp_lwt.Body.t ->
      (Http.Response.t * Cohttp_lwt.Body.t) Lwt.t) ->
  unit ->
  t

val 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.

val respond : 
  ?headers:Http.Header.t ->
  ?flush:bool ->
  status:Http.Status.t ->
  body:Cohttp_lwt.Body.t ->
  unit ->
  (Http.Response.t * Cohttp_lwt.Body.t) Lwt.t

respond ?headers ?flush ~status ~body will respond to an HTTP request with the given status code and response body. If flush is true, then every response chunk will be flushed to the network rather than being buffered. flush is true by default. 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.

val respond_string : 
  ?flush:bool ->
  ?headers:Http.Header.t ->
  status:Http.Status.t ->
  body:string ->
  unit ->
  (Http.Response.t * Cohttp_lwt.Body.t) Lwt.t

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

val respond_redirect : 
  ?headers:Http.Header.t ->
  uri:Uri.t ->
  unit ->
  (Http.Response.t * Cohttp_lwt.Body.t) Lwt.t

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

val respond_not_found : 
  ?uri:Uri.t ->
  unit ->
  (Http.Response.t * Cohttp_lwt.Body.t) Lwt.t

val callback : t -> IO.conn -> unit Lwt.t