package async_websocket

  1. Overview
  2. Docs
A library that implements the websocket protocol on top of Async

Install 

dune-project
 Dependency

github.com Changelog MIT License Edit opam file Versions (6)

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

v0.17.0.tar.gz
sha256=ddb4eb48a4440b39171a11dcf1dcd9369c4e4a0ababefb330ffe2c0d397b301a

doc/async_websocket/Websocket/Frame/index.html

Module Websocket.FrameSource

Sourcetype t = {
  1. opcode : Opcode.t;
  2. final : bool;
  3. content : string;
}
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
include Ppx_quickcheck_runtime.Quickcheckable.S with type t := t
Sourceval quickcheck_generator : t Base_quickcheck.Generator.t
Sourceval quickcheck_observer : t Base_quickcheck.Observer.t
Sourceval quickcheck_shrinker : t Base_quickcheck.Shrinker.t
include Ppx_compare_lib.Equal.S with type t := t
Sourceval equal : t -> t -> bool
Sourcemodule Error : sig ... end
Sourceval write_frame : masked:bool -> Async.Writer.t -> t -> unit
Sourceval create : opcode:Opcode.t -> ?final:bool -> string -> t
Sourceval create_close : code:int -> ?final:bool -> string -> t
Sourceval frame_bytes : content_len:int -> masked:bool -> int

frame_bytes calculates how many bytes a websocket frame would consume.

Sourceval max_content_bytes : max_frame_bytes:int -> masked:bool -> int

max_content_bytes calculates the most content that can be contained in the payload of a frame with up to max_frame_bytes.

Sourcemodule Iobuf_writer : sig ... end
Sourcemodule Frame_reader : sig ... end