xchan.rb 0.16.4 → 0.16.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f17c01d5c34d8de2176fa5241ca08bc985798d6a3d7d6b4fa355cd0f2cc6e739
-  data.tar.gz: 0f1908263e8a272e32d2ec6e8026c21e836c1da92ee2ed12a0a9949e69ed1d46
+  metadata.gz: e5030f45f888a9c83fadde357be0c919cece744735af66016d80bcd5a9970dcc
+  data.tar.gz: b9de8383ad5af12a57586087c0c95b37d08ff07e7838b12471583c06ebec214b
 SHA512:
-  metadata.gz: ac3779d634423270951d4c2d4818c021a856f066837f3b2015365d50af390cb5ccc2453475773f4ee0ed13ce1c19a30787e873ee43d84dc7d1ebd7f744e7a3f9
-  data.tar.gz: d7fccca83af9d0d73302b17b50d7b03843ce1c7d599f711e1a7f5b9252d1a8e9f40f7919134ffb25fb88007ee2578b0a9e7049a51b29c3cb0440df66a5ea0d09
+  metadata.gz: 6716dcd591f6384a8665e2601fcc10d17f7ecb2842ed656ffc13de90d785bf5bd2e089fcc2ef5bba2a58ebde0b544014cc769cec6315413d0ac7c32d99724930
+  data.tar.gz: 578c4aedba9104f7eeec52d1780df6ac7e7caed3040f19da4e4f20b436031e60f79ce2e7300e5ce6abbd6d638406143b5bcb0a4335b4400ae27cba05743f0db2

data/.gitignore

@@ -1,5 +1,4 @@
 *.gem
-.localgems/
 .bundle
 Gemfile.lock
 .yardoc/

data/README.md

@@ -111,7 +111,7 @@ This example performs a write that will block when the send buffer becomes full:
 ```ruby
 require "xchan"
 
-ch = xchan(:marshal, socket: Socket::SOCK_STREAM)
+ch = xchan(:marshal, sock_type: Socket::SOCK_STREAM)
 sndbuf = ch.getsockopt(:reader, Socket::SOL_SOCKET, Socket::SO_SNDBUF)
 while ch.bytes_sent <= sndbuf.int
   ch.send(1)
@@ -140,7 +140,7 @@ rescue Chan::WaitLockable
   retry
 end
 
-ch = xchan(:marshal, socket: Socket::SOCK_STREAM)
+ch = xchan(:marshal, sock_type: Socket::SOCK_STREAM)
 sndbuf = ch.getsockopt(:writer, Socket::SOL_SOCKET, Socket::SO_SNDBUF)
 while ch.bytes_sent <= sndbuf.int
   send_nonblock(ch, 1)
@@ -166,7 +166,7 @@ a keyword argument:
 
 ```ruby
 require "xchan"
-ch = xchan(:marshal, socket: Socket::SOCK_STREAM)
+ch = xchan(:marshal, sock_type: Socket::SOCK_STREAM)
 ```
 
 #### Options
@@ -222,19 +222,25 @@ ch = xchan(:marshal, tmpdir: Dir.home)
 
 ## Install
 
+**Git**
+
 xchan.rb is distributed as a RubyGem through its git repositories. <br>
 [GitHub](https://github.com/0x1eef/xchan.rb),
 and
 [GitLab](https://gitlab.com/0x1eef/xchan.rb)
 are available as sources.
 
-**Gemfile**
-
-```ruby
-gem "xchan.rb", github: "0x1eef/xchan.rb", tag: "v0.16.3"
-gem "lockf.rb", github: "0x1eef/lockf.rb", tag: "v0.10.6"
+``` ruby
+# Gemfile
+gem "xchan.rb", github: "0x1eef/xchan.rb", tag: "v0.16.5"
 ```
 
+**Rubygems.org**
+
+xchan.rb can also be installed via rubygems.org.
+
+    gem install xchan.rb
+
 ## <a id="license"> License </a>
 
 [BSD Zero Clause](https://choosealicense.com/licenses/0bsd/).

data/lib/xchan/mixin.rb

@@ -11,7 +11,7 @@ module Chan::Mixin
   #   ch.close
   #
   # @param serializer (see Chan::UNIXSocket#initialize)
-  # @param socket (see Chan::UNIXSocket#initialize)
+  # @param sock_type (see Chan::UNIXSocket#initialize)
   # @param tmpdir (see Chan::UNIXSocket#initialize)
   # @return (see Chan::UNIXSocket#initialize)
   def xchan(serializer = :marshal, **kw_args)

data/lib/xchan/unix_socket.rb

@@ -18,7 +18,7 @@ class Chan::UNIXSocket
   # @param [Symbol, <#dump, #load>] serializer
   #  A serializer.
   #
-  # @param [Integer] socket
+  # @param [Integer] sock_type
   #  A socket type (eg Socket::SOCK_STREAM).
   #
   # @param [String] tmpdir
@@ -26,9 +26,9 @@ class Chan::UNIXSocket
   #
   # @return [Chan::UNIXSocket]
   #  Returns an instance of {Chan::UNIXSocket Chan::UNIXSocket}.
-  def initialize(serializer, tmpdir: Dir.tmpdir, socket: Socket::SOCK_DGRAM)
+  def initialize(serializer, tmpdir: Dir.tmpdir, sock_type: Socket::SOCK_DGRAM)
     @serializer = Chan.serializers[serializer]&.call || serializer
-    @r, @w = ::UNIXSocket.pair(socket)
+    @r, @w = ::UNIXSocket.pair(sock_type)
     @bytes = Chan::Bytes.new(tmpdir)
     @lock = LockFile.new Chan.temporary_file("xchan.lock", tmpdir:)
   end

data/lib/xchan/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Chan
-  VERSION = "0.16.4"
+  VERSION = "0.16.5"
 end

data/share/xchan.rb/examples/write_operations/1_blocking_write.rb

@@ -3,7 +3,7 @@
 require_relative "../setup"
 require "xchan"
 
-ch = xchan(:marshal, socket: Socket::SOCK_STREAM)
+ch = xchan(:marshal, sock_type: Socket::SOCK_STREAM)
 sndbuf = ch.getsockopt(:reader, Socket::SOL_SOCKET, Socket::SO_SNDBUF)
 while ch.bytes_sent <= sndbuf.int
   ch.send(1)

data/share/xchan.rb/examples/write_operations/2_nonblocking_write.rb

@@ -14,7 +14,7 @@ rescue Chan::WaitLockable
   retry
 end
 
-ch = xchan(:marshal, socket: Socket::SOCK_STREAM)
+ch = xchan(:marshal, sock_type: Socket::SOCK_STREAM)
 sndbuf = ch.getsockopt(:writer, Socket::SOL_SOCKET, Socket::SO_SNDBUF)
 while ch.bytes_sent <= sndbuf.int
   send_nonblock(ch, 1)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xchan.rb
 version: !ruby/object:Gem::Version
-  version: 0.16.4
+  version: 0.16.5
 platform: ruby
 authors:
 - '0x1eef'