summaryrefslogtreecommitdiff
path: root/docs/man/nng_send.3.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2025-01-03 09:03:00 -0800
committerGarrett D'Amore <garrett@damore.org>2025-01-03 09:23:47 -0800
commitb22e9c5158861937e5d9228854b93165615f52ba (patch)
treed04ee9840b28026cbcf220e0a3b72dbef2b1a30b /docs/man/nng_send.3.adoc
parent8c529c4143ce06b4c72fca1aa593e32e62fdbe18 (diff)
downloadnng-b22e9c5158861937e5d9228854b93165615f52ba.tar.gz
nng-b22e9c5158861937e5d9228854b93165615f52ba.tar.bz2
nng-b22e9c5158861937e5d9228854b93165615f52ba.zip
stable: docs: note deprecation of NNG_FLAG_ALLOC
Diffstat (limited to 'docs/man/nng_send.3.adoc')
-rw-r--r--docs/man/nng_send.3.adoc7
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/man/nng_send.3.adoc b/docs/man/nng_send.3.adoc
index 7037f547..49c9b767 100644
--- a/docs/man/nng_send.3.adoc
+++ b/docs/man/nng_send.3.adoc
@@ -1,6 +1,6 @@
= nng_send(3)
//
-// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
+// Copyright 2025 Staysail Systems, Inc. <info@staysail.tech>
// Copyright 2018 Capitar IT Group BV <info@capitar.com>
//
// This document is supplied under the terms of the MIT License, a
@@ -57,8 +57,9 @@ The _flags_ may contain either of (or neither of) the following values:
In the absence of this flag, the _data_ is copied by the implementation
before the function returns to the caller.
-TIP: The `NNG_FLAG_ALLOC` flag can be used to reduce data copies, thereby
-increasing performance.
+NOTE: The `NNG_FLAG_ALLOC` flag is deprecated and may be removed in a future release.
+Applications should use xref:nng_sendmsg.3.adoc[`nng_sendmsg()`] for zero copy performance
+improvements.
NOTE: Regardless of the presence or absence of `NNG_FLAG_NONBLOCK`, there may
be queues between the sender and the receiver.