summaryrefslogtreecommitdiff
path: root/docs/man/nng_pipe_dialer.3.adoc
blob: 476ab1bed2ca07c579622c17d91149573611f0b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
= nng_pipe_dialer(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_pipe_dialer - return dialer that created pipe

== SYNOPSIS

[source, c]
----
#include <nng/nng.h>

nng_dialer nng_pipe_dialer(nng_pipe p);
----

== DESCRIPTION

The `nng_pipe_dialer()` function returns the `<<nng_dialer.5#,nng_dialer>>`
that created the pipe _p_.
If the pipe was not created by a dialer, then the returned value will
have an identifier (`<<nng_dialer_id.3#,nng_dialer_id()>>`) of `-1`.

== RETURN VALUES

This function returns the dialer that created the pipe, unless it was
not created by a dialer, in which case a value initialized with
`NNG_DIALER_INITIALIZER` will be returned.

== ERRORS

None.

== SEE ALSO

<<nng_pipe.5#,nng_pipe(5)>>,
<<nng_dialer.5#,nng_dialer(5)>>,
<<nng.7#,nng(7)>>