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_insert.3.adoc | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) (limited to 'docs/man/nng_msg_header_insert.3.adoc') diff --git a/docs/man/nng_msg_header_insert.3.adoc b/docs/man/nng_msg_header_insert.3.adoc index f7934738..1b1437f7 100644 --- a/docs/man/nng_msg_header_insert.3.adoc +++ b/docs/man/nng_msg_header_insert.3.adoc @@ -11,7 +11,7 @@ == NAME -nng_msg_header_insert, nng_msg_header_insert_u32 - prepend to message header +nng_msg_header_insert - prepend to message header == SYNOPSIS @@ -20,21 +20,23 @@ nng_msg_header_insert, nng_msg_header_insert_u32 - prepend to message header #include int nng_msg_header_insert(nng_msg *msg, const void *val, size_t size); - +int nng_msg_header_insert_u16(nng_msg *msg, uint16_t val16); int nng_msg_header_insert_u32(nng_msg *msg, uint32_t val32); +int nng_msg_header_insert_u64(nng_msg *msg, uint64_t val64); ---- == DESCRIPTION -The `nng_msg_header_insert()` and `nng_msg_header_insert_u32()` functions -prepend data to the front of the headers of message _msg_, reallocating +The `nng_msg_header_insert()` family of functions +prepends data to the front of the headers of message _msg_, reallocating if necessary. -The first function prepends _size_ bytes, copying them from _val_. The -second function prepends the value _val32_ in network-byte order (big-endian). +The first function prepends _size_ bytes, copying them from _val_. +The remaining functions prepend the specified value (such as _val32_) in +network-byte order (big-endian). == RETURN VALUES -This function returns 0 on success, and non-zero otherwise. +These functions return 0 on success, and non-zero otherwise. == ERRORS -- cgit v1.2.3-70-g09d2