diff options
| author | Garrett D'Amore <garrett@damore.org> | 2020-02-06 19:12:55 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2020-02-07 18:53:20 -0800 |
| commit | f79eb9473fbee6207b3e992aa884b8913d7cdc46 (patch) | |
| tree | 5724eee808251a6fdec51b9d7a47550cb5852845 /docs/man/nng_pair_open.3.adoc | |
| parent | 28c38d4116ffe8a05123cf98f62f7a63fdd1c920 (diff) | |
| download | nng-f79eb9473fbee6207b3e992aa884b8913d7cdc46.tar.gz nng-f79eb9473fbee6207b3e992aa884b8913d7cdc46.tar.bz2 nng-f79eb9473fbee6207b3e992aa884b8913d7cdc46.zip | |
fixes #1189 Extract and deprecate polyamorous mode
Diffstat (limited to 'docs/man/nng_pair_open.3.adoc')
| -rw-r--r-- | docs/man/nng_pair_open.3.adoc | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/man/nng_pair_open.3.adoc b/docs/man/nng_pair_open.3.adoc index c61e6110..20348123 100644 --- a/docs/man/nng_pair_open.3.adoc +++ b/docs/man/nng_pair_open.3.adoc @@ -33,6 +33,8 @@ int nng_pair0_open_raw(nng_socket *s); int nng_pair1_open(nng_socket *s); int nng_pair1_open_raw(nng_socket *s); + +int nng_pair1_open_poly(nng_socktet *s); ---- == DESCRIPTION @@ -46,6 +48,12 @@ create a xref:nng_pair.7.adoc[_pair_] version 0 or version 1 xref:nng_socket.5.adoc[socket] in xref:nng.7.adoc#raw_mode[raw] mode and return it at the location pointed to by _s_. +The `nng_pair1_open_poly()` function opens a pair version 1 socket in +polyamorous mode. + +NOTE: Polyamorous mode is deprecated and should not be used in new applications. +The `nng_pair1_open_poly()` function will likely be removed in a future release. + == RETURN VALUES These functions returns 0 on success, and non-zero otherwise. |