package github-hooks

You can search for identifiers within the package.

in-package search v0.2.0

github-hooks
- Github_hooks
  - CONFIGURATION
    
    Log
  - HOOKS
  - Make
    
    Conf
    
    Log
    
    Github
    
    API
    
    Check
    
    Collaborator
    
    Deploy_key
    
    Emoji
    
    Endpoint
    
    Version
    
    Event
    
    Filter
    
    Gist
    
    Git_obj
    
    Issue
    
    Label
    
    Milestone
    
    Monad
    
    Organization
    
    Hook
    
    Pull
    
    Rate_limit
    
    Release
    
    Repo
    
    Hook
    
    Response
    
    Scope
    
    Search
    
    Stats
    
    Status
    
    Stream
    
    Team
    
    Token
    
    URI
    
    User
    
    Server
    
    IO
    
    Time
  - Repo
    
    Set
  - SERVER
    
    IO
  - TIME

Legend:
Library
Module
Module type
Parameter
Class
Class type

include Cohttp_lwt.S.Server

module IO : Cohttp_lwt.S.IO

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

type body = Cohttp_lwt.Body.t

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

type response = Http.Response.t * Cohttp_lwt.Body.t

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

type t

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

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

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

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.

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

val callback : t -> IO.conn -> IO.ic -> IO.oc -> unit IO.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_error : 
  ?headers:Http.Header.t ->
  ?status:Http.Status.t ->
  body:string ->
  unit ->
  (Http.Response.t * body) IO.t

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

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

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

type tcp_config = private [>

| `Port of int

]

type mode = private [>

| `TCP of tcp_config
| `TLS of server_tls_config

]

val create : mode -> t -> unit Lwt.t