nl-linux 0.2.4 → 0.4.1

data/generated/nl/linux/wireguard.rb

@@ -1,7 +1,8 @@
 # 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
 # This code is generated by Ynl::Generator. DO NOT EDIT.
 require 'nl'
 module Nl; module Linux
@@ -13,207 +14,477 @@ module Nl; module Linux
 # attributes, these two commands actually accept a slightly different set of
 # inputs and outputs. These differences are noted under the individual
 # attributes.
-class Wireguard < ::Nl::Family
+class Wireguard < ::Nl::Genl::Family
   NAME = "wireguard"
-  PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Genl.new("wireguard"))
+  VERSION = 1
+  # @rbs (?resolver: ^(::Nl::Genl::Client, ::String) -> ::Nl::Genl::FamilyInfo, ?executor: executor?, ?notification_capacity: ::Integer?) -> (::Nl::Family::Session & instance)
+  # @rbs | [R] (?resolver: ^(::Nl::Genl::Client, ::String) -> ::Nl::Genl::FamilyInfo, ?executor: executor?, ?notification_capacity: ::Integer?) { (instance) -> R } -> R
+  # @overload open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY)
+  #   @param [#call] resolver
+  #   @param [Symbol, nil] executor
+  #   @param [Integer, nil] notification_capacity
+  #   @return [Wireguard]
+  # @overload open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY, &block)
+  #   @param [#call] resolver
+  #   @param [Symbol, nil] executor
+  #   @param [Integer, nil] notification_capacity
+  #   @yieldparam [Wireguard] family
+  #   @return [Object] the result of the block
+  def self.open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY)
+    super
+  end
+  # @private
+  MCAST_GROUPS = Ractor.make_shareable({}) #: Hash[::Symbol, ::Nl::McastGroup]
+  module Constants
+    WG_KEY_LEN = 32
+  end
+  module Flags
+    module WgdeviceFlags
+      ReplacePeers = 1
+    end
+    module WgpeerFlags
+      RemoveMe = 1
+      ReplaceAllowedips = 2
+      UpdateOnly = 4
+    end
+    module WgallowedipFlags
+      RemoveMe = 1
+    end
+  end
   module Structs
     KernelTimespec = Struct.new(
       :"sec", #: ::Integer
       :"nsec", #: ::Integer
     )
     class KernelTimespec
-      # :nodoc:
-      MEMBERS = Ractor.make_shareable({sec: ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil), nsec: ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)}) #: Hash[::Symbol, ::Nl::_DataType]
+      # @!attribute [rw] sec
+      #   Number of seconds, since UNIX epoch.
+      #   @return [Integer]
+      # @!attribute [rw] nsec
+      #   Number of nanoseconds, after the second began.
+      #   @return [Integer]
+      # @private
+      MEMBERS = Ractor.make_shareable({sec: ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil), nsec: ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)}) #: Hash[::Symbol, ::Nl::_DataType]
       # Decodes the struct.
-      #--
       # @rbs decoder: ::Nl::Decoder
       # @rbs return: instance
+      # @param [Nl::Decoder] decoder
+      # @return [self]
       def self.decode(decoder)
         self.new(*MEMBERS.map {|name, datatype| datatype.decode(decoder) })
       end
       # Encodes the struct.
-      #--
       # @rbs encoder: ::Nl::Encoder
       # @rbs return: void
+      # @param [Nl::Encoder] encoder
+      # @return [void]
       def encode(encoder)
         MEMBERS.each {|name, datatype| datatype.encode(encoder, self.public_send(name)) }
       end
     end
   end
   module AttributeSets
-    class Wgdevice < ::Nl::Protocols::Genl::AttributeSet
+    class Wgdevice < ::Nl::AttributeSet
       # Abstract class
-      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      class Attribute < ::Nl::AttributeSet::Attribute
       end
       class Ifindex < Attribute
         TYPE = 1
         NAME = :"ifindex"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 0
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
       class Ifname < Attribute
         TYPE = 2
         NAME = :"ifname"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::String.new(check: -> { raise ArgumentError, "Value #{it.inspect} is longer than maximum length 15" unless it.bytesize <= 15 })
+        # @private
+        ORDER = 1
+        # @private
+        DATATYPE = ::Nl::DataTypes::String.new(check: -> { raise ArgumentError, "Value #{it.inspect} is longer than maximum length 15" unless it.bytesize <= 15 })
       end
+      # Set to all zeros to remove.
       class PrivateKey < Attribute
         TYPE = 3
         NAME = :"private_key"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Binary.new(check: -> { raise ArgumentError, "Value #{it.inspect} is not equal to length 32" unless it.bytesize == 32 })
+        # @private
+        ORDER = 2
+        # @private
+        DATATYPE = ::Nl::DataTypes::Binary.new(check: -> { raise ArgumentError, "Value #{it.inspect} is not equal to length #{Constants::WG_KEY_LEN}" unless it.bytesize == Constants::WG_KEY_LEN })
       end
       class PublicKey < Attribute
         TYPE = 4
         NAME = :"public_key"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Binary.new(check: -> { raise ArgumentError, "Value #{it.inspect} is not equal to length 32" unless it.bytesize == 32 })
+        # @private
+        ORDER = 3
+        # @private
+        DATATYPE = ::Nl::DataTypes::Binary.new(check: -> { raise ArgumentError, "Value #{it.inspect} is not equal to length #{Constants::WG_KEY_LEN}" unless it.bytesize == Constants::WG_KEY_LEN })
       end
+      # ``0`` or ``WGDEVICE_F_REPLACE_PEERS`` if all current peers should be
+      # removed prior to adding the list below.
+      # 
+      # 
+      # Known flags are defined in {Flags::WgdeviceFlags}.
       class Flags < Attribute
         TYPE = 5
         NAME = :"flags"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 4
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
+      # Set as ``0`` to choose randomly.
       class ListenPort < Attribute
         TYPE = 6
         NAME = :"listen_port"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U16, check: nil)
+        # @private
+        ORDER = 5
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U16, check: nil)
       end
+      # Set as ``0`` to disable.
       class Fwmark < Attribute
         TYPE = 7
         NAME = :"fwmark"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 6
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
+      # The index/type parameter is unused on ``SET_DEVICE`` operations and is
+      # zero on ``GET_DEVICE`` operations.
       class Peers < Attribute
         TYPE = 8
         NAME = :"peers"
+        # @private
+        ORDER = 7
       end
-      # :nodoc:
+      # @private
       BY_NAME = Ractor.make_shareable({:"ifindex" => Ifindex, :"ifname" => Ifname, :"private_key" => PrivateKey, :"public_key" => PublicKey, :"flags" => Flags, :"listen_port" => ListenPort, :"fwmark" => Fwmark, :"peers" => Peers}) #: Hash[::Symbol, Attribute]
-      # :nodoc:
+      # @private
       BY_TYPE = Ractor.make_shareable({1 => Ifindex, 2 => Ifname, 3 => PrivateKey, 4 => PublicKey, 5 => Flags, 6 => ListenPort, 7 => Fwmark, 8 => Peers}) #: Hash[::Integer, Attribute]
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Ifindex
+      def ifindex; self[:"ifindex"]&.value; end
+      # @rbs return: ::String
+      # @return [String]
+      # @see Ifname
+      def ifname; self[:"ifname"]&.value; end
+      # Set to all zeros to remove.
+      # @rbs return: ::String
+      # @return [String]
+      # @see PrivateKey
+      def private_key; self[:"private_key"]&.value; end
+      # @rbs return: ::String
+      # @return [String]
+      # @see PublicKey
+      def public_key; self[:"public_key"]&.value; end
+      # ``0`` or ``WGDEVICE_F_REPLACE_PEERS`` if all current peers should be
+      # removed prior to adding the list below.
+      # 
+      # 
+      # Known flags are defined in {Flags::WgdeviceFlags}.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Flags
+      def flags; self[:"flags"]&.value; end
+      # Set as ``0`` to choose randomly.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see ListenPort
+      def listen_port; self[:"listen_port"]&.value; end
+      # Set as ``0`` to disable.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Fwmark
+      def fwmark; self[:"fwmark"]&.value; end
+      # The index/type parameter is unused on ``SET_DEVICE`` operations and is
+      # zero on ``GET_DEVICE`` operations.
+      # @rbs return: ::Array[AttributeSets::Wgpeer]
+      # @return [Array<AttributeSets::Wgpeer>]
+      # @see Peers
+      def peers; self[:"peers"]&.value; end
       class << self
         # Looks up Attribute class by name.
-        #--
         # @rbs name: Symbol
         # @rbs return: Attribute
+        # @param [Symbol] name
+        # @return [Attribute]
         def by_name(name); BY_NAME.fetch(name); end
         # Looks up Attribute class by type value.
-        #--
         # @rbs type: Integer
         # @rbs return: Attribute
+        # @param [Integer] type
+        # @return [Attribute]
         def by_type(type); BY_TYPE.fetch(type); end
       end
     end
-    class Wgpeer < ::Nl::Protocols::Genl::AttributeSet
+    class Wgpeer < ::Nl::AttributeSet
       # Abstract class
-      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      class Attribute < ::Nl::AttributeSet::Attribute
       end
       class PublicKey < Attribute
         TYPE = 1
         NAME = :"public_key"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Binary.new(check: -> { raise ArgumentError, "Value #{it.inspect} is not equal to length 32" unless it.bytesize == 32 })
+        # @private
+        ORDER = 0
+        # @private
+        DATATYPE = ::Nl::DataTypes::Binary.new(check: -> { raise ArgumentError, "Value #{it.inspect} is not equal to length #{Constants::WG_KEY_LEN}" unless it.bytesize == Constants::WG_KEY_LEN })
       end
+      # Set as all zeros to remove.
       class PresharedKey < Attribute
         TYPE = 2
         NAME = :"preshared_key"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Binary.new(check: -> { raise ArgumentError, "Value #{it.inspect} is not equal to length 32" unless it.bytesize == 32 })
+        # @private
+        ORDER = 1
+        # @private
+        DATATYPE = ::Nl::DataTypes::Binary.new(check: -> { raise ArgumentError, "Value #{it.inspect} is not equal to length #{Constants::WG_KEY_LEN}" unless it.bytesize == Constants::WG_KEY_LEN })
       end
+      # ``0`` and/or ``WGPEER_F_REMOVE_ME`` if the specified peer should not
+      # exist at the end of the operation, rather than added/updated and/or
+      # ``WGPEER_F_REPLACE_ALLOWEDIPS`` if all current allowed IPs of this
+      # peer should be removed prior to adding the list below and/or
+      # ``WGPEER_F_UPDATE_ONLY`` if the peer should only be set if it already
+      # exists.
+      # 
+      # 
+      # Known flags are defined in {Flags::WgpeerFlags}.
       class Flags < Attribute
         TYPE = 3
         NAME = :"flags"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 2
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
+      # struct sockaddr_in or struct sockaddr_in6
       class Endpoint < Attribute
         TYPE = 4
         NAME = :"endpoint"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Binary.new(check: -> { raise ArgumentError, "Value #{it.inspect} is shorter than minimum length 16" unless it.bytesize >= 16 })
+        # @private
+        ORDER = 3
+        # @private
+        DATATYPE = ::Nl::DataTypes::Binary.new(check: -> { raise ArgumentError, "Value #{it.inspect} is shorter than minimum length 16" unless it.bytesize >= 16 })
       end
+      # Set as ``0`` to disable.
       class PersistentKeepaliveInterval < Attribute
         TYPE = 5
         NAME = :"persistent_keepalive_interval"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U16, check: nil)
+        # @private
+        ORDER = 4
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U16, check: nil)
       end
       class LastHandshakeTime < Attribute
         TYPE = 6
         NAME = :"last_handshake_time"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Binary.new(check: -> { raise ArgumentError, "Value #{it.inspect} is not equal to length 16" unless it.bytesize == 16 })
+        # @private
+        ORDER = 5
+        # @private
+        DATATYPE = ::Nl::DataTypes::Struct.new(Structs::KernelTimespec, check: -> { raise ArgumentError, "Value #{it.inspect} is not equal to length 16" unless it.bytesize == 16 }, consume_remaining: true)
       end
       class RxBytes < Attribute
         TYPE = 7
         NAME = :"rx_bytes"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
+        # @private
+        ORDER = 6
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
       end
       class TxBytes < Attribute
         TYPE = 8
         NAME = :"tx_bytes"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
+        # @private
+        ORDER = 7
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
       end
+      # The index/type parameter is unused on ``SET_DEVICE`` operations and is
+      # zero on ``GET_DEVICE`` operations.
       class Allowedips < Attribute
         TYPE = 9
         NAME = :"allowedips"
+        # @private
+        ORDER = 8
       end
+      # Should not be set or used at all by most users of this API, as the
+      # most recent protocol will be used when this is unset. Otherwise,
+      # must be set to ``1``.
       class ProtocolVersion < Attribute
         TYPE = 10
         NAME = :"protocol_version"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 9
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
-      # :nodoc:
+      # @private
       BY_NAME = Ractor.make_shareable({:"public_key" => PublicKey, :"preshared_key" => PresharedKey, :"flags" => Flags, :"endpoint" => Endpoint, :"persistent_keepalive_interval" => PersistentKeepaliveInterval, :"last_handshake_time" => LastHandshakeTime, :"rx_bytes" => RxBytes, :"tx_bytes" => TxBytes, :"allowedips" => Allowedips, :"protocol_version" => ProtocolVersion}) #: Hash[::Symbol, Attribute]
-      # :nodoc:
+      # @private
       BY_TYPE = Ractor.make_shareable({1 => PublicKey, 2 => PresharedKey, 3 => Flags, 4 => Endpoint, 5 => PersistentKeepaliveInterval, 6 => LastHandshakeTime, 7 => RxBytes, 8 => TxBytes, 9 => Allowedips, 10 => ProtocolVersion}) #: Hash[::Integer, Attribute]
+      # @rbs return: ::String
+      # @return [String]
+      # @see PublicKey
+      def public_key; self[:"public_key"]&.value; end
+      # Set as all zeros to remove.
+      # @rbs return: ::String
+      # @return [String]
+      # @see PresharedKey
+      def preshared_key; self[:"preshared_key"]&.value; end
+      # ``0`` and/or ``WGPEER_F_REMOVE_ME`` if the specified peer should not
+      # exist at the end of the operation, rather than added/updated and/or
+      # ``WGPEER_F_REPLACE_ALLOWEDIPS`` if all current allowed IPs of this
+      # peer should be removed prior to adding the list below and/or
+      # ``WGPEER_F_UPDATE_ONLY`` if the peer should only be set if it already
+      # exists.
+      # 
+      # 
+      # Known flags are defined in {Flags::WgpeerFlags}.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Flags
+      def flags; self[:"flags"]&.value; end
+      # struct sockaddr_in or struct sockaddr_in6
+      # @rbs return: ::String
+      # @return [String]
+      # @see Endpoint
+      def endpoint; self[:"endpoint"]&.value; end
+      # Set as ``0`` to disable.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see PersistentKeepaliveInterval
+      def persistent_keepalive_interval; self[:"persistent_keepalive_interval"]&.value; end
+      # @rbs return: Structs::KernelTimespec
+      # @return [Structs::KernelTimespec]
+      # @see LastHandshakeTime
+      def last_handshake_time; self[:"last_handshake_time"]&.value; end
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see RxBytes
+      def rx_bytes; self[:"rx_bytes"]&.value; end
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see TxBytes
+      def tx_bytes; self[:"tx_bytes"]&.value; end
+      # The index/type parameter is unused on ``SET_DEVICE`` operations and is
+      # zero on ``GET_DEVICE`` operations.
+      # @rbs return: ::Array[AttributeSets::Wgallowedip]
+      # @return [Array<AttributeSets::Wgallowedip>]
+      # @see Allowedips
+      def allowedips; self[:"allowedips"]&.value; end
+      # Should not be set or used at all by most users of this API, as the
+      # most recent protocol will be used when this is unset. Otherwise,
+      # must be set to ``1``.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see ProtocolVersion
+      def protocol_version; self[:"protocol_version"]&.value; end
       class << self
         # Looks up Attribute class by name.
-        #--
         # @rbs name: Symbol
         # @rbs return: Attribute
+        # @param [Symbol] name
+        # @return [Attribute]
         def by_name(name); BY_NAME.fetch(name); end
         # Looks up Attribute class by type value.
-        #--
         # @rbs type: Integer
         # @rbs return: Attribute
+        # @param [Integer] type
+        # @return [Attribute]
         def by_type(type); BY_TYPE.fetch(type); end
       end
     end
-    class Wgallowedip < ::Nl::Protocols::Genl::AttributeSet
+    class Wgallowedip < ::Nl::AttributeSet
       # Abstract class
-      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      class Attribute < ::Nl::AttributeSet::Attribute
       end
+      # IP family, either ``AF_INET`` or ``AF_INET6``.
       class Family < Attribute
         TYPE = 1
         NAME = :"family"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U16, check: nil)
+        # @private
+        ORDER = 0
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U16, check: nil)
       end
+      # Either ``struct in_addr`` or ``struct in6_addr``.
       class Ipaddr < Attribute
         TYPE = 2
         NAME = :"ipaddr"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Binary.new(check: -> { raise ArgumentError, "Value #{it.inspect} is shorter than minimum length 4" unless it.bytesize >= 4 })
+        # @private
+        ORDER = 1
+        # @private
+        DATATYPE = ::Nl::DataTypes::Binary.new(check: -> { raise ArgumentError, "Value #{it.inspect} is shorter than minimum length 4" unless it.bytesize >= 4 })
       end
       class CidrMask < Attribute
         TYPE = 3
         NAME = :"cidr_mask"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U8, check: nil)
+        # @private
+        ORDER = 2
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U8, check: nil)
       end
+      # ``WGALLOWEDIP_F_REMOVE_ME`` if the specified IP should be removed;
+      # otherwise, this IP will be added if it is not already present.
+      # 
+      # 
+      # Known flags are defined in {Flags::WgallowedipFlags}.
       class Flags < Attribute
         TYPE = 4
         NAME = :"flags"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 3
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
-      # :nodoc:
+      # @private
       BY_NAME = Ractor.make_shareable({:"family" => Family, :"ipaddr" => Ipaddr, :"cidr_mask" => CidrMask, :"flags" => Flags}) #: Hash[::Symbol, Attribute]
-      # :nodoc:
+      # @private
       BY_TYPE = Ractor.make_shareable({1 => Family, 2 => Ipaddr, 3 => CidrMask, 4 => Flags}) #: Hash[::Integer, Attribute]
+      # IP family, either ``AF_INET`` or ``AF_INET6``.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Family
+      def family; self[:"family"]&.value; end
+      # Either ``struct in_addr`` or ``struct in6_addr``.
+      # @rbs return: ::String
+      # @return [String]
+      # @see Ipaddr
+      def ipaddr; self[:"ipaddr"]&.value; end
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see CidrMask
+      def cidr_mask; self[:"cidr_mask"]&.value; end
+      # ``WGALLOWEDIP_F_REMOVE_ME`` if the specified IP should be removed;
+      # otherwise, this IP will be added if it is not already present.
+      # 
+      # 
+      # Known flags are defined in {Flags::WgallowedipFlags}.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Flags
+      def flags; self[:"flags"]&.value; end
       class << self
         # Looks up Attribute class by name.
-        #--
         # @rbs name: Symbol
         # @rbs return: Attribute
+        # @param [Symbol] name
+        # @return [Attribute]
         def by_name(name); BY_NAME.fetch(name); end
         # Looks up Attribute class by type value.
-        #--
         # @rbs type: Integer
         # @rbs return: Attribute
+        # @param [Integer] type
+        # @return [Attribute]
         def by_type(type); BY_TYPE.fetch(type); end
       end
     end
-    Wgdevice::Peers::DATATYPE = ::Nl::Protocols::Genl::DataTypes::IndexedArray.new(::Nl::Protocols::Genl::DataTypes::NestedAttributes.new(Wgpeer))
-    Wgpeer::Allowedips::DATATYPE = ::Nl::Protocols::Genl::DataTypes::IndexedArray.new(::Nl::Protocols::Genl::DataTypes::NestedAttributes.new(Wgallowedip))
+    # @private
+    Wgdevice::Peers::DATATYPE = ::Nl::DataTypes::IndexedArray.new(::Nl::DataTypes::NestedAttributes.new(AttributeSets::Wgpeer, selector_bindings: Ractor.make_shareable([])))
+    # @private
+    Wgpeer::Allowedips::DATATYPE = ::Nl::DataTypes::IndexedArray.new(::Nl::DataTypes::NestedAttributes.new(AttributeSets::Wgallowedip, selector_bindings: Ractor.make_shareable([])))
   end
   module Messages
     # Retrieve WireGuard device
@@ -240,18 +511,21 @@ 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.
-    class DumpGetDeviceRequest < ::Nl::Protocols::Genl::Message
+    # 
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
+    class DumpGetDeviceRequest < ::Nl::Genl::Message
       TYPE = 0
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::Wgdevice
       ATTRIBUTES = Ractor.make_shareable(%i[ifindex ifname])
-      # Gets the value of `ifindex` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Wgdevice::Ifindex
       def ifindex; attributes[:"ifindex"]&.value; end
-      # Gets the value of `ifname` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Wgdevice::Ifname
       def ifname; attributes[:"ifname"]&.value; end
     end
     # Retrieve WireGuard device
@@ -278,42 +552,55 @@ 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.
-    class DumpGetDeviceReply < ::Nl::Protocols::Genl::Message
+    # 
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
+    class DumpGetDeviceReply < ::Nl::Genl::Message
       TYPE = 0
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::Wgdevice
       ATTRIBUTES = Ractor.make_shareable(%i[ifindex ifname private_key public_key flags listen_port fwmark peers])
-      # Gets the value of `ifindex` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Wgdevice::Ifindex
       def ifindex; attributes[:"ifindex"]&.value; end
-      # Gets the value of `ifname` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Wgdevice::Ifname
       def ifname; attributes[:"ifname"]&.value; end
-      # Gets the value of `private-key` attribute in the message.
-      #--
-      # @rbs return: untyped
+      # Set to all zeros to remove.
+      # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Wgdevice::PrivateKey
       def private_key; attributes[:"private_key"]&.value; end
-      # Gets the value of `public-key` attribute in the message.
-      #--
-      # @rbs return: untyped
+      # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Wgdevice::PublicKey
       def public_key; attributes[:"public_key"]&.value; end
-      # Gets the value of `flags` attribute in the message.
-      #--
+      # ``0`` or ``WGDEVICE_F_REPLACE_PEERS`` if all current peers should be
+      # removed prior to adding the list below.
+      # 
+      # 
+      # Known flags are defined in {Flags::WgdeviceFlags}.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Wgdevice::Flags
       def flags; attributes[:"flags"]&.value; end
-      # Gets the value of `listen-port` attribute in the message.
-      #--
+      # Set as ``0`` to choose randomly.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Wgdevice::ListenPort
       def listen_port; attributes[:"listen_port"]&.value; end
-      # Gets the value of `fwmark` attribute in the message.
-      #--
+      # Set as ``0`` to disable.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Wgdevice::Fwmark
       def fwmark; attributes[:"fwmark"]&.value; end
-      # Gets the value of `peers` attribute in the message.
-      #--
-      # @rbs return: untyped
+      # The index/type parameter is unused on ``SET_DEVICE`` operations and is
+      # zero on ``GET_DEVICE`` operations.
+      # @rbs return: ::Array[AttributeSets::Wgpeer]
+      # @return [Array<AttributeSets::Wgpeer>]
+      # @see AttributeSets::Wgdevice::Peers
       def peers; attributes[:"peers"]&.value; end
     end
     # Set WireGuard device
@@ -334,45 +621,62 @@ class Wireguard < ::Nl::Family
     # subsequent fragments.
     # 
     # If an error occurs, ``NLMSG_ERROR`` will reply containing an errno.
-    class DoSetDeviceRequest < ::Nl::Protocols::Genl::Message
+    # 
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
+    class DoSetDeviceRequest < ::Nl::Genl::Message
       TYPE = 1
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::Wgdevice
       ATTRIBUTES = Ractor.make_shareable(%i[ifindex ifname private_key public_key flags listen_port fwmark peers])
-      # Gets the value of `ifindex` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Wgdevice::Ifindex
       def ifindex; attributes[:"ifindex"]&.value; end
-      # Gets the value of `ifname` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Wgdevice::Ifname
       def ifname; attributes[:"ifname"]&.value; end
-      # Gets the value of `private-key` attribute in the message.
-      #--
-      # @rbs return: untyped
+      # Set to all zeros to remove.
+      # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Wgdevice::PrivateKey
       def private_key; attributes[:"private_key"]&.value; end
-      # Gets the value of `public-key` attribute in the message.
-      #--
-      # @rbs return: untyped
+      # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Wgdevice::PublicKey
       def public_key; attributes[:"public_key"]&.value; end
-      # Gets the value of `flags` attribute in the message.
-      #--
+      # ``0`` or ``WGDEVICE_F_REPLACE_PEERS`` if all current peers should be
+      # removed prior to adding the list below.
+      # 
+      # 
+      # Known flags are defined in {Flags::WgdeviceFlags}.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Wgdevice::Flags
       def flags; attributes[:"flags"]&.value; end
-      # Gets the value of `listen-port` attribute in the message.
-      #--
+      # Set as ``0`` to choose randomly.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Wgdevice::ListenPort
       def listen_port; attributes[:"listen_port"]&.value; end
-      # Gets the value of `fwmark` attribute in the message.
-      #--
+      # Set as ``0`` to disable.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Wgdevice::Fwmark
       def fwmark; attributes[:"fwmark"]&.value; end
-      # Gets the value of `peers` attribute in the message.
-      #--
-      # @rbs return: untyped
+      # The index/type parameter is unused on ``SET_DEVICE`` operations and is
+      # zero on ``GET_DEVICE`` operations.
+      # @rbs return: ::Array[AttributeSets::Wgpeer]
+      # @return [Array<AttributeSets::Wgpeer>]
+      # @see AttributeSets::Wgdevice::Peers
       def peers; attributes[:"peers"]&.value; end
     end
   end
+  module Notifications
+  end
+  # @private
+  NOTIFICATIONS = Ractor.make_shareable({}) #: Hash[::Integer, ::Class]
   # Retrieve WireGuard device
   # ~~~~~~~~~~~~~~~~~~~~~~~~~
   # 
@@ -397,9 +701,25 @@ 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.
-  #--
-  # @rbs (?ifindex: ::Integer, ?ifname: ::String) -> Enumerable[Messages::DumpGetDeviceReply]
+  # 
+  # 
+  # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
+  # @rbs (?ifindex: ::Integer, ?ifname: ::String) -> Array[Messages::DumpGetDeviceReply]
   #   | (?ifindex: ::Integer, ?ifname: ::String) { (Messages::DumpGetDeviceReply) -> void } -> void
+  # @overload dump_get_device(**args)
+  #   Returns an array when no block is given.
+  #   @param [Hash] args
+  #   @option args [Integer] ifindex
+  #   @option args [String] ifname
+  #   @return [Array<Messages::DumpGetDeviceReply>]
+  # @overload dump_get_device(**args, &block)
+  #   Yields each reply when a block is given.
+  #   @param [Hash] args
+  #   @option args [Integer] ifindex
+  #   @option args [String] ifname
+  #   @yieldparam [Messages::DumpGetDeviceReply] reply
+  #   @return [void]
+  # @see Messages::DumpGetDeviceRequest
   def dump_get_device(**args, &block)
     exchange_message(:"dump", Messages::DumpGetDeviceRequest, Messages::DumpGetDeviceReply, args, &block)
   end
@@ -421,10 +741,119 @@ class Wireguard < ::Nl::Family
   # subsequent fragments.
   # 
   # If an error occurs, ``NLMSG_ERROR`` will reply containing an errno.
-  #--
-  # @rbs (?ifindex: ::Integer, ?ifname: ::String, ?private_key: untyped, ?public_key: untyped, ?flags: ::Integer, ?listen_port: ::Integer, ?fwmark: ::Integer, ?peers: untyped) -> void
+  # 
+  # 
+  # 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 | ::Hash[::Symbol, untyped])]) -> void
+  # @param [Hash] args
+  # @option args [Integer] ifindex
+  # @option args [String] ifname
+  # @option args [String] private_key Set to all zeros to remove.
+  # @option args [String] public_key
+  # @option args [Integer] flags ``0`` or ``WGDEVICE_F_REPLACE_PEERS`` if all current peers should be
+  #   removed prior to adding the list below.
+  #   
+  #   
+  #   Known flags are defined in {Flags::WgdeviceFlags}.
+  # @option args [Integer] listen_port Set as ``0`` to choose randomly.
+  # @option args [Integer] fwmark Set as ``0`` to disable.
+  # @option args [Array<AttributeSets::Wgpeer, Hash<Symbol, Object>>] peers The index/type parameter is unused on ``SET_DEVICE`` operations and is
+  #   zero on ``GET_DEVICE`` operations.
+  # @return [void]
+  # @see Messages::DoSetDeviceRequest
   def do_set_device(**args)
     exchange_message(:"do", Messages::DoSetDeviceRequest, nil, args)
   end
+  class AsyncOperations
+    # @private
+    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]
+    # @param [Hash] args
+    # @option args [Integer] ifindex
+    # @option args [String] ifname
+    # @return [Nl::Async::Stream<Messages::DumpGetDeviceReply>]
+    # @see Messages::DumpGetDeviceRequest
+    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 | ::Hash[::Symbol, untyped])]) -> ::Nl::Async::Future[void]
+    # @param [Hash] args
+    # @option args [Integer] ifindex
+    # @option args [String] ifname
+    # @option args [String] private_key Set to all zeros to remove.
+    # @option args [String] public_key
+    # @option args [Integer] flags ``0`` or ``WGDEVICE_F_REPLACE_PEERS`` if all current peers should be
+    #   removed prior to adding the list below.
+    #   
+    #   
+    #   Known flags are defined in {Flags::WgdeviceFlags}.
+    # @option args [Integer] listen_port Set as ``0`` to choose randomly.
+    # @option args [Integer] fwmark Set as ``0`` to disable.
+    # @option args [Array<AttributeSets::Wgpeer, Hash<Symbol, Object>>] peers The index/type parameter is unused on ``SET_DEVICE`` operations and is
+    #   zero on ``GET_DEVICE`` operations.
+    # @return [Nl::Async::Future<void>]
+    # @see Messages::DoSetDeviceRequest
+    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
+  # @param [::Integer, nil] stream_capacity
+  # @return [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