aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_pair.7.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-05-01 17:11:32 -0700
committerGarrett D'Amore <garrett@damore.org>2018-05-01 19:18:37 -0700
commit3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c (patch)
treed670fc9ac327e017c62a72cbaeda4bcacda5f9dd /docs/man/nng_pair.7.adoc
parent1ef281a7fbd544c6d3384fd8a71d10dc4bb081e8 (diff)
downloadnng-3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c.tar.gz
nng-3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c.tar.bz2
nng-3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c.zip
Markup fixes, ensuring links are colored properly.
It turns out that when creating cross references, we need to make any text styling (generally literal characters) outside of the link, to avoid having the styling override the link color. (We prefer to have links colored for ease of use.) While here a few other markup, and actual content, errors were fixed.
Diffstat (limited to 'docs/man/nng_pair.7.adoc')
-rw-r--r--docs/man/nng_pair.7.adoc18
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/man/nng_pair.7.adoc b/docs/man/nng_pair.7.adoc
index f03a4a5f..3d070d00 100644
--- a/docs/man/nng_pair.7.adoc
+++ b/docs/man/nng_pair.7.adoc
@@ -39,15 +39,15 @@ some additional sophistication in the application.
=== Socket Operations
-The <<nng_pair_open.3#,`nng_pair_open()`>> functions create _pair_ socket.
+The `<<nng_pair_open.3#,nng_pair_open()>>` functions create _pair_ socket.
Normally, this pattern will block when attempting to send a message if
no peer is able to receive the message.
NOTE: Even though this mode may appear to be "reliable", because back-pressure
prevents discarding messages most of the time, there are topologies involving
-_devices_ (see <<nng_device.3#,`nng_device()`>>) or raw mode sockets
-(see <<nng_options.5#NNG_OPT_RAW,`NNG_OPT_RAW`>>) where
+_devices_ (see `<<nng_device.3#,nng_device()>>`) or raw mode sockets
+(see `<<nng_options.5#NNG_OPT_RAW,NNG_OPT_RAW>>`) where
messages may be discarded.
Applications that require reliable delivery semantics should consider using
<<nng_req.7#,_req_>> sockets, or
@@ -68,7 +68,7 @@ including the legacy https://github.com/nanomsg/nanomsg[nanomsg] library or
https://github.com/go-mangos/mangos[mangos].
Version 1 of the protocol offers improved protection against loops when
-used with <<nng_device.3#,`nng_device()`>>.
+used with `<<nng_device.3#,nng_device()>>`.
It also offers _polyamorous_ mode for forming multiple partnerships
on a single socket.
@@ -84,11 +84,11 @@ In ((_polyamorous_ mode)), which is only available with version 1, a socket can
support many one-to-one connections.
In this mode, the application must
choose the remote peer to receive an ougoing message by setting the
-<<nng_pipe.5#,`nng_pipe`>> to use for the outgoing message with
-the <<nng_msg_set_pipe.3#,`nng_msg_set_pipe()`>> function.
+`<<nng_pipe.5#,nng_pipe>>` to use for the outgoing message with
+the `<<nng_msg_set_pipe.3#,nng_msg_set_pipe()>>` function.
Most often the value of the outgoing pipe will be obtained from an incoming
-message using the <<nng_msg_get_pipe.3#,`nng_msg_get_pipe()`>> function,
+message using the `<<nng_msg_get_pipe.3#,nng_msg_get_pipe()>>` function,
such as when replying to an incoming message.
In order to prevent head-of-line blocking, if the peer on the given pipe
@@ -106,7 +106,7 @@ The following protocol-specific options are available.
The value is read-write, and takes an integer boolean value. The default
false value (0) indicates that legacy monogamous mode should be used.
-<<nng_options.5#NNG_OPT_MAXTTL,`NNG_OPT_MAXTTL`>>::
+`<<nng_options.5#NNG_OPT_MAXTTL,NNG_OPT_MAXTTL>>`::
(`int`, version 1 only). Maximum time-to-live.
@@ -117,7 +117,7 @@ Version 0 of the pair protocol has no protocol-specific headers.
Version 1 of the pair protocol uses a single 32-bit unsigned value. The
low-order (big-endian) byte of this value contains a "hop" count, and is
used in conjuction with the
-<<nng_options.5#NNG_OPT_MAXTTL,`NNG_OPT_MAXTTL`>> option to guard against
+`<<nng_options.5#NNG_OPT_MAXTTL,NNG_OPT_MAXTTL>>` option to guard against
device forwarding loops.
This value is initialized to 1, and incremented each time the message is
received by a new node.