diff options
| author | Garrett D'Amore <garrett@damore.org> | 2025-01-04 10:13:49 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2025-01-04 11:48:02 -0800 |
| commit | 6e03d3470ca6f7c5bdfad6def41b0f0eaf9d33a6 (patch) | |
| tree | d2263c4cadab9665e685778edfe58c53ad924ac1 /docs/ref/migrate | |
| parent | 304cd1d66574330bfdff17f8bd1b72119bdc2861 (diff) | |
| download | nng-6e03d3470ca6f7c5bdfad6def41b0f0eaf9d33a6.tar.gz nng-6e03d3470ca6f7c5bdfad6def41b0f0eaf9d33a6.tar.bz2 nng-6e03d3470ca6f7c5bdfad6def41b0f0eaf9d33a6.zip | |
api: remove old protocol headers
Diffstat (limited to 'docs/ref/migrate')
| -rw-r--r-- | docs/ref/migrate/nng1.md | 26 |
1 files changed, 23 insertions, 3 deletions
diff --git a/docs/ref/migrate/nng1.md b/docs/ref/migrate/nng1.md index 74350ec0..964bba50 100644 --- a/docs/ref/migrate/nng1.md +++ b/docs/ref/migrate/nng1.md @@ -13,6 +13,29 @@ See the [Migrating From libnanomsg](nanomsg.md) chapter for details. It is now required for applications to initialize the library explicitly before using it. This is done using the [`nng_init`] function. +## Removed Headers + +The following header files are removed, and the declarations they provided are now provided by including `<nng/nng.h>`. +Simply remove any references to them. + +- `nng/protocol/bus0/bus.h` +- `nng/protocol/pair0/pair.h` +- `nng/protocol/pair1/pair.h` +- `nng/protocol/pipeline0/pull.h` +- `nng/protocol/pipeline0/push.h` +- `nng/protocol/pubsub0/pub.h` +- `nng/protocol/pubsub0/sub.h` +- `nng/protocol/reqrep0/rep.h` +- `nng/protocol/reqrep0/req.h` +- `nng/protocol/survey0/respond.h` +- `nng/protocol/survey0/survey.h` +- `nng/transport/inproc/inproc.h` +- `nng/transport/ipc/ipc.h` +- `nng/transport/tcp/tcp.h` +- `nng/transport/tls/tls.h` +- `nng/transport/ws/websocket.h` +- `nng/transport/zerotier/zerotier.h` + ## Renamed Functions The following functions have been renamed as described by the following table. @@ -42,9 +65,6 @@ The following macro aliases are removed, unless `NNG1_TRANSITION` is defined in Just add either `0` or `1` (in the case of PAIRv1) to get the protocol desired. (Forcing the version number to be supplied should avoid surprises later as new versions of protocols are added.) -Additionally, the header files for protocols are now empty, as all of their content has been moved to `nng/nng.h`. -Please remove `#include` references to protocol headers as we anticipate removing them in the future. - ## NNG_FLAG_ALLOC Removed The `NNG_FLAG_ALLOC` flag that allowed a zero copy semantic with [`nng_send`] and [`nng_recv`] is removed. |