polyphony 1.0 → 1.0.2

data/lib/polyphony/extensions/socket.rb

@@ -69,24 +69,24 @@ class ::Socket < ::BasicSocket
   # If no bytes are available and `EOF` is not hit, this method will block until
   # the socket is ready to read from.
   #
-  # @param maxlen [Integer, nil] maximum bytes to read from socket
+  # @param len [Integer, nil] maximum bytes to read from socket
   # @param buf [String, nil] buffer to read into
   # @param buf_pos [Number] buffer position to read into
   # @return [String] buffer used for reading
-  def read(maxlen = nil, buf = nil, buf_pos = 0)
-    return Polyphony.backend_recv(self, buf, maxlen, buf_pos) if buf
-    return Polyphony.backend_recv(self, +'', maxlen, 0) if maxlen
-
-    buf = +''
-    len = buf.bytesize
-    while true
-      Polyphony.backend_recv(self, buf, maxlen || 4096, -1)
-      new_len = buf.bytesize
-      break if new_len == len
-
-      len = new_len
+  def read(len = nil, buf = nil, buf_pos = 0)
+    return '' if len == 0
+    
+    if buf
+      return Polyphony.backend_read(self, buf, len, true, buf_pos)
     end
-    buf
+    
+    @read_buffer ||= +''
+    result = Polyphony.backend_read(self, @read_buffer, len, true, -1)
+    return nil unless result
+    
+    already_read = @read_buffer
+    @read_buffer = +''
+    already_read
   end
 
   # Receives up to `maxlen` bytes from the socket. If `outbuf` is given, it is
@@ -124,10 +124,7 @@ class ::Socket < ::BasicSocket
   # unpacker:
   #
   #   unpacker = MessagePack::Unpacker.new
-  #   buffer = []
-  #   reader = spin do
-  #     i.feed_loop(unpacker, :feed_each) { |msg| handle_msg(msg) }
-  #   end
+  #   conn.feed_loop(unpacker, :feed_each) { |msg| handle_msg(msg) }
   #
   # @param receiver [any] receiver object
   # @param method [Symbol] method to call
@@ -336,24 +333,24 @@ class ::TCPSocket < ::IPSocket
   # If no bytes are available and `EOF` is not hit, this method will block until
   # the socket is ready to read from.
   #
-  # @param maxlen [Integer, nil] maximum bytes to read from socket
+  # @param len [Integer, nil] maximum bytes to read from socket
   # @param buf [String, nil] buffer to read into
   # @param buf_pos [Number] buffer position to read into
   # @return [String] buffer used for reading
-  def read(maxlen = nil, buf = nil, buf_pos = 0)
-    return Polyphony.backend_recv(self, buf, maxlen, buf_pos) if buf
-    return Polyphony.backend_recv(self, +'', maxlen, 0) if maxlen
-
-    buf = +''
-    len = buf.bytesize
-    while true
-      Polyphony.backend_recv(self, buf, maxlen || 4096, -1)
-      new_len = buf.bytesize
-      break if new_len == len
-
-      len = new_len
+  def read(len = nil, buf = nil, buf_pos = 0)
+    return '' if len == 0
+    
+    if buf
+      return Polyphony.backend_read(self, buf, len, true, buf_pos)
     end
-    buf
+    
+    @read_buffer ||= +''
+    result = Polyphony.backend_read(self, @read_buffer, len, true, -1)
+    return nil unless result
+    
+    already_read = @read_buffer
+    @read_buffer = +''
+    already_read
   end
 
   # Receives up to `maxlen` bytes from the socket. If `outbuf` is given, it is
@@ -391,10 +388,7 @@ class ::TCPSocket < ::IPSocket
   # unpacker:
   #
   #   unpacker = MessagePack::Unpacker.new
-  #   buffer = []
-  #   reader = spin do
-  #     i.feed_loop(unpacker, :feed_each) { |msg| handle_msg(msg) }
-  #   end
+  #   conn.feed_loop(unpacker, :feed_each) { |msg| handle_msg(msg) }
   #
   # @param receiver [any] receiver object
   # @param method [Symbol] method to call
@@ -548,24 +542,24 @@ class ::UNIXSocket < ::BasicSocket
   # If no bytes are available and `EOF` is not hit, this method will block until
   # the socket is ready to read from.
   #
-  # @param maxlen [Integer, nil] maximum bytes to read from socket
+  # @param len [Integer, nil] maximum bytes to read from socket
   # @param buf [String, nil] buffer to read into
   # @param buf_pos [Number] buffer position to read into
   # @return [String] buffer used for reading
-  def read(maxlen = nil, buf = nil, buf_pos = 0)
-    return Polyphony.backend_recv(self, buf, maxlen, buf_pos) if buf
-    return Polyphony.backend_recv(self, +'', maxlen, 0) if maxlen
-
-    buf = +''
-    len = buf.bytesize
-    while true
-      Polyphony.backend_recv(self, buf, maxlen || 4096, -1)
-      new_len = buf.bytesize
-      break if new_len == len
-
-      len = new_len
+  def read(len = nil, buf = nil, buf_pos = 0)
+    return '' if len == 0
+    
+    if buf
+      return Polyphony.backend_read(self, buf, len, true, buf_pos)
     end
-    buf
+    
+    @read_buffer ||= +''
+    result = Polyphony.backend_read(self, @read_buffer, len, true, -1)
+    return nil unless result
+    
+    already_read = @read_buffer
+    @read_buffer = +''
+    already_read
   end
 
   # Receives up to `maxlen` bytes from the socket. If `outbuf` is given, it is
@@ -603,10 +597,7 @@ class ::UNIXSocket < ::BasicSocket
   # unpacker:
   #
   #   unpacker = MessagePack::Unpacker.new
-  #   buffer = []
-  #   reader = spin do
-  #     i.feed_loop(unpacker, :feed_each) { |msg| handle_msg(msg) }
-  #   end
+  #   conn.feed_loop(unpacker, :feed_each) { |msg| handle_msg(msg) }
   #
   # @param receiver [any] receiver object
   # @param method [Symbol] method to call

data/lib/polyphony/version.rb

@@ -2,5 +2,5 @@
 
 module Polyphony
   # @!visibility private
-  VERSION = '1.0'
+  VERSION = '1.0.2'
 end

data/polyphony.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.summary     = 'Fine grained concurrency for Ruby'
   s.author      = 'Sharon Rosner'
   s.email       = 'sharon@noteflakes.com'
-  s.files       = `git ls-files --recurse-submodules`.split
+  s.files       = `git ls-files --recurse-submodules`.split.reject { |fn| fn =~ /liburing\/man/ }
   s.homepage    = 'https://digital-fabric.github.io/polyphony'
   s.metadata    = {
     "source_code_uri" => "https://github.com/digital-fabric/polyphony",
@@ -29,4 +29,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency  'msgpack',              '1.6.0'
   s.add_development_dependency  'httparty',             '0.21.0'
   s.add_development_dependency  'localhost',            '1.1.10'
+  s.add_development_dependency  'debug',                '1.8.0'
+  s.add_development_dependency  'benchmark-ips',        '2.10.0'
 end

data/test/test_socket.rb

@@ -75,7 +75,7 @@ class TCPSocketTest < MiniTest::Test
     server_fiber = spin do
       while (socket = server.accept)
         spin do
-          while (data = socket.read(8192))
+          while (data = socket.readpartial(8192))
             socket << data
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polyphony
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.0.2
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-11 00:00:00.000000000 Z
+date: 2023-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -122,6 +122,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.1.10
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.10.0
 description: 
 email: sharon@noteflakes.com
 executables: []
@@ -154,6 +182,7 @@ files:
 - docs/assets/echo-fibers.svg
 - docs/assets/polyphony-logo.png
 - docs/assets/sleeping-fiber.svg
+- docs/cheat-sheet.md
 - docs/concurrency.md
 - docs/design-principles.md
 - docs/exception-handling.md
@@ -181,6 +210,7 @@ files:
 - examples/core/calc_with_restart.rb
 - examples/core/calc_with_supervise.rb
 - examples/core/channels.rb
+- examples/core/debug.rb
 - examples/core/deferring-an-operation.rb
 - examples/core/enumerable.rb
 - examples/core/erlang-style-genserver.rb
@@ -197,6 +227,7 @@ files:
 - examples/core/recurrent-timer.rb
 - examples/core/resource_delegate.rb
 - examples/core/ring.rb
+- examples/core/rpc_benchmark.rb
 - examples/core/shutdown_all_children.rb
 - examples/core/spin.rb
 - examples/core/spin_error_backtrace.rb
@@ -424,153 +455,6 @@ files:
 - vendor/liburing/liburing.pc.in
 - vendor/liburing/liburing.spec
 - vendor/liburing/make-debs.sh
-- vendor/liburing/man/IO_URING_CHECK_VERSION.3
-- vendor/liburing/man/IO_URING_VERSION_MAJOR.3
-- vendor/liburing/man/IO_URING_VERSION_MINOR.3
-- vendor/liburing/man/io_uring.7
-- vendor/liburing/man/io_uring_buf_ring_add.3
-- vendor/liburing/man/io_uring_buf_ring_advance.3
-- vendor/liburing/man/io_uring_buf_ring_cq_advance.3
-- vendor/liburing/man/io_uring_buf_ring_init.3
-- vendor/liburing/man/io_uring_buf_ring_mask.3
-- vendor/liburing/man/io_uring_check_version.3
-- vendor/liburing/man/io_uring_close_ring_fd.3
-- vendor/liburing/man/io_uring_cq_advance.3
-- vendor/liburing/man/io_uring_cq_has_overflow.3
-- vendor/liburing/man/io_uring_cq_ready.3
-- vendor/liburing/man/io_uring_cqe_get_data.3
-- vendor/liburing/man/io_uring_cqe_get_data64.3
-- vendor/liburing/man/io_uring_cqe_seen.3
-- vendor/liburing/man/io_uring_enter.2
-- vendor/liburing/man/io_uring_enter2.2
-- vendor/liburing/man/io_uring_free_probe.3
-- vendor/liburing/man/io_uring_get_events.3
-- vendor/liburing/man/io_uring_get_probe.3
-- vendor/liburing/man/io_uring_get_sqe.3
-- vendor/liburing/man/io_uring_major_version.3
-- vendor/liburing/man/io_uring_minor_version.3
-- vendor/liburing/man/io_uring_opcode_supported.3
-- vendor/liburing/man/io_uring_peek_cqe.3
-- vendor/liburing/man/io_uring_prep_accept.3
-- vendor/liburing/man/io_uring_prep_accept_direct.3
-- vendor/liburing/man/io_uring_prep_cancel.3
-- vendor/liburing/man/io_uring_prep_cancel64.3
-- vendor/liburing/man/io_uring_prep_close.3
-- vendor/liburing/man/io_uring_prep_close_direct.3
-- vendor/liburing/man/io_uring_prep_connect.3
-- vendor/liburing/man/io_uring_prep_fadvise.3
-- vendor/liburing/man/io_uring_prep_fallocate.3
-- vendor/liburing/man/io_uring_prep_fgetxattr.3
-- vendor/liburing/man/io_uring_prep_files_update.3
-- vendor/liburing/man/io_uring_prep_fsetxattr.3
-- vendor/liburing/man/io_uring_prep_fsync.3
-- vendor/liburing/man/io_uring_prep_getxattr.3
-- vendor/liburing/man/io_uring_prep_link.3
-- vendor/liburing/man/io_uring_prep_link_timeout.3
-- vendor/liburing/man/io_uring_prep_linkat.3
-- vendor/liburing/man/io_uring_prep_madvise.3
-- vendor/liburing/man/io_uring_prep_mkdir.3
-- vendor/liburing/man/io_uring_prep_mkdirat.3
-- vendor/liburing/man/io_uring_prep_msg_ring.3
-- vendor/liburing/man/io_uring_prep_msg_ring_cqe_flags.3
-- vendor/liburing/man/io_uring_prep_multishot_accept.3
-- vendor/liburing/man/io_uring_prep_multishot_accept_direct.3
-- vendor/liburing/man/io_uring_prep_nop.3
-- vendor/liburing/man/io_uring_prep_openat.3
-- vendor/liburing/man/io_uring_prep_openat2.3
-- vendor/liburing/man/io_uring_prep_openat2_direct.3
-- vendor/liburing/man/io_uring_prep_openat_direct.3
-- vendor/liburing/man/io_uring_prep_poll_add.3
-- vendor/liburing/man/io_uring_prep_poll_multishot.3
-- vendor/liburing/man/io_uring_prep_poll_remove.3
-- vendor/liburing/man/io_uring_prep_poll_update.3
-- vendor/liburing/man/io_uring_prep_provide_buffers.3
-- vendor/liburing/man/io_uring_prep_read.3
-- vendor/liburing/man/io_uring_prep_read_fixed.3
-- vendor/liburing/man/io_uring_prep_readv.3
-- vendor/liburing/man/io_uring_prep_readv2.3
-- vendor/liburing/man/io_uring_prep_recv.3
-- vendor/liburing/man/io_uring_prep_recv_multishot.3
-- vendor/liburing/man/io_uring_prep_recvmsg.3
-- vendor/liburing/man/io_uring_prep_recvmsg_multishot.3
-- vendor/liburing/man/io_uring_prep_remove_buffers.3
-- vendor/liburing/man/io_uring_prep_rename.3
-- vendor/liburing/man/io_uring_prep_renameat.3
-- vendor/liburing/man/io_uring_prep_send.3
-- vendor/liburing/man/io_uring_prep_send_set_addr.3
-- vendor/liburing/man/io_uring_prep_send_zc.3
-- vendor/liburing/man/io_uring_prep_send_zc_fixed.3
-- vendor/liburing/man/io_uring_prep_sendmsg.3
-- vendor/liburing/man/io_uring_prep_sendmsg_zc.3
-- vendor/liburing/man/io_uring_prep_setxattr.3
-- vendor/liburing/man/io_uring_prep_shutdown.3
-- vendor/liburing/man/io_uring_prep_socket.3
-- vendor/liburing/man/io_uring_prep_socket_direct.3
-- vendor/liburing/man/io_uring_prep_socket_direct_alloc.3
-- vendor/liburing/man/io_uring_prep_splice.3
-- vendor/liburing/man/io_uring_prep_statx.3
-- vendor/liburing/man/io_uring_prep_symlink.3
-- vendor/liburing/man/io_uring_prep_symlinkat.3
-- vendor/liburing/man/io_uring_prep_sync_file_range.3
-- vendor/liburing/man/io_uring_prep_tee.3
-- vendor/liburing/man/io_uring_prep_timeout.3
-- vendor/liburing/man/io_uring_prep_timeout_remove.3
-- vendor/liburing/man/io_uring_prep_timeout_update.3
-- vendor/liburing/man/io_uring_prep_unlink.3
-- vendor/liburing/man/io_uring_prep_unlinkat.3
-- vendor/liburing/man/io_uring_prep_write.3
-- vendor/liburing/man/io_uring_prep_write_fixed.3
-- vendor/liburing/man/io_uring_prep_writev.3
-- vendor/liburing/man/io_uring_prep_writev2.3
-- vendor/liburing/man/io_uring_queue_exit.3
-- vendor/liburing/man/io_uring_queue_init.3
-- vendor/liburing/man/io_uring_queue_init_params.3
-- vendor/liburing/man/io_uring_recvmsg_cmsg_firsthdr.3
-- vendor/liburing/man/io_uring_recvmsg_cmsg_nexthdr.3
-- vendor/liburing/man/io_uring_recvmsg_name.3
-- vendor/liburing/man/io_uring_recvmsg_out.3
-- vendor/liburing/man/io_uring_recvmsg_payload.3
-- vendor/liburing/man/io_uring_recvmsg_payload_length.3
-- vendor/liburing/man/io_uring_recvmsg_validate.3
-- vendor/liburing/man/io_uring_register.2
-- vendor/liburing/man/io_uring_register_buf_ring.3
-- vendor/liburing/man/io_uring_register_buffers.3
-- vendor/liburing/man/io_uring_register_buffers_sparse.3
-- vendor/liburing/man/io_uring_register_buffers_tags.3
-- vendor/liburing/man/io_uring_register_buffers_update_tag.3
-- vendor/liburing/man/io_uring_register_eventfd.3
-- vendor/liburing/man/io_uring_register_eventfd_async.3
-- vendor/liburing/man/io_uring_register_file_alloc_range.3
-- vendor/liburing/man/io_uring_register_files.3
-- vendor/liburing/man/io_uring_register_files_sparse.3
-- vendor/liburing/man/io_uring_register_files_tags.3
-- vendor/liburing/man/io_uring_register_files_update.3
-- vendor/liburing/man/io_uring_register_files_update_tag.3
-- vendor/liburing/man/io_uring_register_iowq_aff.3
-- vendor/liburing/man/io_uring_register_iowq_max_workers.3
-- vendor/liburing/man/io_uring_register_ring_fd.3
-- vendor/liburing/man/io_uring_register_sync_cancel.3
-- vendor/liburing/man/io_uring_setup.2
-- vendor/liburing/man/io_uring_sq_ready.3
-- vendor/liburing/man/io_uring_sq_space_left.3
-- vendor/liburing/man/io_uring_sqe_set_data.3
-- vendor/liburing/man/io_uring_sqe_set_data64.3
-- vendor/liburing/man/io_uring_sqe_set_flags.3
-- vendor/liburing/man/io_uring_sqring_wait.3
-- vendor/liburing/man/io_uring_submit.3
-- vendor/liburing/man/io_uring_submit_and_get_events.3
-- vendor/liburing/man/io_uring_submit_and_wait.3
-- vendor/liburing/man/io_uring_submit_and_wait_timeout.3
-- vendor/liburing/man/io_uring_unregister_buf_ring.3
-- vendor/liburing/man/io_uring_unregister_buffers.3
-- vendor/liburing/man/io_uring_unregister_eventfd.3
-- vendor/liburing/man/io_uring_unregister_files.3
-- vendor/liburing/man/io_uring_unregister_iowq_aff.3
-- vendor/liburing/man/io_uring_unregister_ring_fd.3
-- vendor/liburing/man/io_uring_wait_cqe.3
-- vendor/liburing/man/io_uring_wait_cqe_nr.3
-- vendor/liburing/man/io_uring_wait_cqe_timeout.3
-- vendor/liburing/man/io_uring_wait_cqes.3
 - vendor/liburing/src/Makefile
 - vendor/liburing/src/arch/aarch64/lib.h
 - vendor/liburing/src/arch/aarch64/syscall.h

data/vendor/liburing/man/IO_URING_CHECK_VERSION.3

@@ -1 +0,0 @@
-io_uring_check_version.3

data/vendor/liburing/man/IO_URING_VERSION_MAJOR.3

@@ -1 +0,0 @@
-io_uring_check_version.3

data/vendor/liburing/man/IO_URING_VERSION_MINOR.3

@@ -1 +0,0 @@
-io_uring_check_version.3