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_ipc.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_ipc.adoc')
| -rw-r--r-- | docs/man/nng_ipc.adoc | 83 |
1 files changed, 0 insertions, 83 deletions
diff --git a/docs/man/nng_ipc.adoc b/docs/man/nng_ipc.adoc deleted file mode 100644 index e212cf0f..00000000 --- a/docs/man/nng_ipc.adoc +++ /dev/null @@ -1,83 +0,0 @@ -= nng_ipc(7) -// -// 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_ipc - IPC transport for nng - -== SYNOPSIS - -[source,c] ----------- -#include <nng/transport/ipc/ipc.h> - -int nng_ipc_register(void); ----------- - -== DESCRIPTION - -The _nng_ipc_ transport provides communication support between -_nng_ sockets within different processes on the same host. For POSIX -platforms, this is implemented using UNIX domain sockets. For Windows, -this is implemented using Windows Named Pipes. Other platforms may -have different implementation strategies. - -// We need to insert a reference to the nanomsg RFC. - -=== Registration - -The _ipc_ transport is generally built-in to the _nng_ core, so -no extra steps to use it should be necessary. - -=== URI Format - -This transport uses URIs using the scheme `ipc://`, followed by -a an absolute path name in the file system where the socket or named pipe -should be created. - -TIP: On Windows, all names are prefixed by `\.\pipe\` and do not -occupy the normal file system. On POSIX platforms, the path is -taken literally, and is relative to the root directory. - -=== Socket Address - -When using an `nng_sockaddr` structure, the actual structure is of type -`nng_sockaddr_ipc`. This is a `struct` type with the following definition: - -[source,c] --------- -#define NNG_AF_IPC 2 <1> -#define NNG_MAXADDRLEN 128 - -typedef struct { - // ... <2> - uint16_t sa_family; // must be NNG_AF_IPC - char sa_path[NNG_MAXADDRLEN]; // arbitrary "path" - // ... -} nng_sockaddr_ipc; --------- -<1> The values of these macros may change, so applications -should avoid depending upon their values and instead use them symbolically. -<2> Other members may be present, but only those listed here -are suitable for application use. - -The `sa_family` member will have the value `NNG_AF_IPC`. -The `sa_path` member is an ASCIIZ string, and may contain any legal -path name (platform-dependent), terminated by a `NUL` byte. - -=== Transport Options - -The _ipc_ transport has no special -options.footnote:[Options for security attributes and credentials are planned.] - -== SEE ALSO - -<<nng#,nng(7)>> |
