diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-05-29 17:03:51 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-05-29 18:14:55 -0700 |
| commit | 0ddaee41ec753805fa12eeabd679870802528dac (patch) | |
| tree | 3418859f4f22e9857b5ae979b3bc4eb53fd70035 /docs/man/nng_pipe.5.adoc | |
| parent | 33dc5d611f578ace9833a80dc006a34b09da18af (diff) | |
| download | nng-0ddaee41ec753805fa12eeabd679870802528dac.tar.gz nng-0ddaee41ec753805fa12eeabd679870802528dac.tar.bz2 nng-0ddaee41ec753805fa12eeabd679870802528dac.zip | |
fixes #495 SEE ALSO should use [align=left]
fixes #494 ERRORS section should use [horizontal]
These changes address some basic formatting consistency things,
and ultimately (when combined with other tooling changes that are
not part of this repo) lead to vastly improved layout in the
printed documentation.
While here we removed trailing whitespace, and did certain other
minor markup tweaks.
Diffstat (limited to 'docs/man/nng_pipe.5.adoc')
| -rw-r--r-- | docs/man/nng_pipe.5.adoc | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/man/nng_pipe.5.adoc b/docs/man/nng_pipe.5.adoc index cf11c047..39807a84 100644 --- a/docs/man/nng_pipe.5.adoc +++ b/docs/man/nng_pipe.5.adoc @@ -28,7 +28,7 @@ typedef struct nng_pipe_s nng_pipe; An `nng_pipe` is a handle to a "`pipe`", which can be thought of as a single connection. (In most cases this is actually the case -- the pipe is an abstraction for a -single TCP or IPC connection.) +single TCP or IPC connection.) Pipes are associated with either the listener or dialer that created them, and therefore are also automatically associated with a single socket. @@ -37,7 +37,7 @@ for input parameters and return values), and should be treated opaquely. Passing structures this way ensures gives the compiler a chance to perform accurate type checks in functions passing values of this type. -TIP: Most applications should never concern themselves with individual pipes. +TIP: Most applications should never concern themselves with individual pipes. However it is possible to access a pipe when more information about the source of a message is needed, or when more control is required over message delivery. @@ -66,6 +66,7 @@ nng_pipe p = NNG_PIPE_INITIALIZER; == SEE ALSO +[.text-left] <<nng_msg_get_pipe.3#,nng_msg_get_pipe(3)>>, <<nng_pipe_close.3#,nng_pipe_close(3)>>, <<nng_pipe_getopt.3#,nng_pipe_getopt(3)>>, |
