package httpun-ws

You can search for identifiers within the package.

in-package search v0.2.0

package httpun-ws

httpun-ws
- Httpun_ws

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

type error = [

| Httpun.Client_connection.error
| `Handshake_failure of Httpun.Response.t * Httpun.Body.Reader.t

]

val connect : 
  nonce:string ->
  ?headers:Httpun.Headers.t ->
  sha1:(string -> string) ->
  error_handler:(error -> unit) ->
  websocket_handler:(Wsd.t -> Websocket_connection.input_handlers) ->
  string ->
  t

val create : (Wsd.t -> Websocket_connection.input_handlers) -> t

val next_read_operation : t -> [ `Read | `Yield | `Close ]

val next_write_operation : 
  t ->
  [ `Write of Bigstringaf.t IOVec.t list | `Yield | `Close of int ]

val read : t -> Bigstringaf.t -> off:int -> len:int -> int

val read_eof : t -> Bigstringaf.t -> off:int -> len:int -> int

val yield_reader : t -> (unit -> unit) -> unit

val report_write_result : t -> [ `Ok of int | `Closed ] -> unit

val yield_writer : t -> (unit -> unit) -> unit

val report_exn : t -> exn -> unit

val is_closed : t -> bool

val shutdown : t -> unit