diff options
Diffstat (limited to 'docs/man/nng_msg_insert.3.adoc')
| -rw-r--r-- | docs/man/nng_msg_insert.3.adoc | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/docs/man/nng_msg_insert.3.adoc b/docs/man/nng_msg_insert.3.adoc index 911dabbb..cc910531 100644 --- a/docs/man/nng_msg_insert.3.adoc +++ b/docs/man/nng_msg_insert.3.adoc @@ -11,7 +11,7 @@ == NAME -nng_msg_insert, nng_msg_insert_u32 - prepend to message body +nng_msg_insert - prepend to message body == SYNOPSIS @@ -20,26 +20,27 @@ nng_msg_insert, nng_msg_insert_u32 - prepend to message body #include <nng/nng.h> int nng_msg_insert(nng_msg *msg, const void *val, size_t size); - +int nng_msg_insert(nng_msg *msg, uint16_t val16); int nng_msg_insert(nng_msg *msg, uint32_t val32); +int nng_msg_insert(nng_msg *msg, uint64_t val64); ---- == DESCRIPTION -The `nng_msg_insert()` and `nng_msg_insert_u32()` functions prepend data to +The `nng_msg_insert()` family of functions prepends data to the front of the body of message _msg_, reallocating it 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 remaining functions prepend the specified value (such as _val32_) +in network-byte order (big-endian). -TIP: This function makes use of pre-allocated "`headroom`" in the message if +TIP: These functions make use of pre-allocated "`headroom`" in the message if available, so it can often avoid performing any reallocation. Applications should use this instead of reallocating and copying message content themselves, in order to benefit from this capability. == RETURN VALUES -This function returns 0 on success, and non-zero otherwise. +These functions return 0 on success, and non-zero otherwise. == ERRORS |