Skip to content

Commit e988fa3

Browse files
committed
Release notes update for 1.7.0 in progress.
1 parent c2a8755 commit e988fa3

File tree

1 file changed

+44
-17
lines changed

1 file changed

+44
-17
lines changed

RELEASE_NOTES.adoc

Lines changed: 44 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@ ifdef::env-github[]
33
:important-caption: :heavy_exclamation_mark:
44
endif::[]
55

6-
= RELEASE NOTES FOR NNG v1.6.0
7-
8-
After a very long time indeed (over 2 years!), we are happy to announce v1.6.0 of NNG!
6+
= RELEASE NOTES FOR NNG v1.7.0 (DRAFT/IN PROGRESS)
97

108
This document has the following sections:
119

@@ -14,29 +12,57 @@ This document has the following sections:
1412

1513
== Notable Changes (since 1.5.2)
1614

17-
Numerous critical bugs were fixed; some of these led to seg faults, crashes, and
18-
memory leaks. See bugs #1523, #1713, #1702, #1657, #1347, #1518, #1526, #1541, #1638, #1543, #1657, #1658
19-
20-
Significant performance optimizations have been made, especially to the BUS protocol, the
21-
`nng_sendmsg()` and `nng_recvmsg()` functions, when connecting and disconnecting lots of pipes,
22-
and when using very different expiration times with vast numbers of requests.
23-
24-
New APIs were added for `nng_aio_busy()`, `nng_ctx_sendmsg()`, `nng_ctx_recvmsg()`, `nng_device_aio()`.
25-
26-
A CMake tunable for limiting the number of threads use for request expiration is provided
27-
via the `NNG_MAX_EXPIRE_THREADS` option.
15+
A new compile time setting, `NNG_MAX_POLLER_THREADS` is introduced,
16+
with a default value of 8. Will limit the number number of threads
17+
used for pollers that are multi-threaded (currently only Windows).
18+
Additionally for single core systems only two threads will be started
19+
instead of four.
20+
21+
A new supplemental API, nng_id_map(3), is made available.
22+
This exposes the
23+
internal ID hash API NNG uses mapping integer IDs (like socket IDs)
24+
to data structures. It also brings back support for 64-bit IDs.
25+
See bug #1740.
26+
27+
Setting the `NNG_OPT_RECVMAXSZ` setting no longer affects pipes
28+
that are already established. The old behavior was undocumented
29+
and racy. Please set this setting before starting any listeners
30+
or dialers.
31+
32+
A new transport (experimental), for `socket://` is available.
33+
This allows one to create a connection using sockets created
34+
with `socketpair()` (or the new `nng_socket_pair()` supplemental API),
35+
which can help use cases where file descriptors are passed between
36+
processes or inherited via `fork()`. This API is only available on
37+
Linux. It does have somewhat different semantics for establishing
38+
the connection, so please see the manual page for `nng_socket(5)` for more information.
39+
40+
WebSocket close is fixed to conform to RFC 6455, sending the
41+
close frame, and waiting to receive the close frame from the
42+
peer. This allows websocket based connections to ensure that
43+
data messages are fully delivered before shutting down.
44+
See bugs #1733, #1734 and #1735.
45+
Thanks @alawn-wang for the inspiration and a first
46+
draft of the change.
47+
48+
The REQ and SURVEYOR protocols were fixed to improve scalability
49+
when many clients or many contexts are used. As part of this change,
50+
a new option, `NNG_OPT_REQ_RESENDTICK` is available to adjust how
51+
often we check for expired requests.
52+
53+
Various minor documentation fixes were made, some contributed by
54+
Patrik Wenger <patrik.wenger@mindclue.ch>.
2855

29-
Additionally various fixes for compilation problems, documentation errata, test case, and so forth
30-
have been applied.
3156

3257
== End of Feature Announcements
3358

3459
=== Windows Legacy Support
3560

61+
As announced in 1.6.0,
3662
NNG no longer officially claims support for Windows Vista, Windows 7, Windows 8, or Windows 8.1.
3763
We have no ability to build or test these versions, and Microsoft no longer supports them.
3864
Continued use of these systems may be possible, but future changes may break
39-
compatibity with these systems wihout further notice.
65+
compatibility with these systems without further notice.
4066

4167
=== Windows Named Pipe Support Changes
4268

@@ -47,6 +73,7 @@ Should this occur, it will be breaking for Windows versions older than Windows 1
4773

4874
=== macOS Legacy Support
4975

76+
As announced in 1.6.0,
5077
NNG no longer officially supports macOS versions older than 10.12.
5178
Future versions of NNG may depend on features not available on versions of macOS older than 10.12.
5279

0 commit comments

Comments
 (0)