summaryrefslogtreecommitdiff
path: root/docs/man/nng_str_sockaddr.3.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-04-21 12:23:07 -0700
committerGitHub <noreply@github.com>2024-04-21 12:23:07 -0700
commit56507ab5c4db009be5251bde832f594fe5ed3d5e (patch)
treec70e7d669c3548a5c58ab27c0fc6118a96580863 /docs/man/nng_str_sockaddr.3.adoc
parent3593eba5272bf627b99a2521b3f025141a49bcad (diff)
downloadnng-56507ab5c4db009be5251bde832f594fe5ed3d5e.tar.gz
nng-56507ab5c4db009be5251bde832f594fe5ed3d5e.tar.bz2
nng-56507ab5c4db009be5251bde832f594fe5ed3d5e.zip
Logging improvements (#1816)
* Add nng_str_sockaddr to get string representation of socket address. * Added nng_log_get_level() is meant to allow users to obtain the current level and avoid some possibly expensive operations just to collect debugging information when debugging is not in effect. We use a custom logger for NUTS, and this fits within the NUTS test framework well, so that if -v is supplied we get more content. All tests now get this by default.
Diffstat (limited to 'docs/man/nng_str_sockaddr.3.adoc')
-rw-r--r--docs/man/nng_str_sockaddr.3.adoc52
1 files changed, 52 insertions, 0 deletions
diff --git a/docs/man/nng_str_sockaddr.3.adoc b/docs/man/nng_str_sockaddr.3.adoc
new file mode 100644
index 00000000..03999d1a
--- /dev/null
+++ b/docs/man/nng_str_sockaddr.3.adoc
@@ -0,0 +1,52 @@
+= nng_str_sockaddr(3)
+//
+// Copyright 2024 Staysail Systems, Inc. <info@staysail.tech>
+//
+// This document is supplied under the terms of the MIT License, a
+// copy of which should be located in the distribution where this
+// file was obtained (LICENSE.txt). A copy of the license may also be
+// found online at https://opensource.org/licenses/MIT.
+//
+
+== NAME
+
+
+nng_str_sockaddr - get string representation of socket address
+
+== SYNOPSIS
+
+[source, c]
+----
+#include <nng/nng.h>
+
+#define NNG_MAXADDRSTRLEN (NNG_MAXADDRLEN+16)
+const char *nng_str_sockaddr(const nng_sockaddr *sa, char *buf, size_t bufsz)
+----
+
+== DESCRIPTION
+
+The `nng_str_sockaddr()` is used to provide a displayable representation
+for the socket address _sa_.
+The content will be stored the location provided by _buf_, and will be
+formatted to fit within _bufsz_ bytes, truncating if necessary.
+
+As long as _bufsz_ is greater than zero, the result will be properly
+zero-terminated in the usual fashion.
+
+The `NNG_MAXADDRSTRLEN` can be used to provide a buffer large enough to hold most socket addresses.
+It is possible for applications to use very much larger socket addresses (using very long paths
+for IPC or inproc), but such addresses are not generally compatible with other implementations,
+and will be truncated here.
+
+== RETURN VALUES
+
+This function returns the _buf_ argument.
+
+== ERRORS
+
+None.
+
+== SEE ALSO
+
+[.text-left]
+xref:nng_sockaddr.5.adoc[nng_sockaddr(5)]