diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-10-13 21:58:17 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-10-13 21:58:17 -0700 |
| commit | 1f10707dd49b70d316be320cc798d98d0d7e46f6 (patch) | |
| tree | 545ab4537da1a74efb75f59eb79de7ae8b6b780a /docs | |
| parent | b5ed36cabc3ffd16953665642a7bac6738c90ee8 (diff) | |
| download | nng-1f10707dd49b70d316be320cc798d98d0d7e46f6.tar.gz nng-1f10707dd49b70d316be320cc798d98d0d7e46f6.tar.bz2 nng-1f10707dd49b70d316be320cc798d98d0d7e46f6.zip | |
docs: nng_msg_pipe converted to mdbook
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/man/libnng.3.adoc | 4 | ||||
| -rw-r--r-- | docs/man/nng_msg_get_pipe.3.adoc | 60 | ||||
| -rw-r--r-- | docs/man/nng_msg_set_pipe.3.adoc | 50 | ||||
| -rw-r--r-- | docs/ref/SUMMARY.md | 1 | ||||
| -rw-r--r-- | docs/ref/api/msg/index.md | 1 |
5 files changed, 4 insertions, 112 deletions
diff --git a/docs/man/libnng.3.adoc b/docs/man/libnng.3.adoc index 7f1850cc..7187446b 100644 --- a/docs/man/libnng.3.adoc +++ b/docs/man/libnng.3.adoc @@ -106,12 +106,12 @@ Most applications will only interact with the body. // |xref:nng_msg_clear.3.adoc[nng_msg_clear()]|clear message body // |xref:nng_msg_dup.3.adoc[nng_msg_dup()]|duplicate a message // |xref:nng_msg_free.3.adoc[nng_msg_free()]|free a message -|xref:nng_msg_get_pipe.3.adoc[nng_msg_get_pipe()]|get pipe for message +// |xref:nng_msg_get_pipe.3.adoc[nng_msg_get_pipe()]|get pipe for message // |xref:nng_msg_insert.3.adoc[nng_msg_insert()]|prepend to message body // |xref:nng_msg_len.3.adoc[nng_msg_len()]|return the message body length // |xref:nng_msg_realloc.3.adoc[nng_msg_realloc()]|reallocate a message // |xref:nng_msg_reserve.3.adoc[nng_msg_reserve()]|reserve storage for message body -|xref:nng_msg_set_pipe.3.adoc[nng_msg_set_pipe()]|set pipe for message +// |xref:nng_msg_set_pipe.3.adoc[nng_msg_set_pipe()]|set pipe for message // |xref:nng_msg_trim.3.adoc[nng_msg_trim()]|remove data from start of message body |xref:nng_recvmsg.3.adoc[nng_recvmsg()]|receive a message |xref:nng_sendmsg.3.adoc[nng_sendmsg()]|send a message diff --git a/docs/man/nng_msg_get_pipe.3.adoc b/docs/man/nng_msg_get_pipe.3.adoc deleted file mode 100644 index ed387395..00000000 --- a/docs/man/nng_msg_get_pipe.3.adoc +++ /dev/null @@ -1,60 +0,0 @@ -= nng_msg_get_pipe(3) -// -// 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_msg_get_pipe - get pipe for message - -== SYNOPSIS - -[source, c] ----- -#include <nng/nng.h> - -nng_pipe nng_msg_get_pipe(nng_msg *msg); ----- - -== DESCRIPTION - -The `nng_msg_get_pipe()` returns the xref:nng_pipe.5.adoc[`nng_pipe`] object -associated with message _msg_. -On receive, this is the pipe from which a message was received. -On transmit, this would be the pipe that the message should be delivered -to, if a specific peer is required. - -NOTE: Not all protocols support overriding the destination pipe. - -The most usual use case for this is to obtain information about the peer -from which the message was received. -This can be used to provide different behaviors for different peers, such as -a higher level of authentication for peers located on an untrusted network. -The xref:nng_pipe_get.3.adoc[`nng_pipe_get()`] function -is useful in this situation. - - -== RETURN VALUES - -This function returns the pipe associated with this message, which will -be a positive value. -If the pipe is non-positive, then that indicates that -no specific pipe is associated with the message. - -== ERRORS - -None. - -== SEE ALSO - -[.text-left] -xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], -xref:nng_msg_set_pipe.3.adoc[nng_msg_set_pipe(3)], -xref:nng_pipe_get.3.adoc[nng_pipe_get(3)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_msg_set_pipe.3.adoc b/docs/man/nng_msg_set_pipe.3.adoc deleted file mode 100644 index 9edcc516..00000000 --- a/docs/man/nng_msg_set_pipe.3.adoc +++ /dev/null @@ -1,50 +0,0 @@ -= nng_msg_set_pipe(3) -// -// Copyright 2019 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_msg_set_pipe - set pipe for message - -== SYNOPSIS - -[source, c] ----- -#include <nng/nng.h> - -void nng_msg_set_pipe(nng_msg *msg, nng_pipe p); ----- - -== DESCRIPTION - -The `nng_msg_set_pipe()` sets the pipe associated with message _m_ to _p_. -This is most often useful when used with protocols that support directing -a message to a specific peer. -For example the xref:nng_pair.7.adoc[_pair_] version 1 protocol can do -this when `NNG_OPT_PAIR1_POLY` mode is set. - -NOTE: Not all protocols support overriding the destination pipe. - -== RETURN VALUES - -None. - -== ERRORS - -None. - -== SEE ALSO - -[.text-left] -xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], -xref:nng_msg_get_pipe.3.adoc[nng_msg_get_pipe(3)], -xref:nng_pipe_get.3.adoc[nng_pipe_get(3)], -xref:nng_msg.5.adoc[nng_msg(5)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/ref/SUMMARY.md b/docs/ref/SUMMARY.md index 7079144f..d19bd8e0 100644 --- a/docs/ref/SUMMARY.md +++ b/docs/ref/SUMMARY.md @@ -11,6 +11,7 @@ - [nng_msg](./api/msg/nng_msg.md) - [nng_msg_body](./api/msg/nng_msg_body.md) - [nng_msg_header](./api/msg/nng_msg_header.md) + - [nng_msg_pipe](./api/msg/nng_msg_pipe.md) - [Threading and Synchronization](./api/thr/index.md) diff --git a/docs/ref/api/msg/index.md b/docs/ref/api/msg/index.md index 094c29b0..72f277d3 100644 --- a/docs/ref/api/msg/index.md +++ b/docs/ref/api/msg/index.md @@ -5,3 +5,4 @@ These interfaces deal with messages, used in the Scalability Protocols. - [nng_msg](./nng_msg.md) --- message - [nng_msg_body](./nng_msg_body.md) --- message body - [nng_msg_header](./nng_msg_header.md) --- message header +- [nng_msg_pipe](./nng_msg_pipe) --- message pipe |
