aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_pair_open.3.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-04-04 12:37:34 -0700
committerGarrett D'Amore <garrett@damore.org>2018-04-04 13:13:24 -0700
commit45f455064b5704f3d5ed8ecf9f197a18fe72ee59 (patch)
tree76a626029f3a5a818b113b7e4342efaf6220a03f /docs/man/nng_pair_open.3.adoc
parent505a9bce029e51540739c853a6c9eef0ecfb2e90 (diff)
downloadnng-45f455064b5704f3d5ed8ecf9f197a18fe72ee59.tar.gz
nng-45f455064b5704f3d5ed8ecf9f197a18fe72ee59.tar.bz2
nng-45f455064b5704f3d5ed8ecf9f197a18fe72ee59.zip
fixes #331 replace NNG_OPT_RAW option with constructor
This makes the raw mode something that is immutable, determined at socket construction. This is an enabling change for the separate context support coming soon. As a result, this is an API breaking change for users of the raw mode option (NNG_OPT_RAW). There aren't many of them out there. Cooked mode is entirely unaffected. There are changes to tests and documentation included.
Diffstat (limited to 'docs/man/nng_pair_open.3.adoc')
-rw-r--r--docs/man/nng_pair_open.3.adoc9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/man/nng_pair_open.3.adoc b/docs/man/nng_pair_open.3.adoc
index 35bda5e5..054c3ffc 100644
--- a/docs/man/nng_pair_open.3.adoc
+++ b/docs/man/nng_pair_open.3.adoc
@@ -21,6 +21,8 @@ nng_pair_open - create pair socket
#include <nng/protocol/pair0/pair.h>
int nng_pair0_open(nng_socket *s);
+
+int nng_pair0_open_raw(nng_socket *s);
----
.Version 1
@@ -29,6 +31,8 @@ int nng_pair0_open(nng_socket *s);
#include <nng/protocol/pair1/pair.h>
int nng_pair1_open(nng_socket *s);
+
+int nng_pair1_open_raw(nng_socket *s);
----
== DESCRIPTION
@@ -37,6 +41,11 @@ The `nng_pair0_open()` and `nng_pair1_open()` functions
create a <<nng_pair.7#,_pair_>> version 0 or version 1
<<nng_socket.5#,socket>> and return it at the location pointed to by _s_.
+The `nng_pair0_open_raw()` and `nng_pair1_open_raw()` functions
+create a <<nng_pair.7#,_pair_>> version 0 or version 1
+<<nng_socket.5#,socket>> in
+<<nng.7#raw_mode,raw>> mode and return it at the location pointed to by _s_.
+
== RETURN VALUES
These functions returns 0 on success, and non-zero otherwise.