diff options
Diffstat (limited to 'docs/man/nng_msg_set_pipe.3.adoc')
| -rw-r--r-- | docs/man/nng_msg_set_pipe.3.adoc | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/docs/man/nng_msg_set_pipe.3.adoc b/docs/man/nng_msg_set_pipe.3.adoc new file mode 100644 index 00000000..68ca9305 --- /dev/null +++ b/docs/man/nng_msg_set_pipe.3.adoc @@ -0,0 +1,50 @@ += 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.7#,_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 + +<<nng_msg_alloc.3#,nng_msg_alloc(3)>>, +<<nng_msg_get_pipe.3#,nng_msg_get_pipe(3)>>, +<<nng_pipe_getopt.3#,nng_pipe_getopt(3)>>, +<<nng_msg.5#,nng_msg(5)>>, +<<nng.7#,nng(7)>> + |