Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Page
Library
Module
Module type
Parameter
Class
Class type
Source
package yurt
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Module Yurt_serverSource
include module type of struct include Cohttp_lwt_unix.Server end
include Cohttp_lwt.S.Server with module IO = Cohttp_lwt_unix__.Io
module IO = Cohttp_lwt_unix.Server.IOtype conn = IO.conn * Cohttp.Connection.ttype response_action = [ | `Expert of Cohttp.Response.t * (IO.ic -> IO.oc -> unit Lwt.t)| `Response of Cohttp.Response.t * Cohttp_lwt__.Body.t
]A request handler can respond in two ways:
- Using
`Response, with aResponse.tand aBody.t. - Using
`Expert, with aResponse.tand an IO function that is expected to write the response body. The IO function has access to the underlyingIO.icandIO.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 theunitLwt.tis resolved. The connection can be closed by closing theIO.ic.
type t = Cohttp_lwt_unix.Server.tval make_response_action :
?conn_closed:(conn -> unit) ->
callback:
(conn -> Cohttp.Request.t -> Cohttp_lwt__.Body.t -> response_action Lwt.t) ->
unit ->
tval make_expert :
?conn_closed:(conn -> unit) ->
callback:
(conn ->
Cohttp.Request.t ->
Cohttp_lwt__.Body.t ->
(Cohttp.Response.t * (IO.ic -> IO.oc -> unit Lwt.t)) Lwt.t) ->
unit ->
tval make :
?conn_closed:(conn -> unit) ->
callback:
(conn ->
Cohttp.Request.t ->
Cohttp_lwt__.Body.t ->
(Cohttp.Response.t * Cohttp_lwt__.Body.t) Lwt.t) ->
unit ->
tval resolve_local_file : docroot:string -> uri:Uri.t -> stringResolve a URI and a docroot into a concrete local filename.
Deprecated. Please use Cohttp.Path.resolve_local_file.
val respond :
?headers:Cohttp.Header.t ->
?flush:bool ->
status:Cohttp.Code.status_code ->
body:Cohttp_lwt__.Body.t ->
unit ->
(Cohttp.Response.t * Cohttp_lwt__.Body.t) Lwt.trespond ?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:Cohttp.Header.t ->
status:Cohttp.Code.status_code ->
body:string ->
unit ->
(Cohttp.Response.t * Cohttp_lwt__.Body.t) Lwt.tval respond_error :
?headers:Cohttp.Header.t ->
?status:Cohttp.Code.status_code ->
body:string ->
unit ->
(Cohttp.Response.t * Cohttp_lwt__.Body.t) Lwt.tval respond_redirect :
?headers:Cohttp.Header.t ->
uri:Uri.t ->
unit ->
(Cohttp.Response.t * Cohttp_lwt__.Body.t) Lwt.tval respond_need_auth :
?headers:Cohttp.Header.t ->
auth:Cohttp.Auth.challenge ->
unit ->
(Cohttp.Response.t * Cohttp_lwt__.Body.t) Lwt.tval respond_not_found :
?uri:Uri.t ->
unit ->
(Cohttp.Response.t * Cohttp_lwt__.Body.t) Lwt.tDeprecated. Please use Cohttp.Path.resolve_local_file.
Source
val respond_file :
?headers:Cohttp.Header.t ->
fname:string ->
unit ->
(Cohttp.Response.t * Cohttp_lwt.Body.t) Lwt.tSource
val create :
?timeout:int ->
?backlog:int ->
?stop:unit Lwt.t ->
?on_exn:(exn -> unit) ->
?ctx:Cohttp_lwt_unix.Net.ctx ->
?mode:Conduit_lwt_unix.server ->
t ->
unit Lwt.tcreate ?timeout ?backlog ?stop ?on_exn ?mode t is a new HTTP server.
The user can decide to start a simple HTTP server (without encryption) or one with TLS encryption. It depends on what the user gives as mode and how conduit-unix is configured.
To create a simple HTTP server listening on port 8089:
let run = create (`TCP 8080) When provided, the stop thread will terminate the server if it ever becomes determined.
When provided, backlog will limit the number of open connections.
Every connection will be served in a new lightweight thread that is invoked via the callback defined in t. If the callback raises an exception, it is passed to on_exn (by default, to a function that logs the exception using the Logs library).
Source
type server = {host : string;port : int;mutable routes : (string * Yurt_route.route * Yurt_request_ctx.endpoint) list;mutable tls_config : Conduit_lwt_unix.server_tls_config option;mutable logger : Lwt_log.logger;
}Source
val server :
?tls_config:Conduit_lwt_unix.server_tls_config ->
?logger:Lwt_log.logger ->
string ->
int ->
serverSource
val find_tls_config :
Ezjsonm.value ->
'a ->
([> `Crt_file_path of string ]
* [> `Key_file_path of string ]
* [> `No_password ]
* [> `Port of 'a ])
optionSource
exception End_route_iteration of (Yurt_request_ctx.Response.t * Yurt_request_ctx.Body.t)
Lwt.tSource
val configure_tls :
?password:[ `No_password | `Password of bool -> string ] ->
server ->
string ->
string ->
serverConfigure TLS for server
Source
val stream :
?flush:bool ->
?headers:Cohttp.Header.t ->
?status:int ->
string Lwt_stream.t ->
(Cohttp.Response.t * Cohttp_lwt__.Body.t) Lwt.tFinish with a string stream
Source
val string :
?flush:bool ->
?headers:Cohttp.Header.t ->
?status:int ->
string ->
(Cohttp.Response.t * Cohttp_lwt__.Body.t) Lwt.tSource
val json :
?flush:bool ->
?headers:Cohttp.Header.t ->
?status:int ->
Ezjsonm.t ->
(Cohttp.Response.t * Cohttp_lwt__.Body.t) Lwt.tFinish with JSON
Source
val html :
?flush:bool ->
?headers:Cohttp.Header.t ->
?status:int ->
Yurt_html.t ->
(Cohttp.Response.t * Cohttp_lwt__.Body.t) Lwt.tFinish with HTML
Source
val file :
?headers:Cohttp.Header.t ->
string ->
(Cohttp.Response.t * Cohttp_lwt.Body.t) Lwt.tSource
val redirect :
?headers:Cohttp.Header.t ->
string ->
(Cohttp.Response.t * Cohttp_lwt__.Body.t) Lwt.tSource
val register :
server ->
(string * Yurt_route.route * Yurt_request_ctx.endpoint) list ->
serverSets a route for a compiled regex + endpoint function
Register a single route
Source
val register_route :
server ->
string ->
Yurt_route.route ->
Yurt_request_ctx.endpoint ->
serverRegister a single route
Source
val register_static_file_route :
?headers:Cohttp.Header.t ->
server ->
string ->
string ->
serverRegister a route for a directory
Source
val register_single_file_route :
?headers:Cohttp.Header.t ->
server ->
string ->
string ->
serverRegister a route for single file