aboutsummaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-12-31 13:36:58 -0800
committerGarrett D'Amore <garrett@damore.org>2024-12-31 13:36:58 -0800
commitb56a1d17ce1c531a8ae05b0d93eaf761bea1476f (patch)
tree6fc3f80a264d11e8f80a84f9c875112b6f10a4aa /docs/ref
parentb0874b1dad787c32093a3ff81311e2d638dc6538 (diff)
downloadnng-b56a1d17ce1c531a8ae05b0d93eaf761bea1476f.tar.gz
nng-b56a1d17ce1c531a8ae05b0d93eaf761bea1476f.tar.bz2
nng-b56a1d17ce1c531a8ae05b0d93eaf761bea1476f.zip
api: add NNG1_MIGRATION transition assistance macro
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/migrate/nng1.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/ref/migrate/nng1.md b/docs/ref/migrate/nng1.md
index 663bf002..4aa805bb 100644
--- a/docs/ref/migrate/nng1.md
+++ b/docs/ref/migrate/nng1.md
@@ -13,10 +13,11 @@ 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.
-## Socket Close Function Renamed
+## Renamed Functions
The `nng_close` function has been renamed to [`nng_socket_close`] to make it clearer that
-the object being closed is a socket.
+the object being closed is a socket. A compatible `nng_close` macro is available by defining `NNG1_TRANSITION`
+in your compilation environment.
## New AIO Error Code NNG_ESTOPPED