From 36f3a77ed6f9d47d5b3e1fcd93be76bfaf949b52 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Thu, 26 Oct 2017 14:16:38 -0700 Subject: man page updates for 0.0.0 --- man/v0.0.0/README.html | 2 +- man/v0.0.0/nng.html | 26 +- man/v0.0.0/nng_close.html | 5 +- man/v0.0.0/nng_inproc.html | 7 +- man/v0.0.0/nng_pub.html | 630 +++++++++++++++++++++++++++++++++++++++++++ man/v0.0.0/nng_zerotier.html | 11 +- 6 files changed, 660 insertions(+), 21 deletions(-) create mode 100644 man/v0.0.0/nng_pub.html diff --git a/man/v0.0.0/README.html b/man/v0.0.0/README.html index ab317eea..c27c9fc4 100644 --- a/man/v0.0.0/README.html +++ b/man/v0.0.0/README.html @@ -449,7 +449,7 @@ so there are still more options available.

diff --git a/man/v0.0.0/nng.html b/man/v0.0.0/nng.html index f23c9c2e..df405b45 100644 --- a/man/v0.0.0/nng.html +++ b/man/v0.0.0/nng.html @@ -471,7 +471,7 @@ to a lesser extent, new protocols.

The nng library is wire compatible with the SP protocols described in -the nanomsg project; projects using libnanomsg can interoperate with +the nanomsg project; projects using libnanomsg can inter-operate with nng as well as other conforming implementations. (One such implementation is the mangos. Applications using nng which wish to communicate with older libraries must ensure that they only @@ -492,19 +492,31 @@ other languages please check the website.

@@ -563,7 +575,7 @@ Copyright 2017 Capitar IT Group BV

diff --git a/man/v0.0.0/nng_close.html b/man/v0.0.0/nng_close.html index 4ab1d318..de2310cf 100644 --- a/man/v0.0.0/nng_close.html +++ b/man/v0.0.0/nng_close.html @@ -518,8 +518,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
#include <nng/nng.h>
 
-int
-nng_close (int s);
+int nng_close (int s);
@@ -596,7 +595,7 @@ Copyright 2017 Capitar IT Group BV

diff --git a/man/v0.0.0/nng_inproc.html b/man/v0.0.0/nng_inproc.html index 604c88e7..bb407933 100644 --- a/man/v0.0.0/nng_inproc.html +++ b/man/v0.0.0/nng_inproc.html @@ -518,8 +518,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
#include <nng/transport/inproc/inproc.h>
 
-int
-nng_inproc_register(void);
+int nng_inproc_register(void);
@@ -580,7 +579,7 @@ that URI.

The sa_family member will have the value NNG_AF_INPROC (1). -The sa_path member is an ASCIIZ string, and may contain any charaters, +The sa_path member is an ASCIIZ string, and may contain any characters, terminated by a NUL byte.

@@ -625,7 +624,7 @@ Copyright 2017 Capitar IT Group BV

diff --git a/man/v0.0.0/nng_pub.html b/man/v0.0.0/nng_pub.html new file mode 100644 index 00000000..f8e3acb8 --- /dev/null +++ b/man/v0.0.0/nng_pub.html @@ -0,0 +1,630 @@ +--- +version: 0.0.0 +layout: default +--- + + + + + + + + +nng_pub(7) + + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/protocol/pubsub/pubsub.h>
+
+#define NNG_PROTO_PUB_V0 32
+#define NNG_PROTO_PUB NNG_PROTO_PUB_V0
+
+int nng_pub_open(nng_socket *s);
+int nng_pub0_open (nng_socket *s);
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_pub protocol is one half of a publisher/subscriber pattern. +In this pattern, a publisher sends data, which is broadcast to all +subscribers. The subscribing applications only see the data to which +they have subscribed.

+
+
+

The nng_pub protocol is the publisher side, and the +nng_sub(7) protocol is the subscriber side.

+
+
+ + + + + +
+ + +In this implementation, the publisher delivers all messages to all +subscribers. The subscribers maintain their own subscriptions, and filter +them locally. Thus, this pattern should not be used in an attempt to +reduce bandwidth consumption. +
+
+
+

The topics that subscribers subscribe to is just the first part of +the message body. Applications should construct their messages +accordingly.

+
+
+

Socket Operations

+
+

The nng_pub_open() call creates a publisher socket. This socket +may be used to send messages, but is unable to receive them. Attempts +to receive messages will result in NNG_ENOTSUP.

+
+
+
+

Protocol Versions

+
+

Only version 0 of this protocol is supported. (At the time of writing, +no other versions of this protocol have been defined.)

+
+
+
+

Protocol Options

+
+

The nng_pub protocol has no protocol-specific options.

+
+
+
+

Protocol Headers

+
+

The nng_pub protocol has no protocol-specific headers.

+
+
+
+
+
+

AUTHORS

+ +
+
+

SEE ALSO

+ +
+
+ +
+
+

Copyright 2017 Garrett D’Amore
+Copyright 2017 Capitar IT Group BV

+
+
+

This document is supplied under the terms of the +MIT License.

+
+
+
+
+ + + diff --git a/man/v0.0.0/nng_zerotier.html b/man/v0.0.0/nng_zerotier.html index 36dab88a..44fd4715 100644 --- a/man/v0.0.0/nng_zerotier.html +++ b/man/v0.0.0/nng_zerotier.html @@ -518,8 +518,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
#include <nng/transport/zerotier/zerotier.h>
 
-int
-nng_zt_register(void);
+int nng_zt_register(void);
@@ -610,7 +609,7 @@ selected port address using the nng_listener_getopt function.

Listening nodes may also elide their own node number, as well as the -delimiter seperating the node number.

+delimiter separating the node number.

@@ -665,7 +664,7 @@ using the same node, or using separate nodes.

This is a string representing the "home directory", where the transport can store (and reuse) persistent state, such as key materials, node identity, and federation membership. This option must be set before the -ZeroTier transport is first used. If this value is empty, then an ephermal +ZeroTier transport is first used. If this value is empty, then an ephemeral ZeroTier node is created, and no persistent state is used. The default is to use an ephemeral node.

@@ -698,7 +697,7 @@ provides a uint64_t in native byte order representing the ZeroTier
NNG_OPT_ZT_NETWORK_STATUS
-

This is a read-ony integer, representing the ZeroTier network status. +

This is a read-only integer, representing the ZeroTier network status. Valid values for this are:

@@ -811,7 +810,7 @@ Copyright 2017 Capitar IT Group BV

-- cgit v1.2.3-70-g09d2