File: README.md

package info (click to toggle)
ocaml-websocket 2.17-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 288 kB
  • sloc: ml: 1,611; makefile: 7
file content (27 lines) | stat: -rw-r--r-- 966 bytes parent folder | download
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
ocaml-websocket — Websocket library for OCaml
---------------------------------------------

The WebSocket Protocol enables two-way communication between a client
running untrusted code in a controlled environment to a remote host
that has opted-in to communications from that code.

The security model used for this is the origin-based security model
commonly used by web browsers. The protocol consists of an opening
handshake followed by basic message framing, layered over TCP.

The goal of this technology is to provide a mechanism for
browser-based applications that need two-way communication with
servers that does not rely on opening multiple HTTP connections (e.g.,
using XMLHttpRequest or <iframe>s and long polling).

## Installation

ocaml-websocket can be installed with `opam`:

```
opam install websocket
```

If you don't use `opam` please consult the `websocket.opam`,
`websocket-lwt.opam` and `websocket-async.opam` files for build
instructions.