Module `Ocsigen.Request`

type t

type content_type = (string * string) * (string * string) list

type file_info = Multipart.file_info = {

tmp_filename : string;
filesize : int64;
raw_original_filename : string;
file_content_type : content_type option;

}

type post_data = (string * string) list * (string * file_info) list

type client_conn = [

| `Inet of Ipaddr.t * int
| `Unix of string
| `Forwarded_for of string
| `Unknown

]

Type of connection used by the client. `Inet means the client connected through the Internet. `Forwarded_for means that the client connected through a proxy and carries the IP address reported in the HTTP headers.

val make : 
  ?forward_ip:string list ->
  ?sub_path:string ->
  ?original_full_path:string ->
  ?request_cache:Polytables.t ->
  ?cookies_override:string Ocsigen_cookie_map.Map_inner.t ->
  address:Config.Socket_type.t ->
  port:int ->
  ssl:bool ->
  filenames:string list Stdlib.ref ->
  client_conn:client_conn ->
  body:Cohttp_lwt.Body.t ->
  connection_closed:unit Lwt.t ->
  Cohttp.Request.t ->
  t

val update : 
  ?ssl:bool ->
  ?forward_ip:string list ->
  ?client_conn:client_conn ->
  ?sub_path:string ->
  ?meth:Cohttp.Code.meth ->
  ?get_params_flat:(string * string) list ->
  ?post_data:post_data option ->
  ?cookies_override:string Ocsigen_cookie_map.Map_inner.t ->
  ?full_rewrite:bool ->
  ?uri:Uri.t ->
  t ->
  t

val to_cohttp : t -> Cohttp.Request.t

val uri : t -> Uri.t

val body : t -> Cohttp_lwt.Body.t

val address : t -> Config.Socket_type.t

val host : t -> string option

val meth : t -> Cohttp.Code.meth

val port : t -> int

val ssl : t -> bool

val version : t -> Cohttp.Code.version

val query : t -> string option

val get_params : t -> (string * string list) list

val get_params_flat : t -> (string * string) list

val path : t -> string list

val path_string : t -> string

val sub_path : t -> string list

val sub_path_string : t -> string

val original_full_path : t -> string list

val original_full_path_string : t -> string

val header : t -> Ocsigen_http.Header.Name.t -> string option

val header_multi : t -> Ocsigen_http.Header.Name.t -> string list

val add_header : t -> Ocsigen_http.Header.Name.t -> string -> t

val cookies : t -> string Ocsigen_cookie_map.Map_inner.t

val files : 
  t ->
  string option ->
  Stdlib.Int64.t option ->
  (string * file_info) list Lwt.t option

val post_params : 
  t ->
  string option ->
  Stdlib.Int64.t option ->
  (string * string) list Lwt.t option

val client_conn : t -> client_conn

The way the client connects to the server (for example, its IP address if connected over the internet).

val client_conn_to_string : t -> string

A textual representation of client_conn suitable for use in logs.

val client_ip_to_string : t -> string

The bare client IP address (no scheme prefix), suitable for the %h field of a Common/Combined access-log line. Returns "-" when the address is unknown.

val set_remote_user : t -> string -> unit

set_remote_user r user records the name of the user authenticated for this request (typically by Authbasic). It is stored in the request cache and reported as the %u field of the access log.

val remote_user : t -> string option

The user authenticated for this request, if any. See set_remote_user.

val forward_ip : t -> string list

val content_type : t -> content_type option

val request_cache : t -> Polytables.t

val tries : t -> int

val incr_tries : t -> unit

val connection_closed : t -> unit Lwt.t

val timeofday : t -> float