aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-03-28 10:19:46 -0700
committerGarrett D'Amore <garrett@damore.org>2018-03-30 12:38:56 -0700
commit122bd6086c0fef009f582d6c4fec5a5a3ae5e6de (patch)
tree3fb6cd92be4766aa40c47c7cfa0f3e3ae6d9c449
parent19546a81a5995cdca5d3f599d7c12b7219248f36 (diff)
downloadnng-122bd6086c0fef009f582d6c4fec5a5a3ae5e6de.tar.gz
nng-122bd6086c0fef009f582d6c4fec5a5a3ae5e6de.tar.bz2
nng-122bd6086c0fef009f582d6c4fec5a5a3ae5e6de.zip
Include a tip about service naming guidelines.
-rw-r--r--docs/man/nng.7.adoc7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/man/nng.7.adoc b/docs/man/nng.7.adoc
index 7b145a54..ee120774 100644
--- a/docs/man/nng.7.adoc
+++ b/docs/man/nng.7.adoc
@@ -146,6 +146,13 @@ Note that steps 4, 5, and 7 are not specified by RFC 3986, but performing
them is believed to improve both the usability and security of _nng_
applications, without violating RFC 3986 itself.
+TIP: Port numbers may be service names in some instances, but it is recommended
+that numeric port numbers be used when known.
+If service names are used, it is recommended that they follow the naming
+conventions for C identifiers, and not be longer than 32 characters in length.
+This will maximize compatibility across systems and minimize opportunities for
+confusion when they are parsed on different systems.
+
== API
The library API is documented at <<libnng.3#,libnng(3)>>.