nl 0.2.4 → 0.3.0

data/lib/nl/sequence_allocator.rb

@@ -0,0 +1,36 @@
+# rbs_inline: enabled
+
+require_relative 'error'
+
+module Nl
+  # Allocates nonzero 32-bit Netlink sequence numbers.
+  class SequenceAllocator
+    MAX = 0xFFFFFFFF
+    private_constant :MAX
+
+    def initialize
+      @last = 0
+    end
+
+    # Returns the next sequence number not rejected by the optional block.
+    def next
+      first = advance
+      candidate = first
+
+      loop do
+        return candidate unless block_given? && yield(candidate)
+
+        candidate = advance
+        if candidate == first
+          raise ExhaustedSequenceNumber, 'all Netlink sequence numbers are in use'
+        end
+      end
+    end
+
+    private def advance
+      @last = @last == MAX ? 1 : @last + 1
+    end
+  end
+
+  private_constant :SequenceAllocator
+end

data/lib/nl/socket.rb

@@ -8,6 +8,11 @@ module Nl
     module Constants
       # From include/linux/socket.h
       PF_NETLINK = AF_NETLINK = 16
+
+      # From include/uapi/linux/netlink.h
+      SOL_NETLINK = 270
+      NETLINK_ADD_MEMBERSHIP = 1
+      NETLINK_DROP_MEMBERSHIP = 2
     end
     include Constants
 
@@ -21,7 +26,6 @@ module Nl
     # @param protonum [Integer] Netlink protocol number
     def initialize(protonum)
       super(PF_NETLINK, SOCK_RAW, protonum)
-      @seq = 0  # last-used sequence number
     end
 
     def self.open(protonum)
@@ -34,20 +38,19 @@ module Nl
       end
     end
 
-    # XXX: Should Protocol manage next_seq?
+    # @return [Integer] Local Netlink port ID assigned to this socket
+    def local_port_id
+      Socket.unpack_sockaddr_nl(local_address.to_sockaddr).first
+    end
 
-    # @return [Integer] Get next sequence number
-    def next_seq
-      nseq = (@seq + 1) & 0xFFFFFFFF
-      nseq = 1 if nseq == 0  # seq=0 is for notification
-      @seq = nseq
+    # Adds this socket to a Netlink multicast group.
+    def add_membership(group_id)
+      setsockopt(SOL_NETLINK, NETLINK_ADD_MEMBERSHIP, group_id)
     end
 
-    def complete(hdr)
-      [
-        hdr.seq ||= next_seq,
-        hdr.pid ||= Socket.unpack_sockaddr_nl(local_address.to_sockaddr).first,
-      ]
+    # Removes this socket from a Netlink multicast group.
+    def drop_membership(group_id)
+      setsockopt(SOL_NETLINK, NETLINK_DROP_MEMBERSHIP, group_id)
     end
   end
 end

data/lib/nl/version.rb

@@ -1,3 +1,3 @@
 module Nl
-  VERSION = '0.2.4'
+  VERSION = '0.3.0'
 end

data/lib/nl.rb

@@ -1,14 +1,13 @@
-require_relative 'nl/version'
+require_relative 'nl/error'
 require_relative 'nl/core'
+require_relative 'nl/notification'
+require_relative 'nl/connection'
+require_relative 'nl/family'
 require_relative 'nl/genl'
 require_relative 'nl/socket'
-require_relative 'nl/family'
-require_relative 'nl/protocols/raw'
-require_relative 'nl/protocols/genl'
+require_relative 'nl/version'
 
 module Nl
-  class Error < StandardError; end
-
   include Core
   include Genl
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nl
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Kasumi Hanazuki
@@ -9,7 +9,8 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description: Linux Netlink client
+description: nl is a general-purpose Netlink implementation for building Ruby applications
+  that communicate with Linux kernel APIs or other userspace processes.
 email:
 - kasumi@rollingapple.net
 executables: []
@@ -22,14 +23,28 @@ files:
 - README.md
 - Rakefile
 - lib/nl.rb
+- lib/nl/async.rb
+- lib/nl/async/dispatcher.rb
+- lib/nl/async/driver.rb
+- lib/nl/async/mailbox.rb
+- lib/nl/async/operation.rb
+- lib/nl/blocking_transport.rb
+- lib/nl/connection.rb
 - lib/nl/core.rb
+- lib/nl/datagram.rb
 - lib/nl/decoder.rb
 - lib/nl/encoder.rb
 - lib/nl/endian.rb
+- lib/nl/error.rb
+- lib/nl/exchange.rb
 - lib/nl/family.rb
 - lib/nl/genl.rb
+- lib/nl/genl/connection.rb
+- lib/nl/notification.rb
+- lib/nl/notification_router.rb
 - lib/nl/protocols/genl.rb
 - lib/nl/protocols/raw.rb
+- lib/nl/sequence_allocator.rb
 - lib/nl/socket.rb
 - lib/nl/version.rb
 homepage: https://github.com/hanazuki/nl
@@ -37,7 +52,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/hanazuki/nl
-  source_code_uri: https://github.com/hanazuki/nl/tree/v0.2.4
+  source_code_uri: https://github.com/hanazuki/nl/tree/v0.3.0
   changelog_uri: https://github.com/hanazuki/nl/blob/master/CHANGELOG.md
 rdoc_options: []
 require_paths:
@@ -46,7 +61,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -55,5 +70,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.6
 specification_version: 4
-summary: Linux Netlink client
+summary: Netlink protocol support for Ruby
 test_files: []