diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-08-31 11:25:50 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-08-31 11:25:50 -0700 |
| commit | 49c8c264057c4c7b0f9ff45f352168cb1deeb1a1 (patch) | |
| tree | 30836d3dfe020380216113784b4ab74c633d9b45 /docs/man/nng_msg_header_chop.3.adoc | |
| parent | 2426984f20a8363e52fef5cd69221da05c0b1756 (diff) | |
| download | nng-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_header_chop.3.adoc')
| -rw-r--r-- | docs/man/nng_msg_header_chop.3.adoc | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/docs/man/nng_msg_header_chop.3.adoc b/docs/man/nng_msg_header_chop.3.adoc index 6536b6fb..c9c9113b 100644 --- a/docs/man/nng_msg_header_chop.3.adoc +++ b/docs/man/nng_msg_header_chop.3.adoc @@ -11,7 +11,7 @@ == NAME -nng_msg_header_chop, nng_msg_header_chop_u32 - remove data from end of message header +nng_msg_header_chop - remove data from end of message header == SYNOPSIS @@ -20,22 +20,24 @@ nng_msg_header_chop, nng_msg_header_chop_u32 - remove data from end of message h #include <nng/nng.h> int nng_msg_header_chop(nng_msg *msg, size_t size); - +int nng_msg_header_chop_u16(nng_msg *msg, uint16_t *val16); int nng_msg_header_chop_u32(nng_msg *msg, uint32_t *val32); +int nng_msg_header_chop_u64(nng_msg *msg, uint64_t *val64); ---- == DESCRIPTION -The `nng_msg_header_chop()` and `nng_msg_header_chop_u32()` functions remove +The `nng_msg_header_chop()` family of functions removes data from the end 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 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 function return 0 on success, and non-zero otherwise. == ERRORS |
