v2.0.0-alpha.1

[gdamore]

Summary

This is the first "alpha" release of 2.0.0. Note that this is very much a work in progress, and stability is not guaranteed.
There will be more breaking changes coming. But to help with early adoption and testing, this is posted.

Reminder: If you want stability or need to use in production, please consider the "stable" branch instead.

The main changes here involve these major areas:

1. New UDP transport
2. Performance enhancements - fewer allocations, fewer locks -- this is an ongoing effort
3. Documentation changing to mdbook
4. Removal of some legacy support and refactoring some others to be less error prone

This version is NOT compatible with NNG 1.x at an API level -- there are breaking changes so please see the migration guide https://github.com/nanomsg/nng/blob/main/docs/ref/migrate/nng1.md.

Known Issues

1. The docs are a work in progress ... its only about halfway through the mdbook conversion so far
2. The optional ZeroTier transport is utterly broken (it likely won't even compile) - plan is to remove it, possibly rewriting it entirely later
3. During tests, it is possible for an occasional object to get leaked (TCP test sometimes leaks a connection object) -- there are races during finalization... note that this is not a "recurring" leak, so its pretty benign.
4. If you call nng_fini to quickly after setting things up, websocket/http may crash with use after free. The workaround right now is to wait a few dozen msec before calling nng_fini (or don't call it at all for a regular application!). This will be fixed by better use of reference counting in the near future.

What's Changed

• Gdamore/udp by @gdamore in Gdamore/udp #1879
• fix broken link to BUILD_TLS by @jan-ruzicka-c in fix broken link to BUILD_TLS #1872
• Fixes Compiler Warnings (Windows) by @shikokuchuo in Fixes Compiler Warnings (Windows) #1877
• posix: add getentropy() based RNG by @gdamore in posix: add getentropy() based RNG #1880
• Gdamore/oldeps by @gdamore in Gdamore/oldeps #1881
• Bump checkout action to v4. by @gdamore in Bump checkout action to v4. #1882
• Actually enable UDP. Also fix some UWYI includes. by @gdamore in Actually enable UDP. Also fix some UWYI includes. #1883
• fix aio test failures on darwin by @gdamore in fix aio test failures on darwin #1884
• Bump codecov to v4 by @gdamore in Bump codecov to v4 #1885
• Missed config option for UDP by @gdamore in Missed config option for UDP #1886
• udp: fix leaks on EP destroy by @gdamore in udp: fix leaks on EP destroy #1887
• UDP: add some statistics by @gdamore in UDP: add some statistics #1889
• Gdamore/udp stats tests by @gdamore in Gdamore/udp stats tests #1891
• UDP: burst testing to improve coverage by @gdamore in UDP: burst testing to improve coverage #1892
• Gdamore/statslock by @gdamore in Gdamore/statslock #1894
• Use const for nng_stat when possible. by @gdamore in Use const for nng_stat when possible. #1895
• remove legacy support for configuration of transport options on socket by @gdamore in remove legacy support for configuration of transport options on socket #1897
• Remove the libnanomsg compatibility layer by @gdamore in Remove the libnanomsg compatibility layer #1898
• Gdamore/tls api by @gdamore in Gdamore/tls api #1899
• Gdamore/stream set gone by @gdamore in Gdamore/stream set gone #1901
• NNI_GETXX macros are brittle due to casting mistake. by @gdamore in NNI_GETXX macros are brittle due to casting mistake. #1904
• NNG_OPT_RECVFD and NNG_OPT_SENDFD converted to functions. by @gdamore in NNG_OPT_RECVFD and NNG_OPT_SENDFD converted to functions. #1905
• Gdamore/no ctx addr by @gdamore in Gdamore/no ctx addr #1906
• Gdamore/socket by @gdamore in Gdamore/socket #1908
• Replace NNG_OPT_SUB_SUBSCRIBE/UNSUBSCRIBE with functions. by @gdamore in Replace NNG_OPT_SUB_SUBSCRIBE/UNSUBSCRIBE with functions. #1909
• Gdamore/no untyped pipe get by @gdamore in Gdamore/no untyped pipe get #1910
• Gdamore/no ctx untyped by @gdamore in Gdamore/no ctx untyped #1911
• Socket option handling clean ups for endpoints. by @gdamore in Socket option handling clean ups for endpoints. #1912
• Gdamore/new acutest by @gdamore in Gdamore/new acutest #1913
• Gdamore/udp burst tune by @gdamore in Gdamore/udp burst tune #1916
• UDP: prefer new packets (drop older) by @gdamore in UDP: prefer new packets (drop older) #1917
• Gdamore/ipc test by @gdamore in Gdamore/ipc test #1918
• Gdamore/more tests by @gdamore in Gdamore/more tests #1919
• Add matrix of TLS engines, including wolfSSL by @gdamore in Add matrix of TLS engines, including wolfSSL #1923
• TLS configuration changed to use discret _set_tls and _get_tls functi… by @gdamore in TLS configuration changed to use discret _set_tls and _get_tls functi… #1925
• websocket: Do not allow a listener or dialer to change TLS while running by @gdamore in websocket: Do not allow a listener or dialer to change TLS while running #1926
• New init by @gdamore in New init #1927
• tls: remove support for TLS 1.0 and 1.1. by @gdamore in tls: remove support for TLS 1.0 and 1.1. #1931
• tls: add ecdsa test case by @gdamore in tls: add ecdsa test case #1932
• remove NNG_OPT_SOCKNAME (and socket names altogether) by @gdamore in remove NNG_OPT_SOCKNAME (and socket names altogether) #1933
• tcp/tls: Remove support for local interface address in dialer URLs by @gdamore in tcp/tls: Remove support for local interface address in dialer URLs #1934
• fix parsing bug in abstract URLs by @gdamore in fix parsing bug in abstract URLs #1935
• intern URL scheme by @gdamore in intern URL scheme #1936
• Nng url no alloc by @gdamore in Nng url no alloc #1937
• Url accessors by @gdamore in Url accessors #1938
• Gdamore/more opt url by @gdamore in Gdamore/more opt url #1939
• Tls mutual test by @gdamore in Tls mutual test #1940
• Ipc tests by @gdamore in Ipc tests #1941
• No reqctx test by @gdamore in No reqctx test #1942
• option parser: test for no clustering support by @gdamore in option parser: test for no clustering support #1943
• http: constify some functions by @gdamore in http: constify some functions #1944
• No more sec desc option by @gdamore in No more sec desc option #1945
• Remove all the get_ptr option accessors. by @gdamore in Remove all the get_ptr option accessors. #1946
• Tls no extra resolver by @gdamore in Tls no extra resolver #1947
• Nuts tests by @gdamore in Nuts tests #1952
• Http server race by @gdamore in Http server race #1953
• windows ipc: check the return value of nni_aio_schedule by @gdamore in windows ipc: check the return value of nni_aio_schedule #1956
• sockfd: check the result of nni_aio_schedule by @gdamore in sockfd: check the result of nni_aio_schedule #1957
• Htnuts by @gdamore in Htnuts #1962
• fixes Occasional SIGSEGV in nng_recv_aio() on a respondent socket #1959 Occasional SIGSEGV in nng_recv_aio() on a respondent socket by @aleksejsolovev in fixes #1959 Occasional SIGSEGV in nng_recv_aio() on a respondent socket #1960
• fixes Reference count as a first class type #1408 Reference count as a first class type by @gdamore in fixes #1408 Reference count as a first class type #1963
• Add forgotten license boilerplate by @aleksejsolovev in Add forgotten license boilerplate #1965
• Aio reap noreschedule by @gdamore in Aio reap noreschedule #1966
• aio: stop has to wait for expirations to finish by @gdamore in aio: stop has to wait for expirations to finish #1967
• reap: thread exits prematurely after reinitialization by @gdamore in reap: thread exits prematurely after reinitialization #1968
• Pipe null by @gdamore in Pipe null #1969
• udp: hang on close after sending too large by @gdamore in udp: hang on close after sending too large #1970
• aio: make sure aio is initialized before certain operations by @gdamore in aio: make sure aio is initialized before certain operations #1971
• ctx: Simplify handling for closed contexts. by @gdamore in ctx: Simplify handling for closed contexts. #1972
• performance: reference counters can use relaxed order when incrementing by @gdamore in performance: reference counters can use relaxed order when incrementing #1973
• websocket: inline the aios by @gdamore in websocket: inline the aios #1974
• nuts: try to avoid address in use for most tests by @gdamore in nuts: try to avoid address in use for most tests #1975
• device: fixes for socket holds and leaking aio data by @gdamore in device: fixes for socket holds and leaking aio data #1977
• aio: task_abort was a mistake by @gdamore in aio: task_abort was a mistake #1978
• Listener inline by @gdamore in Listener inline #1981
• Windows iopc no close by @gdamore in Windows iopc no close #1984
• ipc transport: convert to using inline data structures by @gdamore in ipc transport: convert to using inline data structures #1982
• Tcp stop by @gdamore in Tcp stop #1985
• streams: add explicit stop functions by @gdamore in streams: add explicit stop functions #1987
• Http aio init by @gdamore in Http aio init #1988
• Tcptran aio inline by @gdamore in Tcptran aio inline #1989
• Inproc ref by @gdamore in Inproc ref #1990
• Tls inline 2 by @gdamore in Tls inline 2 #1991
• Websocket inline by @gdamore in Websocket inline #1992
• Websock stop by @gdamore in Websock stop #1994
• syslog: test for existence by @gdamore in syslog: test for existence #1995
• POSIX poller: add support for select, and for choosing the poller by @gdamore in POSIX poller: add support for select, and for choosing the poller #1996
• Expose pfd by @gdamore in Expose pfd #1998
• Poll alloc by @gdamore in Poll alloc #1999
• workflows: add pollq and make build debug for backtraces by @gdamore in workflows: add pollq and make build debug for backtraces #2000
• workflows: only generate docs when appropriate, and don't do tests wh… by @gdamore in workflows: only generate docs when appropriate, and don't do tests wh… #2001
• freebsd workflow by @gdamore in freebsd workflow #2002
• OmniOS tests (this covers illumos and Solaris mostly, which uses the … by @gdamore in OmniOS tests (this covers illumos and Solaris mostly, which uses the … #2003
• HTTP: intern the version and avoid allocation by @gdamore in HTTP: intern the version and avoid allocation #2005

New Contributors

• @jan-ruzicka-c made their first contribution in fix broken link to BUILD_TLS #1872

Full Changelog: v1.9.0...v2.0.0-alpha.1

---

This discussion was created from the release v2.0.0-alpha.1.