From 49c8c264057c4c7b0f9ff45f352168cb1deeb1a1 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Fri, 31 Aug 2018 11:25:50 -0700 Subject: 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. --- docs/man/nng_msg_header_trim.3.adoc | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) (limited to 'docs/man/nng_msg_header_trim.3.adoc') diff --git a/docs/man/nng_msg_header_trim.3.adoc b/docs/man/nng_msg_header_trim.3.adoc index 39d8052e..0a9caea3 100644 --- a/docs/man/nng_msg_header_trim.3.adoc +++ b/docs/man/nng_msg_header_trim.3.adoc @@ -11,7 +11,7 @@ == NAME -nng_msg_header_trim, nng_msg_header_trim_u32 - remove data from start of message header +nng_msg_header_trim - remove data from start of message header == SYNOPSIS @@ -20,16 +20,18 @@ nng_msg_header_trim, nng_msg_header_trim_u32 - remove data from start of message #include int nng_msg_header_trim(nng_msg *msg, size_t size); - +int nng_msg_header_trim_u16(nng_msg *msg, uint16_t *val16); int nng_msg_header_trim_u32(nng_msg *msg, uint32_t *val32); +int nng_msg_header_trim_u64(nng_msg *msg, uint64_t *val64); ---- == DESCRIPTION -The `nng_msg_header_trim()` and `nng_msg_header_trim_u32()` functions remove +The `nng_msg_header_trim()` family of functions remove data from the start of the header 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 removes 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. -- cgit v1.2.3-70-g09d2