diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-03-09 18:42:28 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-03-09 18:42:28 -0800 |
| commit | 2c9d65e0b170f474d241a20a68579f6d31dc8408 (patch) | |
| tree | b65f6dd5cf3399a9cb7835988dc6bebccff071c6 /docs/man/nng_msg_set_pipe.adoc | |
| parent | beb47e74576091d51ad7dd1032e1628fecff416b (diff) | |
| download | nng-2c9d65e0b170f474d241a20a68579f6d31dc8408.tar.gz nng-2c9d65e0b170f474d241a20a68579f6d31dc8408.tar.bz2 nng-2c9d65e0b170f474d241a20a68579f6d31dc8408.zip | |
Add nng_msg_get_pipe, nng_msg_set_pipe, and nng_pipe_getopt docs.
Diffstat (limited to 'docs/man/nng_msg_set_pipe.adoc')
| -rw-r--r-- | docs/man/nng_msg_set_pipe.adoc | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/man/nng_msg_set_pipe.adoc b/docs/man/nng_msg_set_pipe.adoc new file mode 100644 index 00000000..845ca5a2 --- /dev/null +++ b/docs/man/nng_msg_set_pipe.adoc @@ -0,0 +1,48 @@ += 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_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 <<nng_pair#,nng_pair(7)>> version +1 protocol can do this when `NNG_OPT__POLYAMOROUS` mode is set. + +NOTE: Not all protocols support overriding the destination pipe. + +== RETURN VALUES + +None. + +== ERRORS + +None. + +== SEE ALSO + +<<nng_msg_alloc#,nng_msg_alloc(3)>>, +<<nng_msg_get_pipe#,nng_msg_get_pipe(3)>>, +<<nng_pipe_getopt#,nng_pipe_getopt(3)>>, +<<nng#,nng(7)>> +<<nng_getopt#,nng_getopt(3)>>, |
