Skip to content

Commit c415bd0

Browse files
vbmithrvbmithr
committed
Release 2.12
1 parent b1ae13d commit c415bd0

7 files changed

+218
-124
lines changed

‎.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
_build
22
**/*.merlin
3-
*.install
3+
*.install

‎CHANGES

+129-83
Original file line numberDiff line numberDiff line change
@@ -1,111 +1,157 @@
1-
2.12 ()
2-
* build: switch to `dune`
1+
2.12 (2018-10-01)
2+
-----------------
3+
4+
- build: switch to `dune`
35

46
2.11 (2017-12-19)
5-
* Lwt: fix compilation for Cohttp_lwt_unix >= 1.0
7+
-----------------
8+
9+
- Lwt: fix compilation for Cohttp_lwt_unix >= 1.0
610

711
2.10 (2017-08-01)
8-
* Build: use jbuilder
9-
* Lwt: add `check_origin` (@zoggy)
10-
* Lwt: add `send_multiple` (@copy)
12+
-----------------
13+
14+
- Build: use jbuilder
15+
- Lwt: add `check_origin` (@zoggy)
16+
- Lwt: add `send_multiple` (@copy)
1117

1218
2.9 (2017-03-20)
13-
* Lwt: rename ?exception_handler to ?on_exn, to match Conduit
14-
* Async: Add ?check_request with the same interface as Lwt backend
15-
* Fix compilation with the dev version of Async
19+
-----------------
20+
21+
- Lwt: rename ?exception_handler to ?on_exn, to match Conduit
22+
- Async: Add ?check_request with the same interface as Lwt backend
23+
- Fix compilation with the dev version of Async
1624

1725
2.8 (2017-03-01)
18-
* drop dependency to ppx_deriving
19-
* bugfix: fix corrupted received frame (@zoggy)
26+
----------------
27+
28+
- drop dependency to ppx_deriving
29+
- bugfix: fix corrupted received frame (@zoggy)
2030

2131
2.7 (2017-02-21)
22-
* new websocket.cohttp package to upgrade to websocket from cohttp (@SimonJF)
23-
* lwt: function `source' now covers all conduit cases
24-
* async: refactoring and fixes
25-
* perf improvement (Avoid generating xor mask if it isn't used) (@copy)
26-
* remove dependency to containers library
27-
* lwt: Add callback to check origin before websocket connection (@copy)
28-
* lwt: Improve error handling in lwt server (@copy)
29-
* async: more efficient logging
32+
----------------
33+
34+
- new websocket.cohttp package to upgrade to websocket from cohttp (@SimonJF)
35+
- lwt: function `source' now covers all conduit cases
36+
- async: refactoring and fixes
37+
- perf improvement (Avoid generating xor mask if it isn't used) (@copy)
38+
- remove dependency to containers library
39+
- lwt: Add callback to check origin before websocket connection (@copy)
40+
- lwt: Improve error handling in lwt server (@copy)
41+
- async: more efficient logging
3042

3143
2.6 (2016-09-17)
32-
* async: client_ez: kill the connection on absence of PONG reply
33-
* async: client_ez: fix PONG watch code
34-
* websocket: use read_exactly (@copy)
44+
----------------
45+
46+
- async: client_ez: kill the connection on absence of PONG reply
47+
- async: client_ez: fix PONG watch code
48+
- websocket: use read_exactly (@copy)
3549

3650
2.5 (2016-08-16)
37-
* async: client_ez: add an ?opcode argument
38-
* lwt: unset async_exception_hook (@copy)
51+
----------------
52+
53+
- async: client_ez: add an ?opcode argument
54+
- lwt: unset async_exception_hook (@copy)
3955

4056
2.4 (2016-07-26)
41-
* bugfix: Handle truncated cohttp stream reads (@kayceesrk)
42-
* cleanup: Async version does not depend on containers anymore
43-
* build: fix META generation, fixing Async-only installation
57+
----------------
58+
59+
- bugfix: Handle truncated cohttp stream reads (@kayceesrk)
60+
- cleanup: Async version does not depend on containers anymore
61+
- build: fix META generation, fixing Async-only installation
4462

4563
2.3 (2016-06-29)
46-
* async: bugfix: fix fd leak that occured when pipes were not closed
47-
* async: log, name as optional args in functions
48-
* lwt server: support from connection upgrade (@lostman)
49-
* bugfix: fix reading int64 encoded frame size
50-
* async server: bugfixes and interface improvement (@copy)
51-
* parametrize random string generation (@j0sh)
52-
* async client: minor improvements
64+
----------------
65+
66+
- async: bugfix: fix fd leak that occured when pipes were not closed
67+
- async: log, name as optional args in functions
68+
- lwt server: support from connection upgrade (@lostman)
69+
- bugfix: fix reading int64 encoded frame size
70+
- async server: bugfixes and interface improvement (@copy)
71+
- parametrize random string generation (@j0sh)
72+
- async client: minor improvements
5373

5474
2.2 (2015-12-23)
55-
* Async backend
56-
* Code refactoring, bugfixes and upgrade to new version of libraries
75+
----------------
76+
77+
- Async backend
78+
- Code refactoring, bugfixes and upgrade to new version of libraries
5779

5880
2.1 (2015-07-07)
59-
* server: Pass in a Cohttp.Request.t instead of Uri.t
60-
* add Websocket_Lwt.{mk_frame_stream,establish_standard_server}
61-
* websocket_lwt.cm{a,xa} now only contains module Websocket_lwt
62-
* Fix upgrade, keepalive issue with Firefox regression
63-
* Websocket_lwt: Use entropy generator
81+
----------------
82+
83+
- server: Pass in a Cohttp.Request.t instead of Uri.t
84+
- add Websocket_Lwt.{mk_frame_stream,establish_standard_server}
85+
- websocket_lwt.cm{a,xa} now only contains module Websocket_lwt
86+
- Fix upgrade, keepalive issue with Firefox regression
87+
- Websocket_lwt: Use entropy generator
6488

6589
2.0.0 (2015-06-18)
66-
* Breaking API change: not Lwt_stream based anymore
67-
* Switch to conduit (TLS)
68-
* Functorisation of common code, new Websocket_lwt module
69-
* More RFC compliance using Autobahn Test Suite
70-
* Bugfixes
90+
------------------
91+
92+
- Breaking API change: not Lwt_stream based anymore
93+
- Switch to conduit (TLS)
94+
- Functorisation of common code, new Websocket_lwt module
95+
- More RFC compliance using Autobahn Test Suite
96+
- Bugfixes
7197

7298
0.9.3 (2015-03-23)
73-
* Support TLS 0.4.0+ API.
99+
------------------
100+
101+
- Support TLS 0.4.0+ API.
74102

75103
0.9.2 (2015-02-10)
76-
* Bugfix: Do not verify result of setsockopt
77-
78-
0.9.1 (2015-01-03):
79-
* safe_string
80-
* fix a critical bug that when handling masked frames
81-
82-
0.9 (2014-08-21):
83-
* Drop support for OCaml < 4
84-
* Replace Cryptokit by Nocrypto
85-
* Replace Lwt_ssl by Tls_lwt for TLS
86-
* Add TLS support for the websocket server
87-
* Replace OASIS by topkg
88-
* Removing camlp4
89-
* Minor interface changes
90-
91-
0.8.2 (2014-06-09):
92-
* [doc] Add a warning in the doc of `establish_server`
93-
* Close frame now contain a status code (TODO: expose it somewhere)
94-
* Fix fd leakages (hopefully the library should not leak any fds anymore)
95-
* Use OASIS' compiled_setup_ml feature
96-
97-
0.8.1 (2014-03-26):
98-
* Upgrade to OASIS 0.4
99-
100-
0.8 (2014-03-26):
101-
* decode connection upgrade header with regex
102-
103-
0.7 (2014-03-02):
104-
* New "extra_headers" optional argument for {open,with}_connection (acm)
105-
* Port to cohttp 0.10.x API (avsm)
106-
107-
0.6 (2013-08-20):
108-
* Added SSL support for the client.
109-
110-
0.5 (2013-05-06):
111-
* First working release.
104+
------------------
105+
106+
- Bugfix: Do not verify result of setsockopt
107+
108+
0.9.1 (2015-01-03)
109+
------------------
110+
111+
- safe_string
112+
- fix a critical bug that when handling masked frames
113+
114+
0.9 (2014-08-21)
115+
----------------
116+
117+
- Drop support for OCaml < 4
118+
- Replace Cryptokit by Nocrypto
119+
- Replace Lwt_ssl by Tls_lwt for TLS
120+
- Add TLS support for the websocket server
121+
- Replace OASIS by topkg
122+
- Removing camlp4
123+
- Minor interface changes
124+
125+
0.8.2 (2014-06-09)
126+
------------------
127+
128+
- [doc] Add a warning in the doc of `establish_server`
129+
- Close frame now contain a status code (TODO: expose it somewhere)
130+
- Fix fd leakages (hopefully the library should not leak any fds anymore)
131+
- Use OASIS' compiled_setup_ml feature
132+
133+
0.8.1 (2014-03-26)
134+
------------------
135+
136+
- Upgrade to OASIS 0.4
137+
138+
0.8 (2014-03-26)
139+
----------------
140+
141+
- decode connection upgrade header with regex
142+
143+
0.7 (2014-03-02)
144+
----------------
145+
146+
- New "extra_headers" optional argument for {open,with}_connection (acm)
147+
- Port to cohttp 0.10.x API (avsm)
148+
149+
0.6 (2013-08-20)
150+
----------------
151+
152+
- Added SSL support for the client.
153+
154+
0.5 (2013-05-06)
155+
----------------
156+
157+
- First working release.

‎README.md

+24-5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,27 @@
1-
# Websocket library for OCaml
1+
ocaml-websocket — Websocket library for OCaml
2+
---------------------------------------------
23

3-
# Installation
4+
The WebSocket Protocol enables two-way communication between a client
5+
running untrusted code in a controlled environment to a remote host
6+
that has opted-in to communications from that code.
47

8+
The security model used for this is the origin-based security model
9+
commonly used by web browsers. The protocol consists of an opening
10+
handshake followed by basic message framing, layered over TCP.
11+
12+
The goal of this technology is to provide a mechanism for
13+
browser-based applications that need two-way communication with
14+
servers that does not rely on opening multiple HTTP connections (e.g.,
15+
using XMLHttpRequest or <iframe>s and long polling).
16+
17+
## Installation
18+
19+
ocaml-websocket can be installed with `opam`:
20+
21+
```
22+
opam install websocket
523
```
6-
make
7-
dune install
8-
```
24+
25+
If you don't use `opam` please consult the `websocket.opam`,
26+
`websocket-lwt.opam` and `websocket-async.opam` files for build
27+
instructions.

‎dune-project

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
(lang dune 1.1)

‎websocket-async.opam

+20-10
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,33 @@
1-
opam-version: "1.2"
1+
opam-version: "2.0"
22
name: "websocket-async"
3-
version: "2.10"
3+
version: "2.12"
44
authors: "Vincent Bernardoff <[email protected]>"
55
maintainer: "Vincent Bernardoff <[email protected]>"
66
homepage: "https://github.com/vbmithr/ocaml-websocket"
77
bug-reports: "https://github.com/vbmithr/ocaml-websocket/issues"
8-
dev-repo: "git://github.com/vbmithr/ocaml-websocket"
9-
10-
available: [
11-
ocaml-version >= "4.02.0"
12-
]
13-
8+
dev-repo: "git+https://github.com/vbmithr/ocaml-websocket"
9+
doc: "https://vbmithr.github.io/ocaml-websocket/doc"
1410
tags: [
1511
"org:mirage"
1612
"org:xapi-project"
1713
]
1814
build: [ "dune" "build" "-j" jobs "-p" name "@install" ]
1915
depends: [
2016
"dune" {build & >= "1.1.1"}
21-
"websocket" {= "2.10"}
22-
"cohttp-async" {>= "0.99.0"}
17+
"websocket" {= "2.12"}
18+
"cohttp-async" {>= "1.1.1"}
2319
]
20+
synopsis: "Websocket library (Async)"
21+
description: """
22+
The WebSocket Protocol enables two-way communication between a client
23+
running untrusted code in a controlled environment to a remote host
24+
that has opted-in to communications from that code.
25+
26+
The security model used for this is the origin-based security model
27+
commonly used by web browsers. The protocol consists of an opening
28+
handshake followed by basic message framing, layered over TCP.
29+
30+
The goal of this technology is to provide a mechanism for
31+
browser-based applications that need two-way communication with
32+
servers that does not rely on opening multiple HTTP connections (e.g.,
33+
using XMLHttpRequest or <iframe>s and long polling)."""

‎websocket-lwt.opam

+22-14
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,36 @@
1-
opam-version: "1.2"
1+
opam-version: "2.0"
22
name: "websocket-lwt"
3-
version: "2.11"
3+
version: "2.12"
44
authors: "Vincent Bernardoff <[email protected]>"
55
maintainer: "Vincent Bernardoff <[email protected]>"
66
homepage: "https://github.com/vbmithr/ocaml-websocket"
77
bug-reports: "https://github.com/vbmithr/ocaml-websocket/issues"
8-
dev-repo: "git://github.com/vbmithr/ocaml-websocket"
9-
10-
available: [
11-
ocaml-version >= "4.02.0"
12-
]
13-
8+
dev-repo: "git+https://github.com/vbmithr/ocaml-websocket"
9+
doc: "https://vbmithr.github.io/ocaml-websocket/doc"
1410
tags: [
1511
"org:mirage"
1612
"org:xapi-project"
1713
]
18-
build: [
19-
"dune" "build" "-j" jobs "-p" name "@install"
20-
]
14+
build: [ "dune" "build" "-j" jobs "-p" name "@install" ]
2115
depends: [
2216
"dune" {build & >= "1.1.1"}
23-
"websocket" {= "2.10"}
17+
"websocket" {= "2.12"}
2418
"ipaddr" {>= "2.8.0"}
2519
"lwt_log" {>= "1.1.0"}
26-
"lwt_ssl" {>= "1.1.0"}
27-
"cohttp-lwt-unix" {>= "1.0.0"}
20+
"lwt_ssl" {>= "1.1.2"}
21+
"cohttp-lwt-unix" {>= "1.0.2"}
2822
]
23+
synopsis: "Websocket library (Lwt)"
24+
description: """
25+
The WebSocket Protocol enables two-way communication between a client
26+
running untrusted code in a controlled environment to a remote host
27+
that has opted-in to communications from that code.
28+
29+
The security model used for this is the origin-based security model
30+
commonly used by web browsers. The protocol consists of an opening
31+
handshake followed by basic message framing, layered over TCP.
32+
33+
The goal of this technology is to provide a mechanism for
34+
browser-based applications that need two-way communication with
35+
servers that does not rely on opening multiple HTTP connections (e.g.,
36+
using XMLHttpRequest or <iframe>s and long polling)."""

0 commit comments

Comments
 (0)