Module `Dream_h2.Reqd`Source

Sourcemodule Hpack = Dream_hpack.Hpack

Sourcemodule Httpaf = Dream_httpaf_.Httpaf

Sourcemodule Writer = Serialize.Writer

Sourcetype error = [

| `Bad_request
| `Internal_server_error
| `Exn of exn

]

type error_handler =
  ?request:Request.t ->
  error ->
  (Headers.t -> Body.Writer.t) ->
  unit

Sourcetype response_state =

| Waiting
| Fixed of {
1. response : Response.t;
2. mutable iovec : [ `String of string | `Bigstring of Bigstringaf.t ] Httpaf.IOVec.t;
}
| Streaming of {
1. response : Response.t;
2. response_body : Body.Writer.t;
3. trailers : Headers.t;
}
| Complete of Response.t

Sourcetype request_info = {

request : Request.t;
request_body : Body.Reader.t;
mutable request_body_bytes : int64;

}

Sourcetype active_state = (request_info, request_info) Stream.active_state

Sourcetype active_stream = {

body_buffer_size : int;
encoder : Hpack.Encoder.t;
mutable response_state : response_state;
mutable trailers_parser : Stream.partial_headers option;
mutable trailers : Headers.t option;
create_push_stream : Stream_identifier.t -> (t, [ `Push_disabled | `Stream_ids_exhausted ]) result;

}

Source

and state =
  (active_state, active_stream, request_info * active_stream) Stream.state

Sourceand t = (state, error, error_handler) Stream.t

Sourceval create_active_request : Request.t -> Body.Reader.t -> request_info

Source

val 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

Source

val send_fixed_response : 
  t ->
  active_stream ->
  Response.t ->
  [< `Bigstring of Bigstringaf.t | `String of string ] ->
  unit

Sourceval schedule_trailers : t -> Headers.t -> unit

Source

val 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

Source

val send_streaming_response : 
  flush_headers_immediately:bool ->
  t ->
  active_stream ->
  Response.t ->
  Body.Writer.t

Source

val unsafe_respond_with_streaming : 
  t ->
  flush_headers_immediately:bool ->
  Response.t ->
  Body.Writer.t

Source

val respond_with_streaming : 
  t ->
  ?flush_headers_immediately:bool ->
  Response.t ->
  Body.Writer.t

Source

val start_push_stream : 
  t ->
  active_stream ->
  Request.t ->
  (t, [ `Push_disabled | `Stream_cant_push | `Stream_ids_exhausted ]) result

Source

val unsafe_push : 
  t ->
  Request.t ->
  (t, [ `Push_disabled | `Stream_cant_push | `Stream_ids_exhausted ]) result

Source

val push : 
  t ->
  Request.t ->
  (t, [ `Push_disabled | `Stream_cant_push | `Stream_ids_exhausted ]) result

Source

val _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

Source

val 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

Source

val 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

Install

dune-project
Dependency

Authors

Maintainers

Sources

doc/dream-httpaf.dream-h2/Dream_h2/Reqd/index.html

Module `Dream_h2.Reqd`Source

package dream-httpaf

Install

dune-project Dependency

Authors

Maintainers

Sources

doc/dream-httpaf.dream-h2/Dream_h2/Reqd/index.html

Module Dream_h2.ReqdSource

dune-project
Dependency

Module `Dream_h2.Reqd`Source