diff options
Diffstat (limited to 'docs/man/nng_msg_trim.3.adoc')
| -rw-r--r-- | docs/man/nng_msg_trim.3.adoc | 12 |
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 |