From 98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Thu, 15 Mar 2018 08:40:17 -0700 Subject: fixes #286 nng_pair0_open (and all others) need man page fixes #279 consider restructuring man sections This represents a rather significant rework, and major editing effort, for the entire set of manual pages. All of the pages now have a section number in their filename; this assists in some other tooling, particularly ebook generation as every link needs to be programmatically modified when combined into an ebook. Section 5 is introduced, and populated with pages for the main types, and all options are now documented. Numerous errors have been corrected, including rewriting certain portions such as the header section of the surveyor protocol. Much work has been done to facilitate index generation, although certainly more work remains here. Every internal link within these pages now resolves; there are no more dead links. (This is required to generate Kindle format books.) --- docs/man/nng_msg_header_insert.adoc | 53 ------------------------------------- 1 file changed, 53 deletions(-) delete mode 100644 docs/man/nng_msg_header_insert.adoc (limited to 'docs/man/nng_msg_header_insert.adoc') diff --git a/docs/man/nng_msg_header_insert.adoc b/docs/man/nng_msg_header_insert.adoc deleted file mode 100644 index e70dede7..00000000 --- a/docs/man/nng_msg_header_insert.adoc +++ /dev/null @@ -1,53 +0,0 @@ -= nng_msg_header_insert(3) -// -// Copyright 2018 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// This document is supplied under the terms of the MIT License, a -// copy of which should be located in the distribution where this -// file was obtained (LICENSE.txt). A copy of the license may also be -// found online at https://opensource.org/licenses/MIT. -// - -== NAME - -nng_msg_header_insert, nng_msg_header_insert_u32 - prepend to message header - -== SYNOPSIS - -[source, c] ------------ -#include - -int nng_msg_header_insert(nng_msg *msg, const void *val, size_t size); -int nng_msg_header_insert_u32(nng_msg *msg, uint32_t val32); ------------ - -== 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 -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). - -== RETURN VALUES - -This function returns 0 on success, and non-zero otherwise. - -== ERRORS - -`NNG_ENOMEM`:: Insufficient free memory exists. - -== SEE ALSO - -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> -- cgit v1.2.3-70-g09d2