Module Nethttpd_kernel

module Nethttpd_kernel: sig .. end

The protocol kernel of the HTTP daemon

This module mainly defines the http_protocol class which implements the exchange of messages with a HTTP client. The request messages are represented as sequence of req_token values. The response is encapsulated in a separate http_response class. The contents of the response are represented as sequence of resp_token values.

type fatal_error = [ `Broken_pipe
| `Message_too_long
| `Server_error
| `Timeout
| `Unix_error of Unix.error ]
These are the serious protocol violations after that the daemon stops any further processing.

Note that `Timeout refers to a timeout in the middle of a request.

Long messages are fatal because it is suspected that they are denial of service attacks. The kernel generates `Message_too_long only for long headers, not for long bodies.

Fatal server errors can happen when exceptions are not properly handled. As last resort the HTTP daemon closes the connection without notifying the client.

val string_of_fatal_error : fatal_error -> string
Convert error to a string, for logging
type bad_request_error = [ `Bad_header
| `Bad_header_field of string
| `Bad_request_line
| `Bad_trailer
| `Format_error of string
| `Protocol_not_supported
| `Request_line_too_long
| `Unexpected_eof ]
A bad request is a violation where the current request cannot be decoded, and it is not possible to accept further requests over the current connection.
val string_of_bad_request_error : bad_request_error -> string
Convert error to a string, for logging
val status_of_bad_request_error : bad_request_error -> Nethttp.http_status
Returns the best response code for the error
type data_chunk = string * int * int 
A data_chunk is a substring of a string. The substring is described by the triple (s, pos, len) where s is the container, pos is the position where the substring begins, and len its length.
type status_line = int * string 
= (code, phrase)
type transfer_coding = [ `Chunked | `Identity ] 
type resp_token = [ `Resp_action of unit -> unit
| `Resp_body of data_chunk
| `Resp_end
| `Resp_header of Nethttp.http_header
| `Resp_info_line of status_line * Nethttp.http_header
| `Resp_status_line of status_line
| `Resp_trailer of Nethttp.http_trailer ]
The resp_token represents a textual part of the response to send:
val resp_100_continue : resp_token
The predefined token for the "100 Continue" response
type resp_state = [ `Active | `Dropped | `Error | `Inhibited | `Processed | `Queued ] 
The response state:
type front_token = [ `Resp_end | `Resp_wire_data of data_chunk ] 
Tokens generated by http_response:
exception Send_queue_empty
class type http_response = object .. end
Encapsultation of the HTTP response for a single request
class http_response_impl : ?close:bool -> ?suppress_body:bool -> Nethttp.protocol -> http_response
Exported for debugging and testing only
val send_static_response : http_response ->
Nethttp.http_status -> Nethttp.http_header option -> string -> unit
Sends the string argument as response body, together with the given status and the header (optional). Response header fields are set as follows:
val send_file_response : http_response ->
Nethttp.http_status ->
Nethttp.http_header option -> Unix.file_descr -> int64 -> unit
Sends the contents of a file as response body, together with the given status and the header (optional). The descriptor must be a file descriptor (that cannot block). The int64 number is the length of the body. Response header fields are set as follows: Note that Content-Range is not set automatically, even if the file is only partially transferred.

The function does not send the file immediately, but rather sets the http_response object up that the next chunk of the file is added when the send queue becomes empty. This file will be closed when the transfer is done.

type request_line = Nethttp.http_method * Nethttp.protocol 
The method (including the URI), and the HTTP version
type req_token = [ `Bad_request_error of
bad_request_error * http_response
| `Eof
| `Fatal_error of fatal_error
| `Req_body of data_chunk
| `Req_end
| `Req_expect_100_continue
| `Req_header of
request_line * Nethttp.http_header *
| `Req_trailer of Nethttp.http_trailer
| `Timeout ]
A req_token represents a textual part of the received request: Note that it is always allowed to send tokens to the client. The protocol implementation takes care that the response is transmitted at the right point in time.
exception Recv_queue_empty
class type http_protocol_config = object .. end
Configuration values for the HTTP kernel
class http_protocol : #http_protocol_config -> Unix.file_descr -> object .. end
The core event loop of the HTTP daemon
class lingering_close : Unix.file_descr -> object .. end
Closes a file descriptor using the "lingering close" algorithm.