rbczmq 1.7.4 → 1.7.5

data/ext/rbczmq/context.h

@@ -1,6 +1,8 @@
 #ifndef RBCZMQ_CONTEXT_H
 #define RBCZMQ_CONTEXT_H
 
+#include "socket.h"
+
 #define ZMQ_CONTEXT_DESTROYED 0x01
 
 typedef struct {
@@ -8,6 +10,7 @@ typedef struct {
     int flags;
     pid_t pid; /* this is the pid for the process that created the context. Only this process can use the context. */
     VALUE pidValue; /* this is the key used to ensure one context per process */
+    zlist_t* sockets; /* list of socket wrapper objects owned by this context. */
 } zmq_ctx_wrapper;
 
 #define ZmqAssertContext(obj) ZmqAssertType(obj, rb_cZmqContext, "ZMQ::Context")
@@ -32,4 +35,6 @@ VALUE rb_czmq_socket_alloc(VALUE context, zctx_t *ctx, void *s);
 
 void _init_rb_czmq_context();
 
+void rb_czmq_context_destroy_socket(zmq_sock_wrapper* socket);
+
 #endif

data/ext/rbczmq/message.c

@@ -377,7 +377,7 @@ static VALUE rb_czmq_message_pushstr(VALUE obj, VALUE str)
     ZmqGetMessage(obj);
     ZmqAssertMessageOwned(message);
     Check_Type(str, T_STRING);
-    rc = zmsg_pushmem(message->message, StringValueCStr(str), RSTRING_LEN(str));
+    rc = zmsg_pushmem(message->message, RSTRING_PTR(str), RSTRING_LEN(str));
     ZmqAssert(rc);
 
     /* keep zlist of frame ruby objects in sync with message's frame list */
@@ -410,7 +410,7 @@ static VALUE rb_czmq_message_addstr(VALUE obj, VALUE str)
     ZmqGetMessage(obj);
     ZmqAssertMessageOwned(message);
     Check_Type(str, T_STRING);
-    rc = zmsg_addmem(message->message, StringValueCStr(str), RSTRING_LEN(str));
+    rc = zmsg_addmem(message->message, RSTRING_PTR(str), RSTRING_LEN(str));
     ZmqAssert(rc);
 
     /* keep zlist of frame ruby objects in sync with message's frame list */
@@ -603,7 +603,9 @@ static VALUE rb_czmq_message_encode(VALUE obj)
     ZmqGetMessage(obj);
     ZmqReturnNilUnlessOwned(message);
     buff_size = zmsg_encode(message->message, &buff);
-    return rb_str_new((char *)buff, buff_size);
+    VALUE result = rb_str_new((char *)buff, buff_size);
+    free(buff);
+    return result;
 }
 
 /*
@@ -623,7 +625,7 @@ static VALUE rb_czmq_message_s_decode(ZMQ_UNUSED VALUE obj, VALUE buffer)
 {
     zmsg_t * m = NULL;
     Check_Type(buffer, T_STRING);
-    m = zmsg_decode((byte *)StringValueCStr(buffer), RSTRING_LEN(buffer));
+    m = zmsg_decode((byte *)RSTRING_PTR(buffer), RSTRING_LEN(buffer));
     if (m == NULL) return Qnil;
     return rb_czmq_alloc_message(m);
 }

data/ext/rbczmq/poller.c

@@ -154,15 +154,22 @@ VALUE rb_czmq_poller_poll(int argc, VALUE *argv, VALUE obj)
     args.nitems = poller->poll_size;
     args.timeout = (long)timeout;
 
+    rb_ary_clear(poller->readables);
+    rb_ary_clear(poller->writables);
+
     rc = (int)rb_thread_blocking_region(rb_czmq_nogvl_poll, (void *)&args, RUBY_UBF_IO, 0);
+
     /* only call ZmqAssert if return code is less than zero since zmq_poll returns the number of pollers on success */
     if (rc < 0) {
-        ZmqAssert(rc);
+        if (zmq_errno() == EINTR || zmq_errno() == EAGAIN) {
+            // these are recoverable errors, so return flow to ruby so that retry / interrupt handling can be
+            // done in ruby code. Ruby will see a -1 result. If it was an INT (or other) signal, ruby's signal
+            // handler will raise the Interrupt exception.
+        } else {
+            ZmqAssert(rc);
+        }
     }
-    if (rc == 0) {
-        rb_ary_clear(poller->readables);
-        rb_ary_clear(poller->writables);
-    } else {
+    if (rc > 0) {
         rb_czmq_poller_rebuild_selectables(poller);
     }
     return INT2NUM(rc);

data/ext/rbczmq/rbczmq_ext.c

@@ -16,6 +16,7 @@ VALUE rb_cZmqReqSocket;
 VALUE rb_cZmqPairSocket;
 VALUE rb_cZmqXPubSocket;
 VALUE rb_cZmqXSubSocket;
+VALUE rb_cZmqStreamSocket;
 
 VALUE rb_cZmqFrame;
 VALUE rb_cZmqMessage;
@@ -249,6 +250,7 @@ void Init_rbczmq_ext()
     rb_define_const(rb_mZmq, "PULL", INT2NUM(ZMQ_PULL));
     rb_define_const(rb_mZmq, "XSUB", INT2NUM(ZMQ_XSUB));
     rb_define_const(rb_mZmq, "XPUB", INT2NUM(ZMQ_XPUB));
+    rb_define_const(rb_mZmq, "STREAM", INT2NUM(ZMQ_STREAM));
 
     rb_define_const(rb_mZmq, "EFSM", INT2NUM(EFSM));
     rb_define_const(rb_mZmq, "ENOCOMPATPROTO", INT2NUM(ENOCOMPATPROTO));

data/ext/rbczmq/rbczmq_ext.h

@@ -66,6 +66,7 @@ extern VALUE rb_cZmqReqSocket;
 extern VALUE rb_cZmqPairSocket;
 extern VALUE rb_cZmqXPubSocket;
 extern VALUE rb_cZmqXSubSocket;
+extern VALUE rb_cZmqStreamSocket;
 
 extern VALUE rb_cZmqFrame;
 extern VALUE rb_cZmqMessage;

data/ext/rbczmq/socket.c

@@ -11,36 +11,6 @@ VALUE intern_on_closed;
 VALUE intern_on_close_failed;
 VALUE intern_on_disconnected;
 
-/*
- * :nodoc:
- *  Destroy the socket while the GIL is released - may block depending on socket linger value.
- *
-*/
-static VALUE rb_czmq_nogvl_zsocket_destroy(void *ptr)
-{
-    zmq_sock_wrapper *sock = ptr;
-    errno = 0;
-    sock->flags |= ZMQ_SOCKET_DESTROYED;
-    zsocket_destroy(sock->ctx, sock->socket);
-    return Qnil;
-}
-
-/*
- * :nodoc:
- *  Free all resources for a socket - invoked by the lower level ZMQ::Socket#destroy as well as the GC callback (some
- *  regressions here still though).
- *
-*/
-void rb_czmq_free_sock(zmq_sock_wrapper *sock)
-{
-    if (sock->ctx) {
-        rb_thread_blocking_region(rb_czmq_nogvl_zsocket_destroy, sock, RUBY_UBF_IO, 0);
-        if (zmq_errno() == ENOTSOCK) ZmqRaiseSysError();
-        sock->socket = NULL;
-        sock->flags |= ZMQ_SOCKET_DESTROYED;
-    }
-}
-
 /*
  * :nodoc:
  *  GC mark callback
@@ -50,8 +20,9 @@ void rb_czmq_mark_sock(void *ptr)
 {
     zmq_sock_wrapper *sock = (zmq_sock_wrapper *)ptr;
     if (sock && sock->ctx){
-        if (sock->verbose)
-            zclock_log ("I: %s socket %p, context %p: GC mark", zsocket_type_str(sock->socket), sock, sock->ctx);
+        if (sock->verbose) {
+            zclock_log ("I: %s socket %p, context %p: GC mark", sock->flags & ZMQ_SOCKET_DESTROYED ? "(closed)" : zsocket_type_str(sock->socket), sock, sock->ctx);
+        }
         rb_gc_mark(sock->endpoints);
         rb_gc_mark(sock->thread);
         rb_gc_mark(sock->context);
@@ -69,14 +40,27 @@ void rb_czmq_mark_sock(void *ptr)
 void rb_czmq_free_sock_gc(void *ptr)
 {
     zmq_sock_wrapper *sock = (zmq_sock_wrapper *)ptr;
-    if (sock && sock->ctx){
-        if (sock->verbose)
-            zclock_log ("I: %s socket %p, context %p: GC free", zsocket_type_str(sock->socket), sock, sock->ctx);
+    if (sock) {
+        if (sock->verbose) {
+            zclock_log ("I: %s socket %p, context %p: GC free", sock->flags & ZMQ_SOCKET_DESTROYED ? "(closed)" : zsocket_type_str(sock->socket), sock, sock ? sock->ctx : NULL);
+        }
 /*
         XXX: cyclic dependency
         #4  0x0000000100712524 in zsocket_set_linger (linger=1, socket=<value temporarily unavailable, due to optimizations>) at zsocket.c:288
         if (sock->socket != NULL && !(sock->flags & ZMQ_SOCKET_DESTROYED)) rb_czmq_free_sock(sock);
+
+        SOLVED:
+
+        The above occurs when a socket is not explicitly destroyed and the socket happens to be garbage
+        collected *after* the context has been destroyed. When the context is destroyed, all sockets
+        in the context are closed internally by czmq. However, the rbczmq ZMQ::Socket object still
+        thinks it is alive and will destroy again.
+
+        The new socket destroy method 'rb_czmq_context_destroy_socket' is idempotent and can safely
+        be called after either context or socket has been destroyed.
 */
+
+        rb_czmq_context_destroy_socket(sock);
         xfree(sock);
     }
 }
@@ -100,8 +84,8 @@ static VALUE rb_czmq_socket_close(VALUE obj)
     ZmqSockGuardCrossThread(sock);
     /* This is useless for production / real use cases as we can't query the state again OR assume
     anything about the underlying connection. Merely doing the right thing. */
-    sock->state = ZMQ_SOCKET_PENDING;
-    rb_czmq_free_sock(sock);
+    sock->state = ZMQ_SOCKET_DISCONNECTED;
+    rb_czmq_context_destroy_socket(sock);
     return Qnil;
 }
 
@@ -184,7 +168,7 @@ VALUE rb_czmq_nogvl_socket_bind(void *ptr)
     struct nogvl_conn_args *args = ptr;
     errno = 0;
     zmq_sock_wrapper *socket = args->socket;
-    rc = zsocket_bind(socket->socket, args->endpoint);
+    rc = zsocket_bind(socket->socket, "%s", args->endpoint);
     return (VALUE)rc;
 }
 
@@ -199,7 +183,7 @@ VALUE rb_czmq_nogvl_socket_connect(void *ptr)
     struct nogvl_conn_args *args = ptr;
     errno = 0;
     zmq_sock_wrapper *socket = args->socket;
-    rc = zsocket_connect(socket->socket, args->endpoint);
+    rc = zsocket_connect(socket->socket, "%s", args->endpoint);
     return (VALUE)rc;
 }
 
@@ -232,10 +216,14 @@ static VALUE rb_czmq_socket_bind(VALUE obj, VALUE endpoint)
     if (rc < 0) {
         ZmqAssert(rc);
     }
+    /* get the endpoint name with any ephemeral ports filled in. */
+    char* endpoint_string = zsocket_last_endpoint(sock->socket);
+    ZmqAssert(endpoint_string != NULL);
     if (sock->verbose)
-        zclock_log ("I: %s socket %p: bound \"%s\"", zsocket_type_str(sock->socket), obj, StringValueCStr(endpoint));
+        zclock_log ("I: %s socket %p: bound \"%s\"", zsocket_type_str(sock->socket), obj, endpoint_string);
     sock->state = ZMQ_SOCKET_BOUND;
-    rb_ary_push(sock->endpoints, rb_str_new4(endpoint));
+    rb_ary_push(sock->endpoints, rb_str_new_cstr(endpoint_string));
+    free(endpoint_string);
     return INT2NUM(rc);
 }
 
@@ -266,10 +254,14 @@ static VALUE rb_czmq_socket_connect(VALUE obj, VALUE endpoint)
     args.endpoint = StringValueCStr(endpoint);
     rc = (int)rb_thread_blocking_region(rb_czmq_nogvl_socket_connect, (void *)&args, RUBY_UBF_IO, 0);
     ZmqAssert(rc);
+    /* get the endpoint name with any ephemeral ports filled in. */
+    char* endpoint_string = zsocket_last_endpoint(sock->socket);
+    ZmqAssert(endpoint_string != NULL);
     if (sock->verbose)
-        zclock_log ("I: %s socket %p: connected \"%s\"", zsocket_type_str(sock->socket), obj, StringValueCStr(endpoint));
+        zclock_log ("I: %s socket %p: connected \"%s\"", zsocket_type_str(sock->socket), obj, endpoint_string);
     sock->state = ZMQ_SOCKET_CONNECTED;
-    rb_ary_push(sock->endpoints, rb_str_new4(endpoint));
+    rb_ary_push(sock->endpoints, rb_str_new_cstr(endpoint_string));
+    free(endpoint_string);
     return Qtrue;
 }
 
@@ -284,7 +276,7 @@ VALUE rb_czmq_nogvl_socket_disconnect(void *ptr)
     struct nogvl_conn_args *args = ptr;
     errno = 0;
     zmq_sock_wrapper *socket = args->socket;
-    rc = zsocket_disconnect(socket->socket, args->endpoint);
+    rc = zsocket_disconnect(socket->socket, "%s", args->endpoint);
     return (VALUE)rc;
 }
 
@@ -318,11 +310,69 @@ static VALUE rb_czmq_socket_disconnect(VALUE obj, VALUE endpoint)
     ZmqAssert(rc);
     if (sock->verbose)
         zclock_log ("I: %s socket %p: disconnected \"%s\"", zsocket_type_str(sock->socket), obj, StringValueCStr(endpoint));
-    sock->state = ZMQ_SOCKET_DISCONNECTED;
     rb_ary_delete(sock->endpoints, endpoint);
+    long endpoint_count = RARRAY_LEN(sock->endpoints);
+    if (endpoint_count == 0) {
+        sock->state = ZMQ_SOCKET_DISCONNECTED;
+    }
+    return Qtrue;
+}
+
+/*
+ * :nodoc:
+ *  Unbinds from an endpoint while the GIL is released.
+ *
+*/
+VALUE rb_czmq_nogvl_socket_unbind(void *ptr)
+{
+    int rc;
+    struct nogvl_conn_args *args = ptr;
+    errno = 0;
+    zmq_sock_wrapper *socket = args->socket;
+    rc = zsocket_unbind(socket->socket, "%s", args->endpoint);
+    return (VALUE)rc;
+}
+
+
+/*
+ *  call-seq:
+ *     sock.disconnect("tcp://localhost:3456")   =>  boolean
+ *
+ *  Attempts to disconnect from a given endpoint.
+ *
+ * === Examples
+ *     ctx = ZMQ::Context.new
+ *     rep = ctx.socket(:REP)
+ *     port = rep.bind("tcp://localhost:*")    =>  5432
+ *     req = ctx.socket(:REQ)
+ *     req.connect("tcp://localhost:#{port}")   => true
+ *     rep.unbind("tcp://localhost:#{port}")   => true
+ *
+*/
+
+static VALUE rb_czmq_socket_unbind(VALUE obj, VALUE endpoint)
+{
+    struct nogvl_conn_args args;
+    int rc;
+    zmq_sock_wrapper *sock = NULL;
+    GetZmqSocket(obj);
+    ZmqSockGuardCrossThread(sock);
+    Check_Type(endpoint, T_STRING);
+    args.socket = sock;
+    args.endpoint = StringValueCStr(endpoint);
+    rc = (int)rb_thread_blocking_region(rb_czmq_nogvl_socket_unbind, (void *)&args, RUBY_UBF_IO, 0);
+    ZmqAssert(rc);
+    if (sock->verbose)
+        zclock_log ("I: %s socket %p: unbound \"%s\"", zsocket_type_str(sock->socket), obj, StringValueCStr(endpoint));
+    rb_ary_delete(sock->endpoints, endpoint);
+    long endpoint_count = RARRAY_LEN(sock->endpoints);
+    if (endpoint_count == 0) {
+        sock->state = ZMQ_SOCKET_DISCONNECTED;
+    }
     return Qtrue;
 }
 
+
 /*
  *  call-seq:
  *     sock.verbose = true   =>  nil
@@ -537,7 +587,6 @@ static VALUE rb_czmq_socket_recv(VALUE obj)
 
 static VALUE rb_czmq_socket_recv_nonblock(VALUE obj)
 {
-    char *str = NULL;
     struct nogvl_recv_args args;
     errno = 0;
     VALUE result = Qnil;
@@ -554,12 +603,14 @@ static VALUE rb_czmq_socket_recv_nonblock(VALUE obj)
         return Qnil;
     }
     ZmqAssertSysError();
-    if (sock->verbose)
-        zclock_log ("I: %s socket %p: recv \"%s\"", zsocket_type_str(sock->socket), sock->socket, str);
 
     result = rb_str_new(zmq_msg_data(&args.message), zmq_msg_size(&args.message));
     zmq_msg_close(&args.message);
 
+    if (sock->verbose) {
+        zclock_log ("I: %s socket %p: recv \"%s\"", zsocket_type_str(sock->socket), sock->socket, StringValueCStr(result));
+    }
+
     result = ZmqEncode(result);
     return result;
 }
@@ -1664,6 +1715,28 @@ static VALUE rb_czmq_socket_set_opt_sndtimeo(VALUE obj, VALUE value)
     ZmqSetSockOpt(obj, zsocket_set_sndtimeo, "SNDTIMEO", value);
 }
 
+
+/*
+ *  call-seq:
+ *     port = sock.bind('tcp://0.0.0.0:*')  =>  41415
+ *     sock.last_endpoint  =>  "tcp://0.0.0.0:41415"
+ *
+ *  Gets the last endpoint that this socket connected or bound to.
+ *
+*/
+
+static VALUE rb_czmq_socket_opt_last_endpoint(VALUE obj)
+{
+    zmq_sock_wrapper *sock = NULL;
+    GetZmqSocket(obj);
+    char* endpoint_string = zsocket_last_endpoint(sock->socket);
+    VALUE result = rb_str_new_cstr(endpoint_string);
+    if (endpoint_string != NULL) {
+        free(endpoint_string);
+    }
+    return result;
+}
+
 /*
  * :nodoc:
  *  Receives a monitoring event message while the GIL is released.
@@ -1725,7 +1798,7 @@ static VALUE rb_czmq_socket_monitor_thread(void *arg)
         // copy endpoint into ruby string.
         VALUE endpoint_str = rb_str_new(zmq_msg_data(&args.msg_endpoint), zmq_msg_size(&args.msg_endpoint));
         VALUE method = Qnil;
-        
+
         switch (event.event) {
         case ZMQ_EVENT_CONNECTED: method = intern_on_connected; break;
         case ZMQ_EVENT_CONNECT_DELAYED: method = intern_on_connect_delayed; break;
@@ -1738,7 +1811,7 @@ static VALUE rb_czmq_socket_monitor_thread(void *arg)
         case ZMQ_EVENT_CLOSED: method = intern_on_closed; break;
         case ZMQ_EVENT_DISCONNECTED: method = intern_on_disconnected; break;
         }
-        
+
         if (method != Qnil) {
             rb_funcall(sock->monitor_handler, method, 2, endpoint_str, INT2FIX(event.value));
         }
@@ -1809,16 +1882,17 @@ void _init_rb_czmq_socket()
 {
     rb_cZmqSocket = rb_define_class_under(rb_mZmq, "Socket", rb_cObject);
     rb_cZmqPubSocket = rb_define_class_under(rb_cZmqSocket, "Pub", rb_cZmqSocket);
-    rb_cZmqSubSocket = rb_define_class_under(rb_cZmqSocket, "Sub", rb_cZmqSocket);;
-    rb_cZmqPushSocket = rb_define_class_under(rb_cZmqSocket, "Push", rb_cZmqSocket);;
-    rb_cZmqPullSocket = rb_define_class_under(rb_cZmqSocket, "Pull", rb_cZmqSocket);;
-    rb_cZmqRouterSocket = rb_define_class_under(rb_cZmqSocket, "Router", rb_cZmqSocket);;
-    rb_cZmqDealerSocket = rb_define_class_under(rb_cZmqSocket, "Dealer", rb_cZmqSocket);;
-    rb_cZmqRepSocket = rb_define_class_under(rb_cZmqSocket, "Rep", rb_cZmqSocket);;
-    rb_cZmqReqSocket = rb_define_class_under(rb_cZmqSocket, "Req", rb_cZmqSocket);;
-    rb_cZmqPairSocket = rb_define_class_under(rb_cZmqSocket, "Pair", rb_cZmqSocket);;
+    rb_cZmqSubSocket = rb_define_class_under(rb_cZmqSocket, "Sub", rb_cZmqSocket);
+    rb_cZmqPushSocket = rb_define_class_under(rb_cZmqSocket, "Push", rb_cZmqSocket);
+    rb_cZmqPullSocket = rb_define_class_under(rb_cZmqSocket, "Pull", rb_cZmqSocket);
+    rb_cZmqRouterSocket = rb_define_class_under(rb_cZmqSocket, "Router", rb_cZmqSocket);
+    rb_cZmqDealerSocket = rb_define_class_under(rb_cZmqSocket, "Dealer", rb_cZmqSocket);
+    rb_cZmqRepSocket = rb_define_class_under(rb_cZmqSocket, "Rep", rb_cZmqSocket);
+    rb_cZmqReqSocket = rb_define_class_under(rb_cZmqSocket, "Req", rb_cZmqSocket);
+    rb_cZmqPairSocket = rb_define_class_under(rb_cZmqSocket, "Pair", rb_cZmqSocket);
     rb_cZmqXPubSocket = rb_define_class_under(rb_cZmqSocket, "XPub", rb_cZmqSocket);
-    rb_cZmqXSubSocket = rb_define_class_under(rb_cZmqSocket, "XSub", rb_cZmqSocket);;
+    rb_cZmqXSubSocket = rb_define_class_under(rb_cZmqSocket, "XSub", rb_cZmqSocket);
+    rb_cZmqStreamSocket = rb_define_class_under(rb_cZmqSocket, "Stream", rb_cZmqSocket);
 
     intern_on_connected = rb_intern("on_connected");
     intern_on_connect_delayed = rb_intern("on_connect_delayed");
@@ -1842,6 +1916,7 @@ void _init_rb_czmq_socket()
     rb_define_method(rb_cZmqSocket, "real_bind", rb_czmq_socket_bind, 1);
     rb_define_method(rb_cZmqSocket, "real_connect", rb_czmq_socket_connect, 1);
     rb_define_method(rb_cZmqSocket, "disconnect", rb_czmq_socket_disconnect, 1);
+    rb_define_method(rb_cZmqSocket, "unbind", rb_czmq_socket_unbind, 1);
     rb_define_method(rb_cZmqSocket, "fd", rb_czmq_socket_fd, 0);
     rb_define_alias(rb_cZmqSocket, "to_i", "fd");
     rb_define_method(rb_cZmqSocket, "verbose=", rb_czmq_socket_set_verbose, 1);
@@ -1898,4 +1973,5 @@ void _init_rb_czmq_socket()
     rb_define_method(rb_cZmqSocket, "sndtimeo", rb_czmq_socket_opt_sndtimeo, 0);
     rb_define_method(rb_cZmqSocket, "sndtimeo=", rb_czmq_socket_set_opt_sndtimeo, 1);
     rb_define_method(rb_cZmqSocket, "monitor", rb_czmq_socket_monitor, -1);
+    rb_define_method(rb_cZmqSocket, "last_endpoint", rb_czmq_socket_opt_last_endpoint, 0);
 }

data/ext/rbczmq/socket.h

@@ -13,6 +13,7 @@
 typedef struct {
     zctx_t *ctx;
     void *socket;
+    void *ctx_wrapper; // zmq_ctx_wrapper - can't be defined yet, circular header includes.
     int flags;
     bool verbose;
     int state;
@@ -153,5 +154,6 @@ extern VALUE intern_on_close_failed;
 extern VALUE intern_on_disconnected;
 
 void _init_rb_czmq_socket();
+VALUE rb_czmq_nogvl_zsocket_destroy(void *ptr);
 
 #endif