summaryrefslogtreecommitdiff
path: root/docs/man
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-03-24 22:19:42 -0700
committerGarrett D'Amore <garrett@damore.org>2024-03-24 22:19:42 -0700
commit331bd5a7c360083f245fe6c82afa38dd05c4a9c9 (patch)
treef7a50976a4a6a717660d1c94a9808e896c3c2059 /docs/man
parent962553386968a528593665e228b9424de84d7f4e (diff)
downloadnng-331bd5a7c360083f245fe6c82afa38dd05c4a9c9.tar.gz
nng-331bd5a7c360083f245fe6c82afa38dd05c4a9c9.tar.bz2
nng-331bd5a7c360083f245fe6c82afa38dd05c4a9c9.zip
More org stuff
Diffstat (limited to 'docs/man')
-rw-r--r--docs/man/nng_pub.7.adoc69
-rw-r--r--docs/man/nng_version.3.adoc58
2 files changed, 0 insertions, 127 deletions
diff --git a/docs/man/nng_pub.7.adoc b/docs/man/nng_pub.7.adoc
deleted file mode 100644
index fcebd417..00000000
--- a/docs/man/nng_pub.7.adoc
+++ /dev/null
@@ -1,69 +0,0 @@
-= nng_pub(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_pub - publisher protocol
-
-== SYNOPSIS
-
-[source,c]
-----
-#include <nng/protocol/pubsub0/pub.h>
-----
-
-== DESCRIPTION
-
-(((protocol, _pub_)))
-The ((_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 _pub_ protocol is the publisher side, and the
-xref:nng_sub.7.adoc[_sub_] protocol is the subscriber side.
-
-NOTE: 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 xref:nng_pub_open.3.adoc[`nng_pub0_open()`] functions create 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 _pub_ protocol has no protocol-specific options.
-
-=== Protocol Headers
-
-The _pub_ protocol has no protocol-specific headers.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_pub_open.3.adoc[nng_pub_open(3)],
-xref:nng_sub.7.adoc[nng_sub(7)],
-xref:nng.7.adoc[nng(7)]
diff --git a/docs/man/nng_version.3.adoc b/docs/man/nng_version.3.adoc
deleted file mode 100644
index 8859a46a..00000000
--- a/docs/man/nng_version.3.adoc
+++ /dev/null
@@ -1,58 +0,0 @@
-= nng_version(3)
-//
-// Copyright 2020 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_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 _NNG_.
-
-Additionally, compile time version information is available
-via some predefined macros:
-
-[horizontal]
-((`NNG_MAJOR_VERSION`)):: Major version number.
-((`NNG_MINOR_VERSION`)):: Minor version number.
-((`NNG_PATCH_VERSION`)):: Patch version number.
-
-_NNG_ 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)) -- ((application 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
-
-Null-terminated string containing the library version number.
-
-== ERRORS
-
-None.
-
-== SEE ALSO
-
-[.text-left]
-xref:libnng.3.adoc[libnng(3)],
-xref:nng.7.adoc[nng(7)]