ccrpc 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93b1358631d8f55fb408daa3644ff3966d518fdcc0bac693468e679d8ea6a144
-  data.tar.gz: 18c6b183a8904c7ad65ea588ec557be7f063107e3d8c191bf54f1c52fdf16915
+  metadata.gz: d74cc1cb91c2d6ae3a85ad925d8e94b317bcc9f13ecb51d7b32b8edfd1ef8d41
+  data.tar.gz: f14c874d78b97fd52d87685d16dafe9d63685817c7bf759608319e42b60ab64d
 SHA512:
-  metadata.gz: 328200b7e1cfbd503abb5c6503d9efc8851f76c7f964bbeb9ee61986d2a7aa0f89ed318df434bcc14cff28702d1919267bf11516900a26022a2dc9744a95ac88
-  data.tar.gz: 22b0d11ce99abedc64c8e46216025ecd753966f7114ef5351484c0b3c0a2273517a82cc524b1923dcf3dd082b3b81572c388759813d476cde13c1fd24371d95e
+  metadata.gz: 04f3fc642a27bb61f4f279783b1ad4bfe97120804d039c8e2d7c866aee1c3aee56ac430fe1826ea493b781af7b5cef9dd54c4aeadaa6c818ff768e79e95e95ac
+  data.tar.gz: 33b4035c9a686261c34fd0f7ed245c6f1744b69b76998c7be60afdd13c6887785a526ffe3c5f7de7472d434c6d18dff6752a154ae70db4427da38908f6f7067d

data/README.md

@@ -98,6 +98,8 @@ The following example invokes the call in the opposite direction, from the subpr
   # call returns when the IO is closed by the subprocess
 ```
 
+Full API documentation is here: https://rubydoc.info/gems/ccrpc
+
 
 ## Development
 

data/ccrpc.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["documentation_uri"] = "https://rubydoc.info/gems/ccrpc"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/ccrpc/rpc_connection.rb

@@ -84,7 +84,10 @@ class RpcConnection
   #
   # @param [IO] read_io   readable IO object for reception of data
   # @param [IO] write_io   writable IO object for transmission of data
-  # @param [Boolean] lazy_answers   Enable or disable lazy results. See {#call} for more description.
+  # @param [Boolean] lazy_answers   Enable or disable lazy results.
+  #    If enabled the return value of #call is always a Ccrpc::Promise object.
+  #    It behaves like an ordinary +nil+ or Hash object, but the actual IO blocking operation is delayed to the first method call on the Promise object.
+  #    See {#call} for more description.
   def initialize(read_io, write_io, lazy_answers: false)
     super()
 
@@ -160,10 +163,11 @@ class RpcConnection
   # @return [Hash]  Received answer parameters.
   # @return [Promise] Received answer parameters enveloped by a Promise.
   #   This type of answers can be enabled by +RpcConnection#new(lazy_answers: true)+
-  #   The Promise object is returned as soon as the RPC call is sent, but before waiting for the corresponding answer.
+  #   The Promise object is returned as soon as the RPC call is sent and a callback receiver is registered, but before waiting for the corresponding answer.
   #   This way several calls can be send in parallel without using threads.
   #   As soon as a method is called on the Promise object, this method is blocked until the RPC answer was received.
-  #   The Promise object then behaves like a Hash object.
+  #   The Promise object then behaves like a Hash or +nil+ object.
+  #   It is recommended to use Promise#itself to trigger waiting for call answers or callbacks (although any other method triggers waiting as well).
   # @return [NilClass] Waiting for further answers was stopped gracefully by either returning +[hash, true]+ from the block or because the connection was closed.
   def call(func=nil, params={}, &block)
     call_intern(func, params, &block)
@@ -180,7 +184,7 @@ class RpcConnection
 
     send_call(func, params, id, recv_id) if func
 
-    pr = proc do
+    maybe_lazy do
       @answers_mutex.synchronize do
         res = loop do
           # Is a callback pending for this thread?
@@ -223,7 +227,6 @@ class RpcConnection
         res
       end
     end
-    func ? maybe_lazy(&pr) : pr.call
   end
 
   def next_id
@@ -235,7 +238,7 @@ class RpcConnection
   def send_call(func, params, id, recv_id=nil)
     to_send = String.new
     @write_mutex.synchronize do
-      params.reject{|k,v| v.nil? }.each do |key, value|
+      params.compact.each do |key, value|
         to_send << Escape.escape(key.to_s) << "\t" <<
             Escape.escape(value.to_s) << "\n"
         if to_send.bytesize > 9999
@@ -246,15 +249,15 @@ class RpcConnection
       to_send << Escape.escape(func.to_s) << "\a#{id}"
       to_send << "\a#{recv_id}" if recv_id
       @write_io.write(to_send << "\n")
+      @write_io.flush
     end
-    @write_io.flush
     after_write
   end
 
   def send_answer(answer, id)
     to_send = String.new
     @write_mutex.synchronize do
-      answer.reject{|k,v| v.nil? }.each do |key, value|
+      answer.compact.each do |key, value|
         to_send << Escape.escape(key.to_s) << "\t" <<
             Escape.escape(value.to_s) << "\n"
         if to_send.bytesize > 9999
@@ -264,8 +267,8 @@ class RpcConnection
       end
       to_send << "\a#{id}" if id
       @write_io.write(to_send << "\n")
+      @write_io.flush
     end
-    @write_io.flush
     after_write
   end
 

data/lib/ccrpc/version.rb

@@ -1,3 +1,3 @@
 module Ccrpc
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ccrpc
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Lars Kanis
@@ -10,26 +10,28 @@ bindir: exe
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDLjCCAhagAwIBAgIBDDANBgkqhkiG9w0BAQsFADA9MQ4wDAYDVQQDDAVrYW5p
-  czEXMBUGCgmSJomT8ixkARkWB2NvbWNhcmQxEjAQBgoJkiaJk/IsZAEZFgJkZTAe
-  Fw0yNDA1MDIxMTAwNDVaFw0yNTA1MDIxMTAwNDVaMD0xDjAMBgNVBAMMBWthbmlz
-  MRcwFQYKCZImiZPyLGQBGRYHY29tY2FyZDESMBAGCgmSJomT8ixkARkWAmRlMIIB
-  IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApop+rNmg35bzRugZ21VMGqI6
-  HGzPLO4VHYncWn/xmgPU/ZMcZdfj6MzIaZJ/czXyt4eHpBk1r8QOV3gBXnRXEjVW
-  9xi+EdVOkTV2/AVFKThcbTAQGiF/bT1n2M+B1GTybRzMg6hyhOJeGPqIhLfJEpxn
-  lJi4+ENAVT4MpqHEAGB8yFoPC0GqiOHQsdHxQV3P3c2OZqG+yJey74QtwA2tLcLn
-  Q53c63+VLGsOjODl1yPn/2ejyq8qWu6ahfTxiIlSar2UbwtaQGBDFdb2CXgEufXT
-  L7oaPxlmj+Q2oLOfOnInd2Oxop59HoJCQPsg8f921J43NCQGA8VHK6paxIRDLQID
-  AQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUvgTdT7fe
-  x17ugO3IOsjEJwW7KP4wDQYJKoZIhvcNAQELBQADggEBAH+LA+CcA9vbbqtuhK4J
-  lG1lQwA+hCKiueQgVsepNbXyDzx6PMC8ap/bFaKSaoUWABBA/bsh3jDNXT/eVZrN
-  lFP8cVGrznSYIBG8D/QQmJKpvDBJgnC4Zk01HkhYlqJC4qCTn9X+/uZNHLPLbAEL
-  xl3P43zyL3GQb1IP9bp0xV6oxwG9FO9Rk8bYDojky/69ylowFI5aODS39v01Siu2
-  FsEjM9tMSNb7lQRywQ/432KXi+8AAPTm+wdGnlt3wLE9w2TTpGUBsNKk+QiytTZO
-  zwbjAdVlRm0pg/vpDzzFmRf1GYVckMm8hpCRt8BP0akAbNyw1snYvZBwgLqxztru
-  bEo=
+  MIIDljCCAn6gAwIBAgIBATANBgkqhkiG9w0BAQsFADBIMRMwEQYDVQQDDApsYXJz
+  LmthbmlzMRwwGgYKCZImiZPyLGQBGRYMc2luY25vdmF0aW9uMRMwEQYKCZImiZPy
+  LGQBGRYDY29tMB4XDTIzMTAyNzIwNTc0MloXDTI0MTAyNjIwNTc0MlowSDETMBEG
+  A1UEAwwKbGFycy5rYW5pczEcMBoGCgmSJomT8ixkARkWDHNpbmNub3ZhdGlvbjET
+  MBEGCgmSJomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC
+  ggEBAMJ4t2fVdVUixHSsWWXudvO7uCNKchxmrocupP5CNIvhkr0dYoJX+Hkghhh3
+  CFvo2gm8Oolfbl8Zvt/tBvJ/DhIaLWelhLpx7+gwoXkmrMvzOrJx1Wn4WdBSbKbX
+  0b7kbY9XKtZPp0e+5xCGDZRwGgdvEJrQqu//lgKdnuS5jMMqx4agqE0vZXmJ6CpV
+  FmUZ111nUmqUXO1lAJPrbYgx7PuUh+/KuaLTXe1TFuQKIK5HJoLQPRHSrleqRzD2
+  U7CagEy8gu8Ct9jD35QrxnBju0UyQlPlOB1v8wgfv50t8106Anke0NytTAH2uGKU
+  5fimmqnLQnFg8AzZnuaevliscYcCAwEAAaOBijCBhzAJBgNVHRMEAjAAMAsGA1Ud
+  DwQEAwIEsDAdBgNVHQ4EFgQU8WIevudyI+2h11gae0Sr2GzINeswJgYDVR0RBB8w
+  HYEbbGFycy5rYW5pc0BzaW5jbm92YXRpb24uY29tMCYGA1UdEgQfMB2BG2xhcnMu
+  a2FuaXNAc2luY25vdmF0aW9uLmNvbTANBgkqhkiG9w0BAQsFAAOCAQEAaD5tg+U+
+  /oolmp1/q6kCGqSaN4BIa40zDVFBaPsU02TXP7tpc+MD+WXwATMJAQ7MoIdFV2Rn
+  lCnMpKga9c+YvY3sKNeto9w+KvgIWSizHmUxqQmBpq74Xxz+fbBqZS/RboS0nY2p
+  ggnJJUsPbRXFFG09KPSNEGgsl5gipbX3k4HUlH/EaGrXCKswEr5WP5GwVm8t4J2r
+  t9W3c/nKB0fn3ouhpxl+AQU0dKqEanlH9rs7UNtVIgQtrH+xLMScdwgRzIVrwKVC
+  UAcSEq6uV4ESW20hEz8XvDK007nIk7R18hD6l5B9nqRN96+VO/5mex0iHV7lf79h
+  17EsHXVAFAb3dA==
   -----END CERTIFICATE-----
-date: 2024-07-11 00:00:00.000000000 Z
+date: 2024-10-18 00:00:00.000000000 Z
 dependencies: []
 description: Simple bidirectional and thread safe RPC protocol. Works on arbitrary
   Ruby IO objects.
@@ -60,6 +62,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/larskanis/ccrpc
+  documentation_uri: https://rubydoc.info/gems/ccrpc
 post_install_message:
 rdoc_options: []
 require_paths: