package dream-httpaf

  1. Overview
  2. Docs
Internal: shared http/af stack for Dream (server) and Hyper (client)

Install

Dune Dependency

Authors

Maintainers

Sources

dream-1.0.0-alpha5.tar.gz
sha256=05bc7f6aff94893c151f3a5bcdee3328920c69b3763fac49ba27348dc7745901
md5=de6f6908ae899c9e85f2c751a0263932

doc/src/dream-httpaf.dream-websocketaf/wsd.ml.html

Source file wsd.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
module Httpaf = Dream_httpaf_.Httpaf

module IOVec = Httpaf.IOVec

type error = [ `Exn of exn ]

type mode =
  [ `Client of unit -> int32
  | `Server
  ]

type t =
  { faraday : Faraday.t
  ; mutable bytes_sent : int
  ; mode : mode
  ; mutable wakeup : Optional_thunk.t
  ; error_handler: error_handler
  ; mutable error_code: [`Ok | error ]
  }
and error_handler = t -> error -> unit

let default_ready_to_write = Sys.opaque_identity (fun () -> ())

let create ~error_handler mode =
  { faraday = Faraday.create 0x1000
  ; bytes_sent = 0
  ; mode
  ; wakeup = Optional_thunk.none
  ; error_handler
  ; error_code = `Ok
  }

let mask t =
  match t.mode with
  | `Client m -> Some (m ())
  | `Server -> None

let is_closed t =
  Faraday.is_closed t.faraday

let on_wakeup t k =
  if Faraday.is_closed t.faraday
  then failwith "on_wakeup on closed writer"
  else if Optional_thunk.is_some t.wakeup
  then failwith "on_wakeup: only one callback can be registered at a time"
  else t.wakeup <- Optional_thunk.some k

let wakeup t =
  let f = t.wakeup in
  t.wakeup <- Optional_thunk.none;
  Optional_thunk.call_if_some f

let schedule t ~kind payload ~off ~len =
  let mask = mask t in
  Serialize.schedule_serialize
    t.faraday
    (* TODO: is_fin *)
    ?mask
    ~is_fin:true
    ~opcode:(kind :> Websocket.Opcode.t)
    ~src_off:t.bytes_sent
    ~payload ~off ~len;
  t.bytes_sent <- t.bytes_sent + len;
  wakeup t

let send_bytes t ~kind payload ~off ~len =
  let mask = mask t in
  Serialize.serialize_bytes
    t.faraday
    ?mask
    ~is_fin:true
    ~opcode:(kind :> Websocket.Opcode.t)
    ~payload
    ~src_off:t.bytes_sent
    ~off
    ~len;
  t.bytes_sent <- t.bytes_sent + len;
  wakeup t

let send_ping t =
  Serialize.serialize_control t.faraday ~opcode:`Ping;
  wakeup t

let send_pong t =
  Serialize.serialize_control t.faraday ~opcode:`Pong;
  wakeup t

let flushed t f = Faraday.flush t.faraday f

let close ?code t =
  begin match code with
  | Some code ->
    let mask = mask t in
    let payload = Bytes.create 2 in
    Bytes.set_uint16_be payload 0 (Websocket.Close_code.to_int code);
    Serialize.serialize_bytes t.faraday
      ?mask
      ~is_fin:true
      ~opcode:`Connection_close
      ~src_off:t.bytes_sent
      ~payload ~off:0 ~len:2;
      t.bytes_sent <- t.bytes_sent + 2;
  | None -> ()
  end;
  Faraday.close t.faraday;
  wakeup t

let error_code t =
  match t.error_code with
  | #error as error -> Some error
  | `Ok             -> None

let report_error t error =
  match t.error_code with
  | `Ok ->
    t.error_code <- (error :> [`Ok | error]);
    if not (is_closed t)
    then t.error_handler t error
  | `Exn _exn ->
    close ~code:`Abnormal_closure t

let next t =
  match Faraday.operation t.faraday with
  | `Close         -> `Close 0 (* XXX(andreas): should track unwritten bytes *)
  | `Yield         -> `Yield
  | `Writev iovecs -> `Write iovecs

let report_result t result =
  match result with
  | `Closed -> close t
  | `Ok len -> Faraday.shift t.faraday len
OCaml

Innovation. Community. Security.