forked from mirage/ocaml-cohttp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
cohttp_lwt_unix.mli
154 lines (124 loc) · 4.61 KB
/
cohttp_lwt_unix.mli
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
(*
* Copyright (c) 2012 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.
*
*)
open Cohttp
module Body : sig
type contents
type t = contents option
val string_of_body : t -> string Lwt.t
val stream_of_body : t -> string Lwt_stream.t
val create_stream : ('a -> Cohttp.Transfer.chunk Lwt.t) -> 'a -> string Lwt_stream.t
val body_of_string : string -> t
val body_of_string_list : string list -> t
val body_of_stream : string Lwt_stream.t -> t
val get_length : t -> (int * t) Lwt.t
val write_body : (string -> unit Lwt.t) -> t -> unit Lwt.t
end
module Request : sig
type t
val meth : t -> Code.meth
val uri : t -> Uri.t
val version : t -> Code.version
val path : t -> string
val header : t -> string -> string option
val headers : t -> Header.t
val params : t -> (string * string) list
val transfer_encoding : t -> string
val make : ?meth:Code.meth -> ?version:Code.version ->
?encoding:Transfer.encoding -> ?headers:Header.t ->
?body:Body.contents -> Uri.t -> t
val is_form: t -> bool
val read : Lwt_io.input_channel -> t option Lwt.t
val read_form : t -> Lwt_io.input_channel -> (string * string) list Lwt.t
val read_body : t -> Lwt_io.input_channel -> Cohttp.Transfer.chunk Lwt.t
val write : (t -> Lwt_io.output_channel -> unit Lwt.t) -> t -> Lwt_io.output_channel -> unit Lwt.t
val write_body : t -> Lwt_io.output_channel -> string -> unit Lwt.t
end
module Response : sig
type t
val version : t -> Code.version
val status : t -> Code.status_code
val headers: t -> Header.t
val make : ?version:Code.version -> ?status:Code.status_code ->
?encoding:Transfer.encoding -> ?headers:Header.t -> unit -> t
val is_form: t -> bool
val read : Lwt_io.input_channel -> t option Lwt.t
val read_body : t -> Lwt_io.input_channel -> Cohttp.Transfer.chunk Lwt.t
val write : (t -> Lwt_io.output_channel -> unit Lwt.t) -> t -> Lwt_io.output_channel -> unit Lwt.t
val write_body : t -> Lwt_io.output_channel -> string -> unit Lwt.t
end
module Client : sig
val call :
?headers:Cohttp.Header.t ->
?body:Body.contents ->
?chunked:bool ->
Cohttp.Code.meth ->
Uri.t -> (Response.t * Body.t) option Lwt.t
val head :
?headers:Cohttp.Header.t ->
Uri.t -> (Response.t * Body.t) option Lwt.t
val get :
?headers:Cohttp.Header.t ->
Uri.t -> (Response.t * Body.t) option Lwt.t
val delete :
?headers:Cohttp.Header.t ->
Uri.t -> (Response.t * Body.t) option Lwt.t
val post :
?body:Body.contents ->
?chunked:bool ->
?headers:Cohttp.Header.t ->
Uri.t -> (Response.t * Body.t) option Lwt.t
val put :
?body:Body.contents ->
?chunked:bool ->
?headers:Cohttp.Header.t ->
Uri.t -> (Response.t * Body.t) option Lwt.t
val patch :
?body:Body.contents ->
?chunked:bool ->
?headers:Cohttp.Header.t ->
Uri.t -> (Response.t * Body.t) option Lwt.t
val post_form :
?headers:Cohttp.Header.t ->
params:Cohttp.Header.t ->
Uri.t -> (Response.t * Body.t) option Lwt.t
val callv :
?ssl:bool ->
string ->
int ->
(Request.t * Body.contents option) Lwt_stream.t ->
(Response.t * Body.t) Lwt_stream.t Lwt.t
end
module Server : sig
type conn_id = int
val string_of_conn_id : int -> string
type config = {
callback : conn_id -> ?body:Body.contents -> Request.t -> (Response.t * Body.t) Lwt.t;
conn_closed : conn_id -> unit -> unit;
}
val respond_string :
?headers:Cohttp.Header.t ->
status:Cohttp.Code.status_code ->
body:string -> unit -> (Response.t * Body.t) Lwt.t
val respond_error :
status:Cohttp.Code.status_code ->
body:string -> unit -> (Response.t * Body.t) Lwt.t
val respond_not_found :
uri:Uri.t -> unit -> (Response.t * Body.t) Lwt.t
val callback :
config -> Lwt_io.input_channel -> Lwt_io.output_channel -> unit Lwt.t
end
val server : ?timeout:int -> address:string -> port:int -> Server.config -> unit Lwt.t