aboutsummaryrefslogtreecommitdiff
path: root/docs/ref/migrate/nng1.md
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2025-01-04 17:57:28 -0800
committerGarrett D'Amore <garrett@damore.org>2025-01-04 18:00:09 -0800
commitf77e5a5ec7f8b1373eeda0ea56f47137daf40330 (patch)
tree9f2f10860a70765924dba9231bf3e2e4650f8b82 /docs/ref/migrate/nng1.md
parenta40b421d39a64c285a4ac23304538690aaa90739 (diff)
downloadnng-f77e5a5ec7f8b1373eeda0ea56f47137daf40330.tar.gz
nng-f77e5a5ec7f8b1373eeda0ea56f47137daf40330.tar.bz2
nng-f77e5a5ec7f8b1373eeda0ea56f47137daf40330.zip
args: Convert nng_opts_parse into a header only library using `nng_args_parse`.
The API is identical, except that some names have changed, and this is now a header library in `nng/args.h` - so the core library does not need to carry this code in binaries. Being a header library also means it is not necessary to link against NNG, and it does not include any parts of NNG; it only depends on a standard C99 or C11 environment.
Diffstat (limited to 'docs/ref/migrate/nng1.md')
-rw-r--r--docs/ref/migrate/nng1.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/ref/migrate/nng1.md b/docs/ref/migrate/nng1.md
index cfb40a90..c203b790 100644
--- a/docs/ref/migrate/nng1.md
+++ b/docs/ref/migrate/nng1.md
@@ -88,7 +88,7 @@ suboptimal in terms of performance.
Modern code should use one of [`nng_sendmsg`], [`nng_recvmsg`], [`nng_socket_send`], or [`nng_socket_recv`] to get the maximum performance benefit.
Working directly with [`nng_msg`] structures gives more control, reduces copies, and reduces allocation activity.
-## New AIO Error Code NNG_ESTOPPED
+## Error Code Changes
When an operation fails with [`NNG_ESTOPPED`], it means that the associated [`nni_aio`] object has
been permanently stopped and must not be reused. Applications must watch for this error code, and
@@ -96,6 +96,8 @@ not resubmit an operation that returns it. This is particularly important for ca
resubmit operations. Failure to observe this rule will lead to an infinite loop
as any further operations on the object will fail immediately with `NNG_ESTOPPED`.
+The error codes `NNG_EAMBIGUOUS` and `NNG_ENOARG` have been removed.
+
## AIO Provider API changes
The API used for providers for asynchronous I/O operations has changed slightly.
@@ -365,6 +367,12 @@ and is presently only supported for IPC when Named Pipes are used.
Planned future changes to switch to UNIX domain sockets may eliminate
support for security descriptors altogether in NNG.
+## Command Line Argument Parser Changes
+
+The supplemental function `nng_opts_parse` and supporting definitions have moved.
+This functionality is now supplied by a header only library, available in `nng/args.h`.
+See [`nng_args_parse`] for more information.
+
## ZeroTier Support Removed
The Layer 2 special ZeroTier transport has been removed.