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.

1 files changed, 223 insertions, 214 deletions

diff --git a/tests/pair1.c b/tests/pair1.c
index bff6a44b..ef3fe263 100644
--- a/tests/pair1.c
+++ b/tests/pair1.c
@@ -101,14 +101,8 @@ TestMain("PAIRv1 protocol", {
 		});
 
 		Convey("Cannot set raw mode after connect", {
-			So(nng_listen(s1, addr, NULL, 0) == 0);
-			So(nng_dial(c1, addr, NULL, 0) == 0);
-			nng_msleep(100);
-
 			So(nng_setopt_bool(s1, NNG_OPT_RAW, true) ==
-			    NNG_ESTATE);
-			So(nng_setopt_bool(c1, NNG_OPT_RAW, false) ==
-			    NNG_ESTATE);
+			    NNG_EREADONLY);
 		});
 
 		Convey("Polyamorous mode is best effort", {
@@ -176,150 +170,6 @@ TestMain("PAIRv1 protocol", {
 			    NNG_ESTATE);
 		});
 
-		Convey("Monogamous raw mode works", {
-			nng_msg *msg;
-			uint32_t hops;
-
-			So(nng_setopt_bool(s1, NNG_OPT_RAW, true) == 0);
-			So(nng_setopt_bool(c1, NNG_OPT_RAW, true) == 0);
-			So(nng_setopt_bool(c2, NNG_OPT_RAW, true) == 0);
-
-			So(nng_listen(s1, addr, NULL, 0) == 0);
-			So(nng_dial(c1, addr, NULL, 0) == 0);
-			nng_msleep(20);
-
-			Convey("Send/recv work", {
-				So(nng_msg_alloc(&msg, 0) == 0);
-				APPENDSTR(msg, "GAMMA");
-				So(nng_msg_header_append_u32(msg, 1) == 0);
-				So(nng_msg_header_len(msg) ==
-				    sizeof(uint32_t));
-				So(nng_sendmsg(c1, msg, 0) == 0);
-				So(nng_recvmsg(s1, &msg, 0) == 0);
-				So(nng_msg_get_pipe(msg) != 0);
-				CHECKSTR(msg, "GAMMA");
-				So(nng_msg_header_len(msg) ==
-				    sizeof(uint32_t));
-				So(nng_msg_header_trim_u32(msg, &hops) == 0);
-				So(hops == 2);
-				nng_msg_free(msg);
-
-				So(nng_msg_alloc(&msg, 0) == 0);
-				APPENDSTR(msg, "EPSILON");
-				So(nng_msg_header_append_u32(msg, 1) == 0);
-				So(nng_sendmsg(s1, msg, 0) == 0);
-				So(nng_recvmsg(c1, &msg, 0) == 0);
-				CHECKSTR(msg, "EPSILON");
-				So(nng_msg_header_len(msg) ==
-				    sizeof(uint32_t));
-				So(nng_msg_header_trim_u32(msg, &hops) == 0);
-				So(nng_msg_get_pipe(msg) != 0);
-				So(hops == 2);
-				nng_msg_free(msg);
-			});
-
-			Convey("Missing raw header fails", {
-				So(nng_msg_alloc(&msg, 0) == 0);
-				So(nng_sendmsg(c1, msg, 0) == 0);
-				So(nng_recvmsg(s1, &msg, 0) == NNG_ETIMEDOUT);
-
-				So(nng_msg_alloc(&msg, 0) == 0);
-				So(nng_msg_append_u32(msg, 0xFEEDFACE) == 0);
-				So(nng_msg_header_append_u32(msg, 1) == 0);
-				So(nng_sendmsg(c1, msg, 0) == 0);
-				So(nng_recvmsg(s1, &msg, 0) == 0);
-				So(nng_msg_trim_u32(msg, &v) == 0);
-				So(v == 0xFEEDFACE);
-				nng_msg_free(msg);
-			});
-
-			Convey("Reserved bits in raw header", {
-
-				Convey("Nonzero bits fail", {
-					So(nng_msg_alloc(&msg, 0) == 0);
-					So(nng_msg_header_append_u32(
-					       msg, 0xDEAD0000) == 0);
-					So(nng_sendmsg(c1, msg, 0) == 0);
-					So(nng_recvmsg(s1, &msg, 0) ==
-					    NNG_ETIMEDOUT);
-				});
-				Convey("Zero bits pass", {
-					So(nng_msg_alloc(&msg, 0) == 0);
-					So(nng_msg_append_u32(
-					       msg, 0xFEEDFACE) == 0);
-					So(nng_msg_header_append_u32(msg, 1) ==
-					    0);
-					So(nng_sendmsg(c1, msg, 0) == 0);
-					So(nng_recvmsg(s1, &msg, 0) == 0);
-					So(nng_msg_trim_u32(msg, &v) == 0);
-					So(v == 0xFEEDFACE);
-					nng_msg_free(msg);
-				});
-			});
-
-			Convey("TTL is honored", {
-				int ttl;
-
-				So(nng_setopt_int(s1, NNG_OPT_MAXTTL, 4) == 0);
-				So(nng_getopt_int(s1, NNG_OPT_MAXTTL, &ttl) ==
-				    0);
-				So(ttl == 4);
-				Convey("Bad TTL bounces", {
-					So(nng_msg_alloc(&msg, 0) == 0);
-					So(nng_msg_header_append_u32(msg, 4) ==
-					    0);
-					So(nng_sendmsg(c1, msg, 0) == 0);
-					So(nng_recvmsg(s1, &msg, 0) ==
-					    NNG_ETIMEDOUT);
-				});
-				Convey("Good TTL passes", {
-					So(nng_msg_alloc(&msg, 0) == 0);
-					So(nng_msg_append_u32(
-					       msg, 0xFEEDFACE) == 0);
-					So(nng_msg_header_append_u32(msg, 3) ==
-					    0);
-					So(nng_sendmsg(c1, msg, 0) == 0);
-					So(nng_recvmsg(s1, &msg, 0) == 0);
-					So(nng_msg_trim_u32(msg, &v) == 0);
-					So(v == 0xFEEDFACE);
-					So(nng_msg_header_trim_u32(msg, &v) ==
-					    0);
-					So(v == 4);
-					nng_msg_free(msg);
-				});
-
-				Convey("Large TTL passes", {
-					ttl = 0xff;
-					So(nng_setopt_int(
-					       s1, NNG_OPT_MAXTTL, 0xff) == 0);
-					So(nng_msg_alloc(&msg, 0) == 0);
-					So(nng_msg_append_u32(msg, 1234) == 0);
-					So(nng_msg_header_append_u32(
-					       msg, 0xfe) == 0);
-					So(nng_sendmsg(c1, msg, 0) == 0);
-					So(nng_recvmsg(s1, &msg, 0) == 0);
-					So(nng_msg_trim_u32(msg, &v) == 0);
-					So(v == 1234);
-					So(nng_msg_header_trim_u32(msg, &v) ==
-					    0);
-					So(v == 0xff);
-					nng_msg_free(msg);
-				});
-
-				Convey("Max TTL fails", {
-					ttl = 0xff;
-					So(nng_setopt_int(
-					       s1, NNG_OPT_MAXTTL, 0xff) == 0);
-					So(nng_msg_alloc(&msg, 0) == 0);
-					So(nng_msg_header_append_u32(
-					       msg, 0xff) == 0);
-					So(nng_sendmsg(c1, msg, 0) == 0);
-					So(nng_recvmsg(s1, &msg, 0) ==
-					    NNG_ETIMEDOUT);
-				});
-			});
-		});
-
 		Convey("We cannot set insane TTLs", {
 			int ttl;
 
@@ -428,94 +278,253 @@ TestMain("PAIRv1 protocol", {
 			CHECKSTR(msg, "AGAIN");
 			nng_msg_free(msg);
 		});
+	});
 
-		Convey("Polyamorous raw mode works", {
-			nng_msg *msg;
-			bool     v;
-			uint32_t hops;
-			nng_pipe p1;
-			nng_pipe p2;
+	Convey("Monogamous raw mode works", {
+		nng_msg *msg;
+		uint32_t hops;
 
-			So(nng_getopt_bool(s1, NNG_OPT_PAIR1_POLY, &v) == 0);
-			So(v == 0);
+		So(nng_pair1_open_raw(&s1) == 0);
+		So(nng_pair1_open_raw(&c1) == 0);
+		So(nng_pair1_open_raw(&c2) == 0);
 
-			So(nng_setopt_bool(s1, NNG_OPT_PAIR1_POLY, true) == 0);
-			So(nng_getopt_bool(s1, NNG_OPT_PAIR1_POLY, &v) == 0);
-			So(v == true);
+		Reset({
+			nng_close(s1);
+			nng_close(c1);
+			nng_close(c2);
+		});
 
-			v = false;
-			So(nng_setopt_bool(s1, NNG_OPT_RAW, true) == 0);
-			So(nng_getopt_bool(s1, NNG_OPT_RAW, &v) == 0);
-			So(v == true);
+		tmo = MILLISECOND(300);
+		So(nng_setopt_ms(s1, NNG_OPT_RECVTIMEO, tmo) == 0);
+		So(nng_setopt_ms(c1, NNG_OPT_RECVTIMEO, tmo) == 0);
+		So(nng_setopt_ms(c2, NNG_OPT_RECVTIMEO, tmo) == 0);
+		tmo = 0;
+		So(nng_getopt_ms(s1, NNG_OPT_RECVTIMEO, &tmo) == 0);
+		So(tmo == MILLISECOND(300));
 
-			So(nng_listen(s1, addr, NULL, 0) == 0);
-			So(nng_dial(c1, addr, NULL, 0) == 0);
-			So(nng_dial(c2, addr, NULL, 0) == 0);
-			nng_msleep(20);
+		So(nng_listen(s1, addr, NULL, 0) == 0);
+		So(nng_dial(c1, addr, NULL, 0) == 0);
+		nng_msleep(20);
+
+		Convey("Send/recv work", {
+			So(nng_msg_alloc(&msg, 0) == 0);
+			APPENDSTR(msg, "GAMMA");
+			So(nng_msg_header_append_u32(msg, 1) == 0);
+			So(nng_msg_header_len(msg) == sizeof(uint32_t));
+			So(nng_sendmsg(c1, msg, 0) == 0);
+			So(nng_recvmsg(s1, &msg, 0) == 0);
+			So(nng_msg_get_pipe(msg) != 0);
+			CHECKSTR(msg, "GAMMA");
+			So(nng_msg_header_len(msg) == sizeof(uint32_t));
+			So(nng_msg_header_trim_u32(msg, &hops) == 0);
+			So(hops == 2);
+			nng_msg_free(msg);
+
+			So(nng_msg_alloc(&msg, 0) == 0);
+			APPENDSTR(msg, "EPSILON");
+			So(nng_msg_header_append_u32(msg, 1) == 0);
+			So(nng_sendmsg(s1, msg, 0) == 0);
+			So(nng_recvmsg(c1, &msg, 0) == 0);
+			CHECKSTR(msg, "EPSILON");
+			So(nng_msg_header_len(msg) == sizeof(uint32_t));
+			So(nng_msg_header_trim_u32(msg, &hops) == 0);
+			So(nng_msg_get_pipe(msg) != 0);
+			So(hops == 2);
+			nng_msg_free(msg);
+		});
+
+		Convey("Missing raw header fails", {
+			So(nng_msg_alloc(&msg, 0) == 0);
+			So(nng_sendmsg(c1, msg, 0) == 0);
+			So(nng_recvmsg(s1, &msg, 0) == NNG_ETIMEDOUT);
+
+			So(nng_msg_alloc(&msg, 0) == 0);
+			So(nng_msg_append_u32(msg, 0xFEEDFACE) == 0);
+			So(nng_msg_header_append_u32(msg, 1) == 0);
+			So(nng_sendmsg(c1, msg, 0) == 0);
+			So(nng_recvmsg(s1, &msg, 0) == 0);
+			So(nng_msg_trim_u32(msg, &v) == 0);
+			So(v == 0xFEEDFACE);
+			nng_msg_free(msg);
+		});
 
-			Convey("Send/recv works", {
+		Convey("Reserved bits in raw header", {
+
+			Convey("Nonzero bits fail", {
 				So(nng_msg_alloc(&msg, 0) == 0);
-				APPENDSTR(msg, "ONE");
+				So(nng_msg_header_append_u32(
+				       msg, 0xDEAD0000) == 0);
 				So(nng_sendmsg(c1, msg, 0) == 0);
-				So(nng_recvmsg(s1, &msg, 0) == 0);
-				CHECKSTR(msg, "ONE");
-				p1 = nng_msg_get_pipe(msg);
-				So(p1 != 0);
-				So(nng_msg_header_trim_u32(msg, &hops) == 0);
-				So(hops == 1);
-				nng_msg_free(msg);
-
+				So(nng_recvmsg(s1, &msg, 0) == NNG_ETIMEDOUT);
+			});
+			Convey("Zero bits pass", {
 				So(nng_msg_alloc(&msg, 0) == 0);
-				APPENDSTR(msg, "TWO");
-				So(nng_sendmsg(c2, msg, 0) == 0);
+				So(nng_msg_append_u32(msg, 0xFEEDFACE) == 0);
+				So(nng_msg_header_append_u32(msg, 1) == 0);
+				So(nng_sendmsg(c1, msg, 0) == 0);
 				So(nng_recvmsg(s1, &msg, 0) == 0);
-				CHECKSTR(msg, "TWO");
-				p2 = nng_msg_get_pipe(msg);
-				So(p2 != 0);
-				So(nng_msg_header_trim_u32(msg, &hops) == 0);
-				So(hops == 1);
+				So(nng_msg_trim_u32(msg, &v) == 0);
+				So(v == 0xFEEDFACE);
 				nng_msg_free(msg);
+			});
+		});
 
-				So(p1 != p2);
+		Convey("TTL is honored", {
+			int ttl;
 
+			So(nng_setopt_int(s1, NNG_OPT_MAXTTL, 4) == 0);
+			So(nng_getopt_int(s1, NNG_OPT_MAXTTL, &ttl) == 0);
+			So(ttl == 4);
+			Convey("Bad TTL bounces", {
 				So(nng_msg_alloc(&msg, 0) == 0);
-				nng_msg_set_pipe(msg, p1);
-				APPENDSTR(msg, "UNO");
-				So(nng_msg_header_append_u32(msg, 1) == 0);
-				So(nng_sendmsg(s1, msg, 0) == 0);
-				So(nng_recvmsg(c1, &msg, 0) == 0);
-				CHECKSTR(msg, "UNO");
-				nng_msg_free(msg);
-
+				So(nng_msg_header_append_u32(msg, 4) == 0);
+				So(nng_sendmsg(c1, msg, 0) == 0);
+				So(nng_recvmsg(s1, &msg, 0) == NNG_ETIMEDOUT);
+			});
+			Convey("Good TTL passes", {
 				So(nng_msg_alloc(&msg, 0) == 0);
-				nng_msg_set_pipe(msg, p2);
-				APPENDSTR(msg, "DOS");
-				So(nng_msg_header_append_u32(msg, 1) == 0);
-				So(nng_sendmsg(s1, msg, 0) == 0);
-				So(nng_recvmsg(c2, &msg, 0) == 0);
-				CHECKSTR(msg, "DOS");
+				So(nng_msg_append_u32(msg, 0xFEEDFACE) == 0);
+				So(nng_msg_header_append_u32(msg, 3) == 0);
+				So(nng_sendmsg(c1, msg, 0) == 0);
+				So(nng_recvmsg(s1, &msg, 0) == 0);
+				So(nng_msg_trim_u32(msg, &v) == 0);
+				So(v == 0xFEEDFACE);
+				So(nng_msg_header_trim_u32(msg, &v) == 0);
+				So(v == 4);
 				nng_msg_free(msg);
 			});
 
-			Convey("Closed pipes don't work", {
+			Convey("Large TTL passes", {
+				ttl = 0xff;
+				So(nng_setopt_int(s1, NNG_OPT_MAXTTL, 0xff) ==
+				    0);
 				So(nng_msg_alloc(&msg, 0) == 0);
-				APPENDSTR(msg, "ONE");
+				So(nng_msg_append_u32(msg, 1234) == 0);
+				So(nng_msg_header_append_u32(msg, 0xfe) == 0);
 				So(nng_sendmsg(c1, msg, 0) == 0);
 				So(nng_recvmsg(s1, &msg, 0) == 0);
-				CHECKSTR(msg, "ONE");
-				p1 = nng_msg_get_pipe(msg);
-				So(p1 != 0);
+				So(nng_msg_trim_u32(msg, &v) == 0);
+				So(v == 1234);
+				So(nng_msg_header_trim_u32(msg, &v) == 0);
+				So(v == 0xff);
 				nng_msg_free(msg);
+			});
 
-				nng_close(c1);
-
+			Convey("Max TTL fails", {
+				ttl = 0xff;
+				So(nng_setopt_int(s1, NNG_OPT_MAXTTL, 0xff) ==
+				    0);
 				So(nng_msg_alloc(&msg, 0) == 0);
-				nng_msg_set_pipe(msg, p1);
-				APPENDSTR(msg, "EIN");
-				So(nng_msg_header_append_u32(msg, 1) == 0);
-				So(nng_sendmsg(s1, msg, 0) == 0);
-				So(nng_recvmsg(c2, &msg, 0) == NNG_ETIMEDOUT);
+				So(nng_msg_header_append_u32(msg, 0xff) == 0);
+				So(nng_sendmsg(c1, msg, 0) == 0);
+				So(nng_recvmsg(s1, &msg, 0) == NNG_ETIMEDOUT);
 			});
 		});
 	});
+
+	Convey("Polyamorous raw mode works", {
+		nng_msg *msg;
+		bool     v;
+		uint32_t hops;
+		nng_pipe p1;
+		nng_pipe p2;
+
+		So(nng_pair1_open_raw(&s1) == 0);
+		So(nng_pair1_open(&c1) == 0);
+		So(nng_pair1_open(&c2) == 0);
+
+		Reset({
+			nng_close(s1);
+			nng_close(c1);
+			nng_close(c2);
+		});
+
+		tmo = MILLISECOND(300);
+		So(nng_setopt_ms(s1, NNG_OPT_RECVTIMEO, tmo) == 0);
+		So(nng_setopt_ms(c1, NNG_OPT_RECVTIMEO, tmo) == 0);
+		So(nng_setopt_ms(c2, NNG_OPT_RECVTIMEO, tmo) == 0);
+		tmo = 0;
+		So(nng_getopt_ms(s1, NNG_OPT_RECVTIMEO, &tmo) == 0);
+		So(tmo == MILLISECOND(300));
+
+		So(nng_getopt_bool(s1, NNG_OPT_PAIR1_POLY, &v) == 0);
+		So(v == 0);
+
+		So(nng_setopt_bool(s1, NNG_OPT_PAIR1_POLY, true) == 0);
+		So(nng_getopt_bool(s1, NNG_OPT_PAIR1_POLY, &v) == 0);
+		So(v == true);
+
+		v = false;
+		So(nng_getopt_bool(s1, NNG_OPT_RAW, &v) == 0);
+		So(v == true);
+
+		So(nng_listen(s1, addr, NULL, 0) == 0);
+		So(nng_dial(c1, addr, NULL, 0) == 0);
+		So(nng_dial(c2, addr, NULL, 0) == 0);
+		nng_msleep(20);
+
+		Convey("Send/recv works", {
+			So(nng_msg_alloc(&msg, 0) == 0);
+			APPENDSTR(msg, "ONE");
+			So(nng_sendmsg(c1, msg, 0) == 0);
+			So(nng_recvmsg(s1, &msg, 0) == 0);
+			CHECKSTR(msg, "ONE");
+			p1 = nng_msg_get_pipe(msg);
+			So(p1 != 0);
+			So(nng_msg_header_trim_u32(msg, &hops) == 0);
+			So(hops == 1);
+			nng_msg_free(msg);
+
+			So(nng_msg_alloc(&msg, 0) == 0);
+			APPENDSTR(msg, "TWO");
+			So(nng_sendmsg(c2, msg, 0) == 0);
+			So(nng_recvmsg(s1, &msg, 0) == 0);
+			CHECKSTR(msg, "TWO");
+			p2 = nng_msg_get_pipe(msg);
+			So(p2 != 0);
+			So(nng_msg_header_trim_u32(msg, &hops) == 0);
+			So(hops == 1);
+			nng_msg_free(msg);
+
+			So(p1 != p2);
+
+			So(nng_msg_alloc(&msg, 0) == 0);
+			nng_msg_set_pipe(msg, p1);
+			APPENDSTR(msg, "UNO");
+			So(nng_msg_header_append_u32(msg, 1) == 0);
+			So(nng_sendmsg(s1, msg, 0) == 0);
+			So(nng_recvmsg(c1, &msg, 0) == 0);
+			CHECKSTR(msg, "UNO");
+			nng_msg_free(msg);
+
+			So(nng_msg_alloc(&msg, 0) == 0);
+			nng_msg_set_pipe(msg, p2);
+			APPENDSTR(msg, "DOS");
+			So(nng_msg_header_append_u32(msg, 1) == 0);
+			So(nng_sendmsg(s1, msg, 0) == 0);
+			So(nng_recvmsg(c2, &msg, 0) == 0);
+			CHECKSTR(msg, "DOS");
+			nng_msg_free(msg);
+		});
+
+		Convey("Closed pipes don't work", {
+			So(nng_msg_alloc(&msg, 0) == 0);
+			APPENDSTR(msg, "ONE");
+			So(nng_sendmsg(c1, msg, 0) == 0);
+			So(nng_recvmsg(s1, &msg, 0) == 0);
+			CHECKSTR(msg, "ONE");
+			p1 = nng_msg_get_pipe(msg);
+			So(p1 != 0);
+			nng_msg_free(msg);
+
+			nng_close(c1);
+
+			So(nng_msg_alloc(&msg, 0) == 0);
+			nng_msg_set_pipe(msg, p1);
+			APPENDSTR(msg, "EIN");
+			So(nng_msg_header_append_u32(msg, 1) == 0);
+			So(nng_sendmsg(s1, msg, 0) == 0);
+			So(nng_recvmsg(c2, &msg, 0) == NNG_ETIMEDOUT);
+		});
+	});
 })