aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_msg_trim.3.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-08-31 11:25:50 -0700
committerGarrett D'Amore <garrett@damore.org>2018-08-31 11:25:50 -0700
commit49c8c264057c4c7b0f9ff45f352168cb1deeb1a1 (patch)
tree30836d3dfe020380216113784b4ab74c633d9b45 /docs/man/nng_msg_trim.3.adoc
parent2426984f20a8363e52fef5cd69221da05c0b1756 (diff)
downloadnng-49c8c264057c4c7b0f9ff45f352168cb1deeb1a1.tar.gz
nng-49c8c264057c4c7b0f9ff45f352168cb1deeb1a1.tar.bz2
nng-49c8c264057c4c7b0f9ff45f352168cb1deeb1a1.zip
fixes #691 Desire 16 and 64 bit message manipulators
We use macros to generate message bodies for each of the various variants, reducing source code size (but not compiled size). The documentation is updated to indicate each of these variants.
Diffstat (limited to 'docs/man/nng_msg_trim.3.adoc')
-rw-r--r--docs/man/nng_msg_trim.3.adoc12
1 files changed, 7 insertions, 5 deletions
diff --git a/docs/man/nng_msg_trim.3.adoc b/docs/man/nng_msg_trim.3.adoc
index a599b13c..644b6f44 100644
--- a/docs/man/nng_msg_trim.3.adoc
+++ b/docs/man/nng_msg_trim.3.adoc
@@ -11,7 +11,7 @@
== NAME
-nng_msg_trim, nng_msg_trim_u32 - remove data from start of message body
+nng_msg_trim - remove data from start of message body
== SYNOPSIS
@@ -20,22 +20,24 @@ nng_msg_trim, nng_msg_trim_u32 - remove data from start of message body
#include <nng/nng.h>
int nng_msg_trim(nng_msg *msg, size_t size);
-
+int nng_msg_trim_u16(nng_msg *msg, uint16_t *val16);
int nng_msg_trim_u32(nng_msg *msg, uint32_t *val32);
+int nng_msg_trim_u64(nng_msg *msg, uint64_t *val64);
----
== DESCRIPTION
-The `nng_msg_trim()` and `nng_msg_trim_u32()` functions remove data from
+The `nng_msg_trim()` family of functions removes data from
the start of the body of message _msg_.
The first function removes _size_ bytes.
-The second function removes 4 bytes, and stores them in the value _val32_,
+The remaining functions remove 2, 4, or 8 bytes, and stores them in the value
+(such as _val32_),
after converting them from network-byte order (big-endian) to native
byte order.
== RETURN VALUES
-This function returns 0 on success, and non-zero otherwise.
+These functions return 0 on success, and non-zero otherwise.
== ERRORS