nl-linux 0.2.4 → 0.3.0

data/generated/nl/linux/team.rb

@@ -1,4 +1,6 @@
 # SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
+#
+# This file is based on Documentation/netlink/specs/team.yaml from Linux v7.2.
 #--
 # frozen_string_literal: true
 # rbs_inline: enabled
@@ -9,6 +11,7 @@ module Nl; module Linux
 class Team < ::Nl::Family
   NAME = "team"
   PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Genl.new("team"))
+  MCAST_GROUPS = Ractor.make_shareable({}) #: Hash[::Symbol, ::Nl::McastGroup]
   module Structs
   end
   module AttributeSets
@@ -223,6 +226,13 @@ class Team < ::Nl::Family
     ItemPort::Port::DATATYPE = ::Nl::Protocols::Genl::DataTypes::NestedAttributes.new(AttrPort)
   end
   module Messages
+    # No operation
+    class DoNoopRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 0
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Team
+      ATTRIBUTES = Ractor.make_shareable(%i[])
+    end
     # No operation
     class DoNoopReply < ::Nl::Protocols::Genl::Message
       TYPE = 0
@@ -235,6 +245,8 @@ class Team < ::Nl::Family
       def team_ifindex; attributes[:"team_ifindex"]&.value; end
     end
     # Set team options
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoOptionsSetRequest < ::Nl::Protocols::Genl::Message
       TYPE = 1
       FIXED_HEADER = nil
@@ -250,6 +262,8 @@ class Team < ::Nl::Family
       def list_option; attributes[:"list_option"]&.value; end
     end
     # Set team options
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoOptionsSetReply < ::Nl::Protocols::Genl::Message
       TYPE = 1
       FIXED_HEADER = nil
@@ -265,6 +279,8 @@ class Team < ::Nl::Family
       def list_option; attributes[:"list_option"]&.value; end
     end
     # Get team options info
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoOptionsGetRequest < ::Nl::Protocols::Genl::Message
       TYPE = 2
       FIXED_HEADER = nil
@@ -276,6 +292,8 @@ class Team < ::Nl::Family
       def team_ifindex; attributes[:"team_ifindex"]&.value; end
     end
     # Get team options info
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoOptionsGetReply < ::Nl::Protocols::Genl::Message
       TYPE = 2
       FIXED_HEADER = nil
@@ -291,6 +309,8 @@ class Team < ::Nl::Family
       def list_option; attributes[:"list_option"]&.value; end
     end
     # Get team ports info
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoPortListGetRequest < ::Nl::Protocols::Genl::Message
       TYPE = 3
       FIXED_HEADER = nil
@@ -302,6 +322,8 @@ class Team < ::Nl::Family
       def team_ifindex; attributes[:"team_ifindex"]&.value; end
     end
     # Get team ports info
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoPortListGetReply < ::Nl::Protocols::Genl::Message
       TYPE = 3
       FIXED_HEADER = nil
@@ -317,23 +339,81 @@ class Team < ::Nl::Family
       def list_port; attributes[:"list_port"]&.value; end
     end
   end
+  module Notifications
+  end
+  NOTIFICATIONS = Ractor.make_shareable({}) #: Hash[::Integer, ::Class]
+  # No operation
+  #--
+  # @rbs () -> Messages::DoNoopReply
+  def do_noop(**args)
+    exchange_message(:"do", Messages::DoNoopRequest, Messages::DoNoopReply, args)
+  end
   # Set team options
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
   #--
   # @rbs (?team_ifindex: ::Integer, ?list_option: AttributeSets::ItemOption) -> Messages::DoOptionsSetReply
   def do_options_set(**args)
     exchange_message(:"do", Messages::DoOptionsSetRequest, Messages::DoOptionsSetReply, args)
   end
   # Get team options info
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
   #--
   # @rbs (?team_ifindex: ::Integer) -> Messages::DoOptionsGetReply
   def do_options_get(**args)
     exchange_message(:"do", Messages::DoOptionsGetRequest, Messages::DoOptionsGetReply, args)
   end
   # Get team ports info
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
   #--
   # @rbs (?team_ifindex: ::Integer) -> Messages::DoPortListGetReply
   def do_port_list_get(**args)
     exchange_message(:"do", Messages::DoPortListGetRequest, Messages::DoPortListGetReply, args)
   end
+  class AsyncOperations
+    # :nodoc:
+    def initialize(&exchange)
+      @exchange = exchange
+    end
+    # No operation
+    #--
+    # @rbs () -> ::Nl::Async::Future[Messages::DoNoopReply]
+    def do_noop(**args)
+      @exchange.call(:"do", Messages::DoNoopRequest, Messages::DoNoopReply, args)
+    end
+    # Set team options
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?team_ifindex: ::Integer, ?list_option: AttributeSets::ItemOption) -> ::Nl::Async::Future[Messages::DoOptionsSetReply]
+    def do_options_set(**args)
+      @exchange.call(:"do", Messages::DoOptionsSetRequest, Messages::DoOptionsSetReply, args)
+    end
+    # Get team options info
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?team_ifindex: ::Integer) -> ::Nl::Async::Future[Messages::DoOptionsGetReply]
+    def do_options_get(**args)
+      @exchange.call(:"do", Messages::DoOptionsGetRequest, Messages::DoOptionsGetReply, args)
+    end
+    # Get team ports info
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?team_ifindex: ::Integer) -> ::Nl::Async::Future[Messages::DoPortListGetReply]
+    def do_port_list_get(**args)
+      @exchange.call(:"do", Messages::DoPortListGetRequest, Messages::DoPortListGetReply, args)
+    end
+  end
+  # Returns the asynchronous operation facade for this family.
+  #--
+  # @rbs (?stream_capacity: ::Integer?) -> AsyncOperations
+  def async(stream_capacity: nil)
+    return @async_operations ||= build_async_facade(AsyncOperations) if stream_capacity.nil?
+    build_async_facade(AsyncOperations, stream_capacity:)
+  end
 end
 end; end

data/generated/nl/linux/wireguard.rb

@@ -1,4 +1,6 @@
 # SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
+#
+# This file is based on Documentation/netlink/specs/wireguard.yaml from Linux v7.2.
 #--
 # frozen_string_literal: true
 # rbs_inline: enabled
@@ -16,6 +18,7 @@ module Nl; module Linux
 class Wireguard < ::Nl::Family
   NAME = "wireguard"
   PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Genl.new("wireguard"))
+  MCAST_GROUPS = Ractor.make_shareable({}) #: Hash[::Symbol, ::Nl::McastGroup]
   module Structs
     KernelTimespec = Struct.new(
       :"sec", #: ::Integer
@@ -240,6 +243,9 @@ class Wireguard < ::Nl::Family
     # be ``NLMSG_DONE``, even if an error occurs. However, this ``NLMSG_DONE``
     # message contains an integer error code. It is either zero or a negative
     # error code corresponding to the errno.
+    # 
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
     class DumpGetDeviceRequest < ::Nl::Protocols::Genl::Message
       TYPE = 0
       FIXED_HEADER = nil
@@ -278,6 +284,9 @@ class Wireguard < ::Nl::Family
     # be ``NLMSG_DONE``, even if an error occurs. However, this ``NLMSG_DONE``
     # message contains an integer error code. It is either zero or a negative
     # error code corresponding to the errno.
+    # 
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
     class DumpGetDeviceReply < ::Nl::Protocols::Genl::Message
       TYPE = 0
       FIXED_HEADER = nil
@@ -293,11 +302,11 @@ class Wireguard < ::Nl::Family
       def ifname; attributes[:"ifname"]&.value; end
       # Gets the value of `private-key` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def private_key; attributes[:"private_key"]&.value; end
       # Gets the value of `public-key` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def public_key; attributes[:"public_key"]&.value; end
       # Gets the value of `flags` attribute in the message.
       #--
@@ -313,7 +322,7 @@ class Wireguard < ::Nl::Family
       def fwmark; attributes[:"fwmark"]&.value; end
       # Gets the value of `peers` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::Array[AttributeSets::Wgpeer]
       def peers; attributes[:"peers"]&.value; end
     end
     # Set WireGuard device
@@ -334,6 +343,9 @@ class Wireguard < ::Nl::Family
     # subsequent fragments.
     # 
     # If an error occurs, ``NLMSG_ERROR`` will reply containing an errno.
+    # 
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
     class DoSetDeviceRequest < ::Nl::Protocols::Genl::Message
       TYPE = 1
       FIXED_HEADER = nil
@@ -349,11 +361,11 @@ class Wireguard < ::Nl::Family
       def ifname; attributes[:"ifname"]&.value; end
       # Gets the value of `private-key` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def private_key; attributes[:"private_key"]&.value; end
       # Gets the value of `public-key` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def public_key; attributes[:"public_key"]&.value; end
       # Gets the value of `flags` attribute in the message.
       #--
@@ -369,10 +381,13 @@ class Wireguard < ::Nl::Family
       def fwmark; attributes[:"fwmark"]&.value; end
       # Gets the value of `peers` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::Array[AttributeSets::Wgpeer]
       def peers; attributes[:"peers"]&.value; end
     end
   end
+  module Notifications
+  end
+  NOTIFICATIONS = Ractor.make_shareable({}) #: Hash[::Integer, ::Class]
   # Retrieve WireGuard device
   # ~~~~~~~~~~~~~~~~~~~~~~~~~
   # 
@@ -397,6 +412,9 @@ class Wireguard < ::Nl::Family
   # be ``NLMSG_DONE``, even if an error occurs. However, this ``NLMSG_DONE``
   # message contains an integer error code. It is either zero or a negative
   # error code corresponding to the errno.
+  # 
+  # 
+  # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
   #--
   # @rbs (?ifindex: ::Integer, ?ifname: ::String) -> Enumerable[Messages::DumpGetDeviceReply]
   #   | (?ifindex: ::Integer, ?ifname: ::String) { (Messages::DumpGetDeviceReply) -> void } -> void
@@ -421,10 +439,84 @@ class Wireguard < ::Nl::Family
   # subsequent fragments.
   # 
   # If an error occurs, ``NLMSG_ERROR`` will reply containing an errno.
+  # 
+  # 
+  # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
   #--
-  # @rbs (?ifindex: ::Integer, ?ifname: ::String, ?private_key: untyped, ?public_key: untyped, ?flags: ::Integer, ?listen_port: ::Integer, ?fwmark: ::Integer, ?peers: untyped) -> void
+  # @rbs (?ifindex: ::Integer, ?ifname: ::String, ?private_key: ::String, ?public_key: ::String, ?flags: ::Integer, ?listen_port: ::Integer, ?fwmark: ::Integer, ?peers: ::Array[AttributeSets::Wgpeer]) -> void
   def do_set_device(**args)
     exchange_message(:"do", Messages::DoSetDeviceRequest, nil, args)
   end
+  class AsyncOperations
+    # :nodoc:
+    def initialize(&exchange)
+      @exchange = exchange
+    end
+    # Retrieve WireGuard device
+    # ~~~~~~~~~~~~~~~~~~~~~~~~~
+    # 
+    # The command should be called with one but not both of:
+    # 
+    # - ``WGDEVICE_A_IFINDEX``
+    # - ``WGDEVICE_A_IFNAME``
+    # 
+    # The kernel will then return several messages (``NLM_F_MULTI``). It is
+    # possible that all of the allowed IPs of a single peer will not fit
+    # within a single netlink message. In that case, the same peer will be
+    # written in the following message, except it will only contain
+    # ``WGPEER_A_PUBLIC_KEY`` and ``WGPEER_A_ALLOWEDIPS``. This may occur
+    # several times in a row for the same peer. It is then up to the receiver
+    # to coalesce adjacent peers. Likewise, it is possible that all peers will
+    # not fit within a single message. So, subsequent peers will be sent in
+    # following messages, except those will only contain ``WGDEVICE_A_IFNAME``
+    # and ``WGDEVICE_A_PEERS``. It is then up to the receiver to coalesce
+    # these messages to form the complete list of peers.
+    # 
+    # Since this is an ``NLA_F_DUMP`` command, the final message will always
+    # be ``NLMSG_DONE``, even if an error occurs. However, this ``NLMSG_DONE``
+    # message contains an integer error code. It is either zero or a negative
+    # error code corresponding to the errno.
+    # 
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
+    #--
+    # @rbs (?ifindex: ::Integer, ?ifname: ::String) -> ::Nl::Async::Stream[Messages::DumpGetDeviceReply]
+    def dump_get_device(**args)
+      @exchange.call(:"dump", Messages::DumpGetDeviceRequest, Messages::DumpGetDeviceReply, args)
+    end
+    # Set WireGuard device
+    # ~~~~~~~~~~~~~~~~~~~~
+    # 
+    # This command should be called with a wgdevice set, containing one but
+    # not both of ``WGDEVICE_A_IFINDEX`` and ``WGDEVICE_A_IFNAME``.
+    # 
+    # It is possible that the amount of configuration data exceeds that of the
+    # maximum message length accepted by the kernel. In that case, several
+    # messages should be sent one after another, with each successive one
+    # filling in information not contained in the prior. Note that if
+    # ``WGDEVICE_F_REPLACE_PEERS`` is specified in the first message, it
+    # probably should not be specified in fragments that come after, so that
+    # the list of peers is only cleared the first time but appended after.
+    # Likewise for peers, if ``WGPEER_F_REPLACE_ALLOWEDIPS`` is specified in
+    # the first message of a peer, it likely should not be specified in
+    # subsequent fragments.
+    # 
+    # If an error occurs, ``NLMSG_ERROR`` will reply containing an errno.
+    # 
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
+    #--
+    # @rbs (?ifindex: ::Integer, ?ifname: ::String, ?private_key: ::String, ?public_key: ::String, ?flags: ::Integer, ?listen_port: ::Integer, ?fwmark: ::Integer, ?peers: ::Array[AttributeSets::Wgpeer]) -> ::Nl::Async::Future[void]
+    def do_set_device(**args)
+      @exchange.call(:"do", Messages::DoSetDeviceRequest, nil, args)
+    end
+  end
+  # Returns the asynchronous operation facade for this family.
+  #--
+  # @rbs (?stream_capacity: ::Integer?) -> AsyncOperations
+  def async(stream_capacity: nil)
+    return @async_operations ||= build_async_facade(AsyncOperations) if stream_capacity.nil?
+    build_async_facade(AsyncOperations, stream_capacity:)
+  end
 end
 end; end

data/lib/nl/linux/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nl-linux
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Kasumi Hanazuki
@@ -15,35 +15,37 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: ynl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.4
-description: Linux Netlink client
+        version: 0.3.0
+description: nl-linux is a collection of Netlink clients for Linux kernel APIs, generated
+  from the kernel's YAML specifications (YNL).
 email:
 - kasumi@rollingapple.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
 - CHANGELOG.md
 - NLSPEC_VERSION
 - README.md
@@ -125,7 +127,7 @@ licenses:
 - "(GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause"
 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:
@@ -135,7 +137,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:
   - - ">="
@@ -144,5 +146,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.6
 specification_version: 4
-summary: Linux Netlink client
+summary: Clients for Linux kernel Netlink API
 test_files: []