Merge pull request #211 from simeyc/add-draft-apis

feat: support draft APIs ZMQ_HELLO_MSG, ZMQ_DISCONNECT_MSG and ZMQ_HICCUP_MSG

Author: pebbe

draft/socketget.go

@@ -691,7 +691,7 @@ func (soc *Socket) Getusefd() (int, error) {
 //
 // Returns OR'ed value of options
 //
-// Returns ErrorNotImplemented3 with ZeroMQ version < 4.3
+// Returns ErrorNotImplemented43 with ZeroMQ version < 4.3
 //
 // See https://libzmq.readthedocs.io/en/latest/zmq_getsockopt.html#_zmq_router_notify_retrieve_router_socket_notification_settings
 func (soc *Socket) GetRouterNotify() (RouterNotifyOption, error) {

draft/socketset.go

@@ -852,7 +852,7 @@ const (
 //
 // Multiple options can be OR'ed
 //
-// Returns ErrorNotImplemented3 with ZeroMQ version < 4.3
+// Returns ErrorNotImplemented43 with ZeroMQ version < 4.3
 //
 // See https://libzmq.readthedocs.io/en/latest/zmq_setsockopt.html#_zmq_router_notify_send_connect_and_disconnect_notifications
 func (soc *Socket) SetRouterNotify(value RouterNotifyOption) error {
@@ -861,3 +861,48 @@ func (soc *Socket) SetRouterNotify(value RouterNotifyOption) error {
 	}
 	return soc.setInt(C.ZMQ_ROUTER_NOTIFY, int(value))
 }
+
+// ZMQ_HELLO_MSG: Set a message to be sent to peers when they connect
+//
+// Returns ErrorNotImplemented433 with ZeroMQ version < 4.3.3
+//
+// See https://libzmq.readthedocs.io/en/latest/zmq_setsockopt.html#_zmq_hello_msg_set_an_hello_message_that_will_be_sent_when_a_new_peer_connect
+func (soc *Socket) SetHelloMsg(value string) error {
+	if minor < 3 || (minor == 3 && patch < 3) {
+		return ErrorNotImplemented433
+	}
+	if len(value) == 0 {
+		return soc.setNullString(C.ZMQ_HELLO_MSG)
+	}
+	return soc.setString(C.ZMQ_HELLO_MSG, value)
+}
+
+// ZMQ_DISCONNECT_MSG: Set a message to be generated when accepted peers disconnect
+//
+// Returns ErrorNotImplemented433 with ZeroMQ version < 4.3.3
+//
+// See https://libzmq.readthedocs.io/en/latest/zmq_setsockopt.html#_zmq_disconnect_msg_set_a_disconnect_message_that_the_socket_will_generate_when_accepted_peer_disconnect
+func (soc *Socket) SetDisconnectMsg(value string) error {
+	if minor < 3 || (minor == 3 && patch < 3) {
+		return ErrorNotImplemented433
+	}
+	if len(value) == 0 {
+		return soc.setNullString(C.ZMQ_DISCONNECT_MSG)
+	}
+	return soc.setString(C.ZMQ_DISCONNECT_MSG, value)
+}
+
+// ZMQ_HICCUP_MSG: Set a message to be generated when connected peers temporarily disconnect
+//
+// Returns ErrorNotImplemented435 with ZeroMQ version < 4.3.5
+//
+// See https://libzmq.readthedocs.io/en/latest/zmq_setsockopt.html#_zmq_hiccup_msg_set_a_hiccup_message_that_the_socket_will_generate_when_connected_peer_temporarily_disconnect
+func (soc *Socket) SetHiccupMsg(value string) error {
+	if minor < 3 || (minor == 3 && patch < 5) {
+		return ErrorNotImplemented435
+	}
+	if len(value) == 0 {
+		return soc.setNullString(C.ZMQ_HICCUP_MSG)
+	}
+	return soc.setString(C.ZMQ_HICCUP_MSG, value)
+}

draft/zmq4.go

@@ -88,6 +88,8 @@ var (
 	ErrorNotImplemented42      = errors.New("Not implemented, requires 0MQ version 4.2")
 	ErrorNotImplemented42draft = errors.New("Not implemented, requires 0MQ version 4.2 with drafts enabled")
 	ErrorNotImplemented43      = errors.New("Not implemented, requires 0MQ version 4.3")
+	ErrorNotImplemented433     = errors.New("Not implemented, requires 0MQ version 4.3.3")
+	ErrorNotImplemented435     = errors.New("Not implemented, requires 0MQ version 4.3.5")
 	ErrorNotImplementedWindows = errors.New("Not implemented on Windows")
 	ErrorNoSocket              = errors.New("No such socket")
 

draft/zmq43draft.h

@@ -1,5 +1,17 @@
 #if ZMQ_VERSION_MINOR < 3
+// Version < 4.3
 #define ZMQ_ROUTER_NOTIFY -1
 #define ZMQ_NOTIFY_CONNECT 1
 #define ZMQ_NOTIFY_DISCONNECT 2
 #endif
+
+#if ZMQ_VERSION_MINOR < 3 || (ZMQ_VERSION_MINOR == 3 && ZMQ_VERSION_PATCH < 3)
+// Version < 4.3.3
+#define ZMQ_HELLO_MSG -1
+#define ZMQ_DISCONNECT_MSG -1
+#endif
+
+#if ZMQ_VERSION_MINOR < 3 || (ZMQ_VERSION_MINOR == 3 && ZMQ_VERSION_PATCH < 5)
+// Version < 4.3.5
+#define ZMQ_HICCUP_MSG -1
+#endif