nl 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fbd6064a908ddacbadbb65eaa2f7c7ab862baf91478804f1915ba988271b759
-  data.tar.gz: f49043a50d47c82da9f1f818f02948a12f386df091b7041e4ae1b7d755780b23
+  metadata.gz: 79ef39fff2bdef294954fb2504056339d504229a5ea65c967319f16bdbe23baf
+  data.tar.gz: b5f40b4f424d888406b6d2d6998e2182a5303fc2d4c4ad5d5be6c9d95005731d
 SHA512:
-  metadata.gz: 0f162b7c19214639fdd277bea5fdedb1ef4661a8747de0458b08dd85fefa94ec36dfbbd71b039ef5143069ca903e54d133029528dd4a75cee865d6b409db7251
-  data.tar.gz: c538d2a693926047576fc49bd82fd0bf435cbe19e3c61c21536826a0d873f260b87f2b6544dec4dac73e5385c11baa1da741c901bd81f2711eadb827cf34f356
+  metadata.gz: 61b396c794cbb4b65538ecaf605aa954b01ec4bbf53d80169b5cc0804c6176405b5c75dc6776f5a5af63091ef94a1f02fd48604c4a801836cadde0567b8a8855
+  data.tar.gz: 37cbe64bd74bd5d47fca5c5306ee8f490dfe84445595e8db7ed02716de2abbe2eff3594b806ef9ece125ab03d11fd9f4aa826347447aafce62f5e5c00941bcd7

data/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+## v0.4.2 (2026-09-09)
+
 ## v0.4.1 (2026-09-08)
 
 ## v0.4.0 (2026-09-08)

data/lib/nl/endian.rb

@@ -1,6 +1,5 @@
-# Byte-order helpers
-
 module Nl
+  # Byte-order helpers
   module Endian
     # sizeof(int)
     SIZEOF_INT = [1].pack('i!').bytesize

data/lib/nl/family.rb

@@ -34,18 +34,20 @@ module Nl
   #   end
 
   class Family
-    DEFAULT_NOTIFICATION_CAPACITY = Connection::DEFAULT_NOTIFICATION_CAPACITY
+    DEFAULT_NOTIFICATION_CAPACITY = Connection::DEFAULT_NOTIFICATION_CAPACITY #: Integer
 
+    # Socket-owning family.
+    #
+    # {Family} instances that owns sockets are extended with this module.
     module Session
-      def close #: nil
+      # Closes the Netlink socket owned by this {Family}.
+      # @rbs () -> void
+      def close
         @connection.close
       end
     end
 
-    #--
-    # @rbs connection: _Connection
-    # @rbs endpoint: Raw::Endpoint
-    # @rbs return: instance
+    # @rbs (_Connection connection, endpoint: Raw::Endpoint) -> instance
     def initialize(connection, endpoint:)
       @endpoint = endpoint
       @connection = connection
@@ -59,38 +61,54 @@ module Nl
       @connection.exchange(@endpoint, kind, request_class, reply_class, args, &block)
     end
 
-    def async_capable? #: bool
+    # Returns if this family supports asynchronous operations.
+    #
+    # @rbs () -> bool
+    def async_capable?
       @connection.async_capable?
     end
 
-    # Adds multicast memberships to the existing family socket. Membership is
-    # additive and remains active until explicitly removed or the owner closes.
+    # Adds multicast memberships to the netlink socket.
+    #
+    # Membership is additive and remains active until explicitly removed or the owner closes.
+    #
+    # @param [Array<Symbol>] groups
+    # @return [Family] self
+    # @rbs (Symbol *groups) -> self
     def subscribe(*groups)
       @connection.add_memberships(multicast_group_ids(groups))
       self
     end
 
+    # Removes multicast memberships from the netlink socket.
+    #
+    # @param [Array<Symbol>] groups
+    # @return [Family] self
+    # @rbs (Symbol *groups) -> self
     def unsubscribe(*groups)
       @connection.drop_memberships(multicast_group_ids(groups))
       self
     end
 
+    # Receives the next unsolicited message.
+    #
+    # @rbs (?timeout: Integer?) -> Message
     def receive_notification(timeout: nil)
       @notification_stream.next(timeout:)
     end
 
+    # Receives unsolicited messages.
+    #
+    # @rbs () { (Message) -> void } -> void
     def each_notification(&block)
       return @notification_stream.each unless block
 
       @notification_stream.each(&block)
     end
 
-    # Builds a generated asynchronous-operation facade with a narrowly scoped
-    # callback, so the facade does not need access to Family's private API.
-    #--
-    # @rbs operations_class: Class
-    # @rbs stream_capacity: Integer?
-    # @rbs return: untyped
+    # Builds a asynchronous-operation facade.
+    #
+    # @rbs (Class operations_class, ?stream_capacity: Integer?) -> untyped
     private def build_async_facade(operations_class, stream_capacity: nil)
       unless async_capable?
         raise Async::UnavailableError, 'async operations require an executor'

data/lib/nl/genl/client.rb

@@ -1,4 +1,5 @@
 # Generic Netlink client handling
+#-
 
 require_relative '../connection'
 require_relative 'wire'

data/lib/nl/genl/wire.rb

@@ -1,4 +1,5 @@
 # Generic Netlink wire definitions
+#-
 
 require_relative '../raw/wire'
 require_relative '../endian'

data/lib/nl/genl.rb

@@ -1,5 +1,3 @@
-# Generic Netlink family support
-
 require_relative 'genl/wire'
 require_relative 'family'
 require_relative 'raw'

data/lib/nl/raw/client.rb

@@ -1,4 +1,5 @@
 # Raw Netlink client handling
+#-
 
 require_relative '../connection'
 require_relative 'protocol'
@@ -73,7 +74,6 @@ module Nl
       # Closes the underlying Netlink connection.
       #
       # @return [void]
-      #--
       # @rbs () -> void
       def close
         @connection.close

data/lib/nl/raw/wire.rb

@@ -1,4 +1,5 @@
 # Netlink wire definitions
+#-
 
 require_relative '../endian'
 

data/lib/nl/socket.rb

@@ -1,15 +1,15 @@
-# Netlink sockets
-
 require 'socket'
 
 module Nl
   # Netlink socket
   class Socket < ::Socket
     module Constants
-      # From include/linux/socket.h
+      # From linux/socket.h
+      #-
       PF_NETLINK = AF_NETLINK = 16
 
-      # From include/uapi/linux/netlink.h
+      # From linux/netlink.h
+      #-
       SOL_NETLINK = 270
       NETLINK_ADD_MEMBERSHIP = 1
       NETLINK_DROP_MEMBERSHIP = 2
@@ -17,17 +17,28 @@ module Nl
     include Constants
 
     class << self
+      # Packs Netlink socket address
+      #
+      # @rbs (Integer pid, Integer groups) -> String
       def pack_sockaddr_nl(pid, groups) = [Socket::AF_NETLINK, 0, pid, groups].pack('S!S!LL')
       alias sockaddr_nl pack_sockaddr_nl
 
+      # Unpacks Netlink socket address
+      #
+      # @rbs (String) -> [Integer, Integer]
       def unpack_sockaddr_nl(sockaddr) = sockaddr.unpack('S!S!LL')[2..3]
     end
 
-    # @param protonum [Integer] Netlink protocol number
+    # @param [Integer] protonum Netlink protocol number
+    # @rbs (Integer) -> void
     def initialize(protonum)
       super(PF_NETLINK, SOCK_RAW, protonum)
     end
 
+    # Opens a Netlink socket for the specified protocol number.
+    #
+    # @rbs (Integer protonum) -> instance
+    #    | [R] (Integer protonum) { (instance) -> R } -> R
     def self.open(protonum)
       return new(protonum) unless block_given?
       begin
@@ -39,16 +50,21 @@ module Nl
     end
 
     # @return [Integer] Local Netlink port ID assigned to this socket
+    # @rbs () -> Integer
     def local_port_id
       Socket.unpack_sockaddr_nl(local_address.to_sockaddr).first
     end
 
     # Adds this socket to a Netlink multicast group.
+    #
+    # @rbs (Integer group_id) -> void
     def add_membership(group_id)
       setsockopt(SOL_NETLINK, NETLINK_ADD_MEMBERSHIP, group_id)
     end
 
     # Removes this socket from a Netlink multicast group.
+    #
+    # @rbs (Integer group_id) -> void
     def drop_membership(group_id)
       setsockopt(SOL_NETLINK, NETLINK_DROP_MEMBERSHIP, group_id)
     end

data/lib/nl/version.rb

@@ -1,3 +1,3 @@
 module Nl
-  VERSION = '0.4.1'
+  VERSION = '0.4.2'
 end

data/sig/generated/nl/endian.rbs

@@ -1,6 +1,7 @@
 # Generated from lib/nl/endian.rb with RBS::Inline
 
 module Nl
+  # Byte-order helpers
   module Endian
     # sizeof(int)
     SIZEOF_INT: untyped

data/sig/generated/nl/family.rbs

@@ -26,38 +26,56 @@ module Nl
   end
 
   class Family
-    DEFAULT_NOTIFICATION_CAPACITY: untyped
+    DEFAULT_NOTIFICATION_CAPACITY: Integer
 
+    # Socket-owning family.
+    #
+    # {Family} instances that owns sockets are extended with this module.
     module Session
-      def close: () -> nil
+      # Closes the Netlink socket owned by this {Family}.
+      # @rbs () -> void
+      def close: () -> void
     end
 
-    # --
-    #  @rbs connection: _Connection
-    #  @rbs endpoint: Raw::Endpoint
-    #  @rbs return: instance
+    # @rbs (_Connection connection, endpoint: Raw::Endpoint) -> instance
     def initialize: (_Connection connection, endpoint: Raw::Endpoint) -> instance
 
     private def exchange_message: (untyped kind, untyped request_class, untyped reply_class, untyped args) ?{ (?) -> untyped } -> untyped
 
+    # Returns if this family supports asynchronous operations.
+    #
+    # @rbs () -> bool
     def async_capable?: () -> bool
 
-    # Adds multicast memberships to the existing family socket. Membership is
-    # additive and remains active until explicitly removed or the owner closes.
-    def subscribe: (*untyped groups) -> untyped
-
-    def unsubscribe: (*untyped groups) -> untyped
-
-    def receive_notification: (?timeout: untyped) -> untyped
-
-    def each_notification: () ?{ (?) -> untyped } -> untyped
-
-    # Builds a generated asynchronous-operation facade with a narrowly scoped
-    # callback, so the facade does not need access to Family's private API.
-    # --
-    # @rbs operations_class: Class
-    # @rbs stream_capacity: Integer?
-    # @rbs return: untyped
+    # Adds multicast memberships to the netlink socket.
+    #
+    # Membership is additive and remains active until explicitly removed or the owner closes.
+    #
+    # @param [Array<Symbol>] groups
+    # @return [Family] self
+    # @rbs (Symbol *groups) -> self
+    def subscribe:
+
+    # Removes multicast memberships from the netlink socket.
+    #
+    # @param [Array<Symbol>] groups
+    # @return [Family] self
+    # @rbs (Symbol *groups) -> self
+    def unsubscribe:
+
+    # Receives the next unsolicited message.
+    #
+    # @rbs (?timeout: Integer?) -> Message
+    def receive_notification: (?timeout: Integer?) -> Message
+
+    # Receives unsolicited messages.
+    #
+    # @rbs () { (Message) -> void } -> void
+    def each_notification: () { (Message) -> void } -> void
+
+    # Builds a asynchronous-operation facade.
+    #
+    # @rbs (Class operations_class, ?stream_capacity: Integer?) -> untyped
     private def build_async_facade: (Class operations_class, ?stream_capacity: Integer?) -> untyped
 
     private def exchange_message_async: (untyped kind, untyped request_class, untyped reply_class, untyped args, ?stream_capacity: untyped) -> untyped

data/sig/generated/nl/raw/client.rbs

@@ -42,7 +42,6 @@ module Nl
       # Closes the underlying Netlink connection.
       #
       # @return [void]
-      # --
       # @rbs () -> void
       def close: () -> void
     end

data/sig/generated/nl/socket.rbs

@@ -4,10 +4,12 @@ module Nl
   # Netlink socket
   class Socket < ::Socket
     module Constants
-      # From include/linux/socket.h
+      # From linux/socket.h
+      # -
       PF_NETLINK: untyped
 
-      # From include/uapi/linux/netlink.h
+      # From linux/netlink.h
+      # -
       SOL_NETLINK: ::Integer
 
       NETLINK_ADD_MEMBERSHIP: ::Integer
@@ -17,24 +19,41 @@ module Nl
 
     include Constants
 
-    def self.pack_sockaddr_nl: (untyped pid, untyped groups) -> untyped
+    # Packs Netlink socket address
+    #
+    # @rbs (Integer pid, Integer groups) -> String
+    def self.pack_sockaddr_nl: (Integer pid, Integer groups) -> String
 
     alias self.sockaddr_nl self.pack_sockaddr_nl
 
-    def self.unpack_sockaddr_nl: (untyped sockaddr) -> untyped
+    # Unpacks Netlink socket address
+    #
+    # @rbs (String) -> [Integer, Integer]
+    def self.unpack_sockaddr_nl: (String) -> [ Integer, Integer ]
 
-    # @param protonum [Integer] Netlink protocol number
-    def initialize: (untyped protonum) -> untyped
+    # @param [Integer] protonum Netlink protocol number
+    # @rbs (Integer) -> void
+    def initialize: (Integer) -> void
 
-    def self.open: (untyped protonum) -> untyped
+    # Opens a Netlink socket for the specified protocol number.
+    #
+    # @rbs (Integer protonum) -> instance
+    #    | [R] (Integer protonum) { (instance) -> R } -> R
+    def self.open: (Integer protonum) -> instance
+                 | [R] (Integer protonum) { (instance) -> R } -> R
 
     # @return [Integer] Local Netlink port ID assigned to this socket
-    def local_port_id: () -> untyped
+    # @rbs () -> Integer
+    def local_port_id: () -> Integer
 
     # Adds this socket to a Netlink multicast group.
-    def add_membership: (untyped group_id) -> untyped
+    #
+    # @rbs (Integer group_id) -> void
+    def add_membership: (Integer group_id) -> void
 
     # Removes this socket from a Netlink multicast group.
-    def drop_membership: (untyped group_id) -> untyped
+    #
+    # @rbs (Integer group_id) -> void
+    def drop_membership: (Integer group_id) -> void
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nl
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Kasumi Hanazuki
@@ -93,7 +93,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/hanazuki/nl
-  source_code_uri: https://github.com/hanazuki/nl/tree/v0.4.1
+  source_code_uri: https://github.com/hanazuki/nl/tree/v0.4.2
   changelog_uri: https://github.com/hanazuki/nl/blob/master/CHANGELOG.md
 rdoc_options: []
 require_paths: