summaryrefslogtreecommitdiff
path: root/docs/man
diff options
context:
space:
mode:
Diffstat (limited to 'docs/man')
-rw-r--r--docs/man/nng_msleep.3supp.adoc49
-rw-r--r--docs/man/nng_strdup.3.adoc56
-rw-r--r--docs/man/nng_strfree.3.adoc58
3 files changed, 0 insertions, 163 deletions
diff --git a/docs/man/nng_msleep.3supp.adoc b/docs/man/nng_msleep.3supp.adoc
deleted file mode 100644
index 57d3615b..00000000
--- a/docs/man/nng_msleep.3supp.adoc
+++ /dev/null
@@ -1,49 +0,0 @@
-= nng_msleep(3supp)
-//
-// Copyright 2018 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
-// 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_msleep - sleep milliseconds
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-#include <nng/supplemental/util/platform.h>
-
-void nng_msleep(nng_duration msec);
-----
-
-== DESCRIPTION
-
-The `nng_msleep()` blocks the caller for at least _msec_ milliseconds.
-
-NOTE: This function may block for longer than requested.
-The actual wait time is determined by the capabilities of the
-underlying system.
-
-== RETURN VALUES
-
-None.
-
-== ERRORS
-
-None.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_sleep_aio.3.adoc[nng_sleep_aio(3)],
-xref:nng_strerror.3.adoc[nng_strerror(3)],
-xref:nng_clock.3supp.adoc[nng_clock(3supp)],
-xref:nng_duration.5.adoc[nng_duration(5)],
-xref:nng.7.adoc[nng(7)]
diff --git a/docs/man/nng_strdup.3.adoc b/docs/man/nng_strdup.3.adoc
deleted file mode 100644
index 91c4854d..00000000
--- a/docs/man/nng_strdup.3.adoc
+++ /dev/null
@@ -1,56 +0,0 @@
-= nng_strdup(3)
-//
-// Copyright 2018 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
-// 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_strdup - duplicate string
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-char *nng_strdup(const char *src);
-----
-
-== DESCRIPTION
-
-The `nng_strdup()` duplicates the string _src_ and returns it.
-
-This is logically equivalent to using xref:nng_alloc.3.adoc[`nng_alloc()`]
-to allocate a region of memory of `strlen(s) + 1` bytes, and then
-using `strcpy()` to copy the string into the destination before
-returning it.
-
-The returned string should be deallocated with
-xref:nng_strfree.3.adoc[`nng_strfree()`], or may be deallocated using the
-xref:nng_free.3.adoc[`nng_free()`] using the length of the returned string plus
-one (for the `NUL` terminating byte).
-
-IMPORTANT: Do not use the system `free()` or similar functions to deallocate
-the string, since those may use a different memory arena!
-
-== RETURN VALUES
-
-This function returns the new string on success, and `NULL` on failure.
-
-== ERRORS
-
-No errors are returned, but a `NULL` return value should be
-treated the same as `NNG_ENOMEM`.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_alloc.3.adoc[nng_alloc(3)],
-xref:nng_free.3.adoc[nng_free(3)],
-xref:nng.7.adoc[nng(7)]
diff --git a/docs/man/nng_strfree.3.adoc b/docs/man/nng_strfree.3.adoc
deleted file mode 100644
index 9250b834..00000000
--- a/docs/man/nng_strfree.3.adoc
+++ /dev/null
@@ -1,58 +0,0 @@
-= nng_strfree(3)
-//
-// Copyright 2018 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
-// 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_strfree - free memory
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-void nng_strfree(char *str);
-----
-
-== DESCRIPTION
-
-The `nng_strfree()` function deallocates the string _str_.
-This is equivalent to using xref:nng_free.3.adoc[`nng_free()`] with
-the length of _str_ plus one (for the `NUL` terminating byte) as
-the size.
-
-IMPORTANT: This should only be used with strings that were allocated
-by xref:nng_strdup.3.adoc[`nng_strdup()`] or
-xref:nng_alloc.3.adoc[`nng_alloc()`].
-In all cases, the allocation size of the string must be the same
-as `strlen(__str__) + 1`.
-
-IMPORTANT: Consequently, if the a string created with
-xref:nng_strdup.3.adoc[`nng_strdup()`] is modified to be shorter, then
-it is incorrect to call this function.
-(The xref:nng_free.3.adoc[`nng_free()`] function can be used instead in that
-case, using the length of the original string plus one for the size.)
-
-== RETURN VALUES
-
-None.
-
-== ERRORS
-
-None.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_alloc.3.adoc[nng_alloc(3)],
-xref:nng_free.3.adoc[nng_free(3)],
-xref:nng_strdup.3.adoc[nng_strdup(3)],
-xref:nng.7.adoc[nng(7)]