-
-
Notifications
You must be signed in to change notification settings - Fork 495
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add some man pages (alloc, free, version).
- Loading branch information
Showing
4 changed files
with
160 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
= nng_alloc(3) | ||
// | ||
// Copyright 2018 Staysail Systems, Inc. <[email protected]> | ||
// Copyright 2018 Capitar IT Group BV <[email protected]> | ||
// | ||
// 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_alloc - allocate memory | ||
|
||
== SYNOPSIS | ||
|
||
[source, c] | ||
----------- | ||
#include <nng/nng.h> | ||
void *nng_alloc(size_t size); | ||
----------- | ||
|
||
== DESCRIPTION | ||
|
||
The `nng_alloc()` function allocates a contiguous memory region of | ||
at least _size_ bytes. The memory will be 64-bit aligned. | ||
|
||
The returned memory can be used to hold message buffers, in which | ||
case it can be directly passed to <<nng_send#,nng_send(3)>> using | ||
the flag `NNG_FLAG_ALLOC`. Alternatively, it can be freed when no | ||
longer needed using <<nng_free#,nng_free(3)>>. | ||
|
||
WARNING: Do not use the system `free()` function to release this memory. | ||
On some platforms this may work, but it is not guaranteed and may lead | ||
to a crash or other undesirable and unpredictable behavior. | ||
|
||
== RETURN VALUES | ||
|
||
This function returns 0 on success, and non-zero otherwise. | ||
|
||
== ERRORS | ||
|
||
`NNG_ENOMEM`:: Insufficient free memory exists. | ||
|
||
== SEE ALSO | ||
|
||
<<nng_free#,nng_free(3)>>, | ||
<<nng_send#,nng_send(3)>>, | ||
<<nng_strerror#,nng_strerror(3)>>, | ||
<<nng#,nng(7)>> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
= nng_free(3) | ||
// | ||
// Copyright 2018 Staysail Systems, Inc. <[email protected]> | ||
// Copyright 2018 Capitar IT Group BV <[email protected]> | ||
// | ||
// 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_free - free memory | ||
|
||
== SYNOPSIS | ||
|
||
[source, c] | ||
----------- | ||
#include <nng/nng.h> | ||
void nng_free(void *ptr, size_t size); | ||
----------- | ||
|
||
== DESCRIPTION | ||
|
||
The `nng_free()` function deallocates a memory region of size _size_, | ||
that was previously allocated by <<nng_alloc#,nng_alloc(3)>> or | ||
<<nng_recv#,nng_recv(3)>> with the `NNG_FLAG_ALLOC` flag. | ||
|
||
WARNING: It is very important that _size_ match the allocation size | ||
used to allocate the memory. | ||
|
||
WARNING: Do not attempt to use this function to deallocate memory | ||
obtained by a call to the system `malloc()` or `calloc()` functions, | ||
or the {cpp} `new` operator. Doing so may result in unpredictable | ||
behavior, including corruption of application memory. | ||
|
||
== RETURN VALUES | ||
|
||
None. | ||
|
||
== ERRORS | ||
|
||
None. | ||
|
||
== SEE ALSO | ||
|
||
<<nng_alloc#,nng_alloc(3)>>, | ||
<<nng_recv#,nng_recv(3)>>, | ||
<<nng#,nng(7)>> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
= nng_version(3) | ||
// | ||
// Copyright 2018 Staysail Systems, Inc. <[email protected]> | ||
// Copyright 2018 Capitar IT Group BV <[email protected]> | ||
// | ||
// 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_version - report library version | ||
|
||
== SYNOPSIS | ||
|
||
[source, c] | ||
----------- | ||
#include <nng/nng.h> | ||
const char * nng_version(void); | ||
----------- | ||
|
||
== DESCRIPTION | ||
|
||
The `nng_version()` function returns a human readable version | ||
number for the _nng_ library. This is intended for output in | ||
programs, and so forth. | ||
|
||
Additionally, compile time version information is available | ||
via some predefined macros: | ||
|
||
`NNG_MAJOR_VERSION`:: Major version number. | ||
`NNG_MINOR_VERSION`:: Minor version number. | ||
`NNG_PATCH_VERSION`:: Patch version number. | ||
|
||
The _nng_ library is developed and released using | ||
http:///www.semver.org[Semantic Versioning 2.0], and | ||
the version numbers reported refer to both the API and the | ||
library itself. (The ABI -- binary interface -- between the | ||
library and the application is controlled in a similar, but different | ||
manner depending upon the link options and how the library is built.) | ||
|
||
== RETURN VALUES | ||
|
||
C string (NUL-terminated) containing the library version number. | ||
|
||
== ERRORS | ||
|
||
None. | ||
|
||
== SEE ALSO | ||
|
||
<<libnng#,libnng(3)>>, | ||
<<nng#,nng(7)>> |