asterism-zenoh 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2855bdb36755d80af0a3e56ff6b270d9b641063b80acd59807579d06fbd17636
-  data.tar.gz: ffe16a1e240950235c16d339bd18688aed345bffb72d54ccd5a271315deaa0f7
+  metadata.gz: e69691b1bce645a0c919495f5b666dd315f94cc6f2c34707cee76eeeccc1d9f7
+  data.tar.gz: efff8d1807c7752b2d2cadd9d71a082ac96da2acf95af0e9f33873686b5be2d1
 SHA512:
-  metadata.gz: 99b027cbc1b7af3e4ce63edd8acfcae3ba305c9d0320d9f6ba219b4b740cfa072957bc074045f255104d22bc7ac94f4f285f9371cc94f0dd69d64daa036994d1
-  data.tar.gz: 75c62b48351b64c4feb546113de28632602c23fdea6ad07b42ce8507db2a3a2468884c8b7afee4c86e25dbdc54ef2d578784d5ec0da687b832c7965ccdc9b853
+  metadata.gz: 18f12c15339bae03cbbe9116933d3eccbbf3c740376c5f348830cc7f8e2cf163bd5b0a86876b471955b08dcefa888e51bbcd8de5c4cf141816770e55b42f860f
+  data.tar.gz: e25ab4b30899f357f9440a9c14d3cb12a7e8b80e36ff1962aa280726237c44b5a8af4091a14585273031e392658155f41d7946da2a2ebe092ef7184c9c8e1117

data/README.md

@@ -55,8 +55,15 @@ its own thread. Nothing calls into Ruby behind its back, and `poll` does not
 need to run for data to arrive: it only checks the connection.
 
 Waiting calls (`Session.open`, `put`, `get`, `liveliness_get`, `close`)
-release the GVL. One `Session` and its objects are meant to be used from
-one Ruby thread at a time, as on the boards.
+release the GVL. A `Session` and its objects may be used from several Ruby
+threads: the calls that keep the GVL are serialized by it, the ones that
+release it by a lock of the session, and a session that closes (by `close`
+or because the connection was lost) is closed for every thread before
+zenoh-c lets it go; calls made after that raise `Asterism::Zenoh::Error`.
+Each entry of a queue is taken by exactly one `each_pending` /
+`each_reply`. The gem itself starts no Ruby thread: blocks, a receiving
+thread and Enumerators on top of this API are in the CRuby layer of the
+`asterism` gem.
 
 ## Behaviour kept from the mruby gem
 

data/ext/asterism_zenoh/zenoh.c

@@ -18,7 +18,10 @@
  * thread. Session#poll only checks the connection: receiving needs no poll.
  *
  * The GVL is released while zenoh-c may wait: opening a session (connecting
- * to the router), put, get, liveliness_get and close.
+ * to the router), put, get, liveliness_get and close. A session may be used
+ * from several Ruby threads: the calls that hold the GVL are serialized by
+ * it, the ones without it by the session's op_lock, and closing marks the
+ * session closed for Ruby (with the GVL held) before zenoh-c drops it.
  *
  * Losing the connection (same rules as the mruby gem): a client session is
  * closed when it has no router left, a peer session that only connects when
@@ -393,7 +396,8 @@ typedef struct zrb_token zrb_token;
 struct zrb_session {
     z_owned_session_t session;
     pthread_mutex_t op_lock; /* calls made without the GVL, and close */
-    bool open;
+    bool open;      /* Ruby's view; changed only with the GVL held */
+    bool live;      /* the zenoh-c session exists; changed under op_lock */
     bool peer;      /* peer mode (otherwise client) */
     bool listening; /* peer mode with a listener: stays open without peers */
     zrb_sub *subs;  /* live subscribers and liveliness watches */
@@ -861,8 +865,8 @@ static void zrb_session_detach_all(zrb_session *z) {
 static void *zrb_session_close_nogvl(void *p) {
     zrb_session *z = (zrb_session *)p;
     pthread_mutex_lock(&z->op_lock);
-    if (z->open) {
-        z->open = false;
+    if (z->live) {
+        z->live = false;
         z_close(z_loan_mut(z->session), NULL);
         z_drop(z_move(z->session));
     }
@@ -875,6 +879,11 @@ static void zrb_session_shutdown(zrb_session *z, bool with_gvl_release) {
     if (!z->open) {
         return;
     }
+    /* Closed for Ruby before the GVL is released: another Ruby thread that
+     * runs while zenoh-c closes the session sees it closed and does not
+     * touch the session any more (the calls without the GVL check live
+     * under op_lock instead). */
+    z->open = false;
     if (with_gvl_release) {
         rb_thread_call_without_gvl(zrb_session_close_nogvl, z, RUBY_UBF_IO, NULL);
     } else {
@@ -1052,6 +1061,7 @@ static VALUE zrb_session_s_open(int argc, VALUE *argv, VALUE klass) {
         rb_raise(eZenohError, "cannot open a session to %s (%d)", locator != NULL ? locator : listen, (int)a.ret);
     }
     z->open = true;
+    z->live = true;
     z->peer = peer;
     z->listening = (listen != NULL);
     return obj;
@@ -1068,7 +1078,7 @@ typedef struct {
 static void *zrb_put_nogvl(void *p) {
     zrb_put_args *a = (zrb_put_args *)p;
     pthread_mutex_lock(&a->z->op_lock);
-    if (a->z->open) {
+    if (a->z->live) {
         a->ret = z_put(z_loan(a->z->session), z_loan(a->key), z_move(a->payload), &a->opts);
     } else {
         a->ret = Z_ESESSION_CLOSED;
@@ -1269,7 +1279,7 @@ typedef struct {
 static void *zrb_get_nogvl(void *p) {
     zrb_get_args *a = (zrb_get_args *)p;
     pthread_mutex_lock(&a->z->op_lock);
-    if (a->z->open) {
+    if (a->z->live) {
         if (a->liveliness) {
             a->ret = z_liveliness_get(z_loan(a->z->session), z_loan(a->key), z_move(a->cb), &a->lopts);
         } else {

data/lib/asterism/zenoh/version.rb

@@ -1,6 +1,6 @@
 module Asterism
   module Zenoh
     # The gem's version.
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asterism-zenoh
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Katsuhiko Kageyama