package dream-httpaf

  1. Overview
  2. Docs
package dream-httpaf
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Dream_h2.ReqdSource

Sourcemodule Writer = Serialize.Writer
Sourcetype error = [
  1. | `Bad_request
  2. | `Internal_server_error
  3. | `Exn of exn
]
Sourcetype error_handler = ?request:Request.t -> error -> (Headers.t -> Body.Writer.t) -> unit
Sourcetype response_state =
  1. | Waiting
  2. | Fixed of {
    1. response : Response.t;
    2. mutable iovec : [ `String of string | `Bigstring of Bigstringaf.t ] Httpaf.IOVec.t;
    }
  3. | Streaming of {
    1. response : Response.t;
    2. response_body : Body.Writer.t;
    3. trailers : Headers.t;
    }
  4. | Complete of Response.t
Sourcetype request_info = {
  1. request : Request.t;
  2. request_body : Body.Reader.t;
  3. mutable request_body_bytes : int64;
}
Sourcetype active_stream = {
  1. body_buffer_size : int;
  2. encoder : Hpack.Encoder.t;
  3. mutable response_state : response_state;
  4. mutable trailers_parser : Stream.partial_headers option;
  5. mutable trailers : Headers.t option;
  6. create_push_stream : Stream_identifier.t -> (t, [ `Push_disabled | `Stream_ids_exhausted ]) result;
}
Sourceval create_active_request : Request.t -> Body.Reader.t -> request_info
Sourceval create_active_stream : Hpack.Encoder.t -> int -> (Stream_identifier.t -> (t, [ `Push_disabled | `Stream_ids_exhausted ]) result) -> active_stream
Sourceval request : t -> Request.t
Sourceval request_body : t -> Body.Reader.t
Sourceval response : t -> Response.t option
Sourceval response_exn : t -> Response.t
Sourceval send_fixed_response : t -> active_stream -> Response.t -> [< `Bigstring of Bigstringaf.t | `String of string ] -> unit
Sourceval schedule_trailers : t -> Headers.t -> unit
Sourceval unsafe_respond_with_data : t -> Response.t -> [< `Bigstring of Bigstringaf.t | `String of string ] -> unit
Sourceval respond_with_string : t -> Response.t -> string -> unit
Sourceval respond_with_bigstring : t -> Response.t -> Bigstringaf.t -> unit
Sourceval send_streaming_response : flush_headers_immediately:bool -> t -> active_stream -> Response.t -> Body.Writer.t
Sourceval unsafe_respond_with_streaming : t -> flush_headers_immediately:bool -> Response.t -> Body.Writer.t
Sourceval respond_with_streaming : t -> ?flush_headers_immediately:bool -> Response.t -> Body.Writer.t
Sourceval start_push_stream : t -> active_stream -> Request.t -> (t, [ `Push_disabled | `Stream_cant_push | `Stream_ids_exhausted ]) result
Sourceval unsafe_push : t -> Request.t -> (t, [ `Push_disabled | `Stream_cant_push | `Stream_ids_exhausted ]) result
Sourceval push : t -> Request.t -> (t, [ `Push_disabled | `Stream_cant_push | `Stream_ids_exhausted ]) result
Sourceval _report_error : ?request:Request.t -> t -> active_stream -> error -> Error_code.t -> unit
Sourceval report_error : t -> error -> Error_code.t -> unit
Sourceval report_exn : t -> exn -> unit
Sourceval try_with : t -> (unit -> 'a) -> (unit, exn) result
Sourceval error_code : ((('a, 'b) Stream.active_state, 'c, 'd) Stream.state, [> `Exn of exn ] as 'e, 'f) Stream.t -> 'e option
Sourceval requires_output : t -> bool
Sourceval flush_request_body : t -> unit
Sourceval write_buffer_data : Writer.t -> off:int -> len:int -> Dream_h2__Serialize.frame_info -> [< `Bigstring of Bigstringaf.t | `String of string ] -> unit
Sourceval close_stream : t -> unit
Sourceval flush_response_body : t -> max_bytes:int -> int
Sourceval deliver_trailer_headers : t -> Headers.t -> unit
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct