aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_sockaddr_ipc.5.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-03-15 08:40:17 -0700
committerGarrett D'Amore <garrett@damore.org>2018-03-17 08:49:12 -0700
commit98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86 (patch)
treee3cc06524b26fd0773d1742de82a00862f95c5f6 /docs/man/nng_sockaddr_ipc.5.adoc
parent91866ed9365ab89069c12da41c873c23d0ba1d19 (diff)
downloadnng-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_sockaddr_ipc.5.adoc')
-rw-r--r--docs/man/nng_sockaddr_ipc.5.adoc70
1 files changed, 70 insertions, 0 deletions
diff --git a/docs/man/nng_sockaddr_ipc.5.adoc b/docs/man/nng_sockaddr_ipc.5.adoc
new file mode 100644
index 00000000..3003d51e
--- /dev/null
+++ b/docs/man/nng_sockaddr_ipc.5.adoc
@@ -0,0 +1,70 @@
+= nng_sockaddr_ipc(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_sockaddr_ipc - IPC socket address
+
+== SYNOPSIS
+
+[source, c]
+----
+#include <nng/nng.h>
+
+enum sockaddr_family {
+ NNG_AF_IPC = 2,
+};
+
+typedef struct {
+ uint16_t sa_family;
+ uint16_t sa_path[128];
+} nng_sockaddr_ipc;
+----
+
+== DESCRIPTION
+
+(((socket, address, IPC)))
+An `nng_sockaddr_ipc` is the flavor of <<nng_sockaddr.5#,`nng_sockaddr`>>
+used to represent addresses associated with IPC communication
+using the <<nng_ipc.7#,_ipc_>> transport.
+
+The following structure members are present:
+
+`sa_family`::
+ This field will always have the value ((`NNG_AF_IPC`)).
+
+`sa_path`::
+ This field holds the C string corresponding to pathname where the
+ IPC socket is located.
+ For systems using UNIX domain sockets, this will be an absolute
+ pathname in the filesystem, where the UNIX domain socket is located.
+ For Windows systems, this is the pathname of the Named Pipe, without
+ the leading `\\.pipe\` portion, which will be automatically added.
+
+NOTE: At this time, there is no support for Linux "`abstract sockets`".
+
+TIP: In order to ensure maximum compatibility, applications should avoid
+hard coding the sizeof the `sa_path` member explicitly, but use the
+`sizeof` operator to determine its actual size at compile time.
+Furthermore, the size is guaranteed to be at least 128, but paths of
+this length may not be supported on all systems.
+
+NOTE: If compatibility with legacy _nanomsg_ applications is required,
+then pathnames must not be longer than 122 bytes, including the final
+`NUL` byte.
+This is because legacy versions of _nanomsg_ cannot express URLs
+longer than 128 bytes, including the `ipc://` prefix.
+
+== SEE ALSO
+
+<<nng_sockaddr.5#,nng_sockaddr(5)>>,
+<<nng_ipc.7#,nng_ipc(7)>>
+<<nng.7#,nng(7)>>