package httpun-ws

You can search for identifiers within the package.

in-package search v0.2.0

package httpun-ws

httpun-ws
- CHANGES
- README
- Library httpun-ws
  - Httpun_ws
    
    IOVec
    
    Payload
    
    Websocket
    
    Opcode
    
    Close_code
    
    Wsd
    
    Handshake
    
    Websocket_connection
    
    Client_connection
    
    Server_connection
- Sources
  - httpun-ws
    
    client_connection.ml
    
    client_handshake.ml
    
    handshake.ml
    
    httpun_ws.ml
    
    httpun_ws__.ml
    
    optional_thunk.ml
    
    parse.ml
    
    payload.ml
    
    serialize.ml
    
    server_connection.ml
    
    websocket.ml
    
    websocket_connection.ml
    
    wsd.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Httpun_ws.Wsd`Source

Sourcetype mode = [

| `Client of unit -> int32
| `Server

]

Sourcetype t

Source

val schedule : 
  t ->
  ?is_fin:bool ->
  kind:[ `Text | `Binary | `Continuation ] ->
  Bigstringaf.t ->
  off:int ->
  len:int ->
  unit

is_fin defaults to true. Set to `false` if sending multiple frames, except on the last one. NOTE: this function mutates the bigarray on clients due to the WebSocket protocol masking requirements.

Source

val send_bytes : 
  t ->
  ?is_fin:bool ->
  kind:[ `Text | `Binary | `Continuation ] ->
  Bytes.t ->
  off:int ->
  len:int ->
  unit

is_fin defaults to true. Set to `false` if sending multiple frames, except on the last one. NOTE: this function mutates the `bytes` argument on clients due to the WebSocket protocol masking requirements.

Sourceval send_ping : ?application_data:Bigstringaf.t IOVec.t -> t -> unit

Sourceval send_pong : ?application_data:Bigstringaf.t IOVec.t -> t -> unit

Sourceval flushed : t -> (unit -> unit) -> unit

Sourceval close : ?code:Websocket.Close_code.t -> t -> unit

Sourceval is_closed : t -> bool

Sourceval error_code : t -> [> `Exn of exn ] option

package httpun-ws

Module Httpun_ws.WsdSource

Module `Httpun_ws.Wsd`Source