Ocsigen

Reference manual

Version 0.99.5

Index

Lwt
Eliom
Main modules
Pages with Ocamlduce
XHTML pages typed with variants
Other pages
Creating new kinds of pages
Ocsigen

This is a preliminary version of the documentation. Help us to improve it by filling tickets. We are looking for native english speakers to proof read the documentation. Contact us!

sig
  exception Connection_closed
  exception Lost_connection of exn
  exception Timeout
  exception Keepalive_timeout
  exception Aborted
  type mode = Answer | Query | Nofirstline
  type connection
  val create_receiver :
    int -> Http_com.mode -> Lwt_ssl.socket -> Http_com.connection
  val lock_receiver : Http_com.connection -> unit Lwt.t
  val unlock_receiver : Http_com.connection -> unit
  val awake_next_request : Http_com.connection -> unit
  val block_next_request : Http_com.connection -> unit Lwt.t
  val get_http_frame :
    ?head:bool -> Http_com.connection -> Http_frame.t Lwt.t
  val connection_id : Http_com.connection -> int
  val connection_fd : Http_com.connection -> Lwt_ssl.socket
  type slot
  val start_processing :
    Http_com.connection -> (Http_com.slot -> unit Lwt.t) -> unit
  val wait_all_senders : Http_com.connection -> unit Lwt.t
  val write_stream :
    ?chunked:bool ->
    Lwt_chan.out_channel -> string Ocsistream.t -> unit Lwt.t
  type sender_type
  val create_sender :
    ?server_name:string ->
    ?headers:Http_headers.t ->
    ?proto:Http_frame.Http_header.proto -> unit -> Http_com.sender_type
  val default_sender : Http_com.sender_type
  val send :
    ?reopen:(unit -> unit Lwt.t) ->
    Http_com.slot ->
    clientproto:Http_frame.Http_header.proto ->
    ?mode:Http_frame.Http_header.http_mode ->
    ?proto:Http_frame.Http_header.proto ->
    keep_alive:bool ->
    head:bool ->
    sender:Http_com.sender_type -> Http_frame.result -> unit Lwt.t
  val abort : Http_com.connection -> unit
end