summaryrefslogtreecommitdiff
path: root/ref/proto/push.html
diff options
context:
space:
mode:
authorgdamore <gdamore@users.noreply.github.com>2025-10-09 02:03:21 +0000
committergdamore <gdamore@users.noreply.github.com>2025-10-09 02:03:21 +0000
commita35e8745f354e5569a4416869e755934fff717b4 (patch)
treea0434619eaa257f31f2a92bf97efb79f719558bc /ref/proto/push.html
parent426ace3a013e7bc779686689d41f011178a26cc6 (diff)
downloadnng-a35e8745f354e5569a4416869e755934fff717b4.tar.gz
nng-a35e8745f354e5569a4416869e755934fff717b4.tar.bz2
nng-a35e8745f354e5569a4416869e755934fff717b4.zip
deploy: bdf85dd692d803b7b2fc793f1c7723f9874bfcdb
Diffstat (limited to 'ref/proto/push.html')
-rw-r--r--ref/proto/push.html20
1 files changed, 16 insertions, 4 deletions
diff --git a/ref/proto/push.html b/ref/proto/push.html
index 6f8aa876..f21f87f5 100644
--- a/ref/proto/push.html
+++ b/ref/proto/push.html
@@ -246,14 +246,14 @@
<h1 id="push-protocol"><a class="header" href="#push-protocol">PUSH protocol</a></h1>
<h2 id="description"><a class="header" href="#description">DESCRIPTION</a></h2>
<p>The <a name="a001"></a><em>PUSH</em> protocol<a name="a002"></a> is one half of a <a name="a003"></a>pipeline pattern.
-The other side is the <a href="./pull.html"><em>PULL</em></a> protocol.</p>
+The other side is the <a href="../proto/pull.html"><em>PULL</em></a> protocol.</p>
<p>In the pipeline pattern, pushers distribute messages to pullers.
Each message sent by a pusher will be sent to one of its peer pullers,
chosen in a round-robin fashion
from the set of connected peers available for receiving.
This property makes this pattern useful in <a name="a004"></a>load-balancing scenarios.</p>
<h3 id="socket-operations"><a class="header" href="#socket-operations">Socket Operations</a></h3>
-<p>The <a href="TODO.html"><code>nng_push0_open</code></a> call creates a <em>PUSH</em> socket.
+<p>The <a href="../api/sock.html#opening-a-socket"><code>nng_push0_open</code></a> function creates a <em>PUSH</em> socket.
This socket may be used to send messages, but is unable to receive them.
Attempts to receive messages will result in <code>NNG_ENOTSUP</code>.</p>
<p>Send operations will observe flow control (back-pressure), so that
@@ -269,14 +269,14 @@ wait until one is available, or the operation times out.</p>
to avoid dropping messages, no guarantee of delivery is made.
Furthermore, as there is no capability for message acknowledgment,
applications that need reliable delivery are encouraged to consider the
-<a href="./req.html"><em>REQ</em></a> protocol instead.</p>
+<a href="../proto/req.html"><em>REQ</em></a> protocol instead.</p>
</div>
<h3 id="protocol-versions"><a class="header" href="#protocol-versions">Protocol Versions</a></h3>
<p>Only version 0 of this protocol is supported.
(At the time of writing, no other versions of this protocol have been defined.)</p>
<h3 id="protocol-options"><a class="header" href="#protocol-options">Protocol Options</a></h3>
<ul>
-<li><a href="TODO.html"><code>NNG_OPT_SENDBUF</code></a>:
+<li><a href="../api/sock.html#NNG_OPT_SENDBUF"><code>NNG_OPT_SENDBUF</code></a>:
(<code>int</code>, 0 - 8192)
Normally this is set to zero, indicating that send operations are unbuffered.
In unbuffered operation, send operations will wait until a suitable peer is available to receive the message.
@@ -293,6 +293,18 @@ buffer determined by this option.</p>
</div>
<h3 id="protocol-headers"><a class="header" href="#protocol-headers">Protocol Headers</a></h3>
<p>The <em>PUSH</em> protocol has no protocol-specific headers.</p>
+<!-- NOTE: This assumes that any page referencing this is located
+ in a directory two levels down. Meaning ./api/somefile.md or
+ similar. mdbook cannot accommodate links that are called from
+ different levels in the hierarchy. -->
+<!-- Symbol cross reference -->
+<!-- HTTP -->
+<!-- HTTP Status -->
+<!-- TLS -->
+<!-- Macros -->
+<!-- Protocols -->
+<!-- Transports -->
+<!-- Concept index -->
</main>