package websocketml

You can search for identifiers within the package.

in-package search v0.2.0

package websocketml

websocketml
- Base64
- Http
  - FieldMap
- Logger
  - EscCodes
- Sha1
- Utils
- Websocketml
  - Http
  - Logger
- Ws

Legend:
Library
Module
Module type
Parameter
Class
Class type

exception WSError of string

exception NotImplemented of string

type opcode =

| ContinuationFrame
| TextFrame
| BinaryFrame
| Close
| Ping
| Pong
| ControlFrame of int
| NonControlFrame of int

val int_of_opcode : opcode -> int

val opcode_of_int : int -> opcode

val string_of_opcode : opcode -> string

val is_controlop : opcode -> bool

type exit_code =

| NormalClosure
| GoingAway
| ProtocolError
| UnkownDatatype
| NoStatusCode
| AbnormalClosure
| InconsistentData
| PolicyViolation
| MsgTooBig
| RequiredExtension
| UnexpectedCondition
| TLSFailure
| ReservedCode of int
| CustomCode of int

val reserved_exit_code : exit_code -> bool

val int_of_exit_code : exit_code -> int

val exit_code_of_int : int -> exit_code

type frame = {

fin : bool;
opcode : opcode;
frame_data : bytes;

}

type msg_type =

| BinaryMsg
| TextMsg

type msg = {

msg_typ : msg_type;
msg_data : bytes;

}

type client = {

addr : Unix.sockaddr;
sock : Unix.file_descr;

}

val string_of_client : client -> string

type t = {

client : client;
mutable closed_out : bool;
mutable closed_in : bool;

}

val to_string : t -> string

val print_t : out_channel -> t -> unit

val warn : exn -> unit

val create : (Unix.file_descr * Unix.sockaddr) -> t

val get_sock : t -> Unix.file_descr

val get_addr : t -> Unix.sockaddr

val closed_out : t -> bool

val closed_in : t -> bool

val closed : t -> bool

val recv_bytes : t -> bytes -> int -> int -> int

val send_bytes : t -> bytes -> int

val build_frame : opcode -> bytes -> bytes

val build_msg : opcode -> bytes -> bytes

val send_msg : t -> opcode -> bytes -> int

val send_ping : t -> bytes -> int

val send_pong : t -> bytes -> int

val send_close : t -> bytes -> int

val send_text : t -> string -> int

val send_binary : t -> bytes -> int

val close_with_message : t -> exit_code -> string -> int

val close : t -> exit_code -> int

val do_close : t -> frame -> int

val receive_frame : t -> frame

val receive_message : t -> msg option