diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-03-15 08:40:17 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-03-17 08:49:12 -0700 |
| commit | 98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86 (patch) | |
| tree | e3cc06524b26fd0773d1742de82a00862f95c5f6 /docs/man/nng_socket.adoc | |
| parent | 91866ed9365ab89069c12da41c873c23d0ba1d19 (diff) | |
| download | nng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.tar.gz nng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.tar.bz2 nng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.zip | |
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.)
Diffstat (limited to 'docs/man/nng_socket.adoc')
| -rw-r--r-- | docs/man/nng_socket.adoc | 54 |
1 files changed, 0 insertions, 54 deletions
diff --git a/docs/man/nng_socket.adoc b/docs/man/nng_socket.adoc deleted file mode 100644 index 31df4a8f..00000000 --- a/docs/man/nng_socket.adoc +++ /dev/null @@ -1,54 +0,0 @@ -= nng_socket(5) -// -// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> -// Copyright 2018 Capitar IT Group BV <info@capitar.com> -// -// 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_socket - socket handle - -== SYNOPSIS - -[source, c] ------------ -#include <nng/nng.h> - -typedef uint32_t nng_socket; ------------ - -== DESCRIPTION - -An ((`nng_socket`))(((socket))) is a handle to an underlying "`socket`" object. -All communication between the application and remote Scalability Protocol -peers is done through sockets. -A given socket can have multiple dialers (<<nng_dialer#,`nng_dialer`>>) -and/or (<<nng_listener#,`nng_listener`>>), and multiple -pipes (<<nng_pipe#,`nng_pipe`>>), and -may be connected to multiple transports at the same time. -However, a given socket will have exactly one "`protocol`" associated with it, -and is responsible for any state machines or other protocol-specific logic. - -NOTE: Although `nng_socket` is an integer data type, these objects are not -ordinary file descriptors, and can only be used with the functions that -explicitly indicate that it safe and appropropate to do so. - -Each `nng_socket` is created by a protocol-specific constructor, such as -<<nng_rep0_open#,`nng_rep0_open()`>>. -When the socket is no longer needed, it can be closed with -<<nng_close#,`nng_close()`>>. - -== SEE ALSO - -[.text-left] -<<libnng#,libnng(3)>>, -<<nng_close#,nng_close(3)>>, -<<nng_dialer#,nng_dialer(5)>>, -<<nng_listener#,nng_listener(5)>>, -<<nng_options#,nng_options(5)>>, -<<nng#,nng(7)>> |
