aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_compat.3compat.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-05-19 21:42:07 -0700
committerGarrett D'Amore <garrett@damore.org>2018-05-19 21:42:07 -0700
commit2c123e082a4fea6fa82132f6ab0f7257daac3f59 (patch)
tree31c8329fc8c32d7b835ba55977c6911192b39fe0 /docs/man/nng_compat.3compat.adoc
parent0c3178860cb14b095e809676d5c4401cf65f5f58 (diff)
downloadnng-2c123e082a4fea6fa82132f6ab0f7257daac3f59.tar.gz
nng-2c123e082a4fea6fa82132f6ab0f7257daac3f59.tar.bz2
nng-2c123e082a4fea6fa82132f6ab0f7257daac3f59.zip
fixes #458 Improve man page section descriptions.
Diffstat (limited to 'docs/man/nng_compat.3compat.adoc')
-rw-r--r--docs/man/nng_compat.3compat.adoc5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/man/nng_compat.3compat.adoc b/docs/man/nng_compat.3compat.adoc
index 77e55313..a282b4a9 100644
--- a/docs/man/nng_compat.3compat.adoc
+++ b/docs/man/nng_compat.3compat.adoc
@@ -32,6 +32,11 @@ New applications should use the newer <<nng.7#,_nng_>> API instead.
Applications making use of this ((compatibility layer)) must take care
to link with <<libnng.3#,_libnng_>> instead of _libnn_.
+TIP: While not recommended for long term use, the value returned by
+<<nng_socket_id.3#,nng_socket_id()>> can be used with these functions
+just like a value returned by <<nn_socket.3compat#,nn_socket()>>.
+This can be way to facilitate incremental transition to the new API.
+
NOTE: Some capabilities, protocols, and transports, will not be accessible
using this API, as the compatible API has no provision for expression
of certain concepts introduced in the newer <<nng.7#,_nng_>> API.