nl-linux 0.3.0 → 0.4.1

data/sig/generated/nl/linux/wireguard.rbs

@@ -0,0 +1,1006 @@
+# Generated from generated/nl/linux/wireguard.rb with RBS::Inline
+
+module Nl
+  module Linux
+    # **Netlink protocol to control WireGuard network devices.**
+    #
+    # The below enums and macros are for interfacing with WireGuard, using generic
+    # netlink, with family ``WG_GENL_NAME`` and version ``WG_GENL_VERSION``. It
+    # defines two commands: get and set. Note that while they share many common
+    # 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::Genl::Family
+      NAME: ::String
+
+      VERSION: ::Integer
+
+      # @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::Genl::Client, ::String) -> ::Nl::Genl::FamilyInfo, ?executor: executor?, ?notification_capacity: ::Integer?) -> (::Nl::Family::Session & instance)
+
+      # @private
+      MCAST_GROUPS: Hash[::Symbol, ::Nl::McastGroup]
+
+      module Constants
+        WG_KEY_LEN: ::Integer
+      end
+
+      module Flags
+        module WgdeviceFlags
+          ReplacePeers: ::Integer
+        end
+
+        module WgpeerFlags
+          RemoveMe: ::Integer
+
+          ReplaceAllowedips: ::Integer
+
+          UpdateOnly: ::Integer
+        end
+
+        module WgallowedipFlags
+          RemoveMe: ::Integer
+        end
+      end
+
+      module Structs
+        class KernelTimespec < Struct[::Integer]
+          attr_accessor sec(): ::Integer
+
+          attr_accessor nsec(): ::Integer
+
+          def self.new: (?::Integer sec, ?::Integer nsec) -> instance
+                      | (?sec: ::Integer, ?nsec: ::Integer) -> instance
+        end
+
+        class KernelTimespec
+          # @!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: Hash[::Symbol, ::Nl::_DataType]
+
+          # Decodes the struct.
+          # @rbs decoder: ::Nl::Decoder
+          # @rbs return: instance
+          # @param [Nl::Decoder] decoder
+          # @return [self]
+          def self.decode: (::Nl::Decoder decoder) -> instance
+
+          # Encodes the struct.
+          # @rbs encoder: ::Nl::Encoder
+          # @rbs return: void
+          # @param [Nl::Encoder] encoder
+          # @return [void]
+          def encode: (::Nl::Encoder encoder) -> void
+        end
+      end
+
+      module AttributeSets
+        class Wgdevice < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          class Ifindex < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Ifname < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Set to all zeros to remove.
+          class PrivateKey < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class PublicKey < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          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: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Set as ``0`` to choose randomly.
+          class ListenPort < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Set as ``0`` to disable.
+          class Fwmark < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # The index/type parameter is unused on ``SET_DEVICE`` operations and is
+          # zero on ``GET_DEVICE`` operations.
+          class Peers < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+          end
+
+          # @private
+          BY_NAME: Hash[::Symbol, Attribute]
+
+          # @private
+          BY_TYPE: Hash[::Integer, Attribute]
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Ifindex
+          def ifindex: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see Ifname
+          def ifname: () -> ::String
+
+          # Set to all zeros to remove.
+          # @rbs return: ::String
+          # @return [String]
+          # @see PrivateKey
+          def private_key: () -> ::String
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see PublicKey
+          def public_key: () -> ::String
+
+          # ``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: () -> ::Integer
+
+          # Set as ``0`` to choose randomly.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see ListenPort
+          def listen_port: () -> ::Integer
+
+          # Set as ``0`` to disable.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Fwmark
+          def fwmark: () -> ::Integer
+
+          # 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: () -> ::Array[AttributeSets::Wgpeer]
+
+          # Looks up Attribute class by name.
+          # @rbs name: Symbol
+          # @rbs return: Attribute
+          # @param [Symbol] name
+          # @return [Attribute]
+          def self.by_name: (Symbol name) -> Attribute
+
+          # Looks up Attribute class by type value.
+          # @rbs type: Integer
+          # @rbs return: Attribute
+          # @param [Integer] type
+          # @return [Attribute]
+          def self.by_type: (Integer type) -> Attribute
+        end
+
+        class Wgpeer < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          class PublicKey < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Set as all zeros to remove.
+          class PresharedKey < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          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: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # struct sockaddr_in or struct sockaddr_in6
+          class Endpoint < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Set as ``0`` to disable.
+          class PersistentKeepaliveInterval < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class LastHandshakeTime < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class RxBytes < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class TxBytes < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # The index/type parameter is unused on ``SET_DEVICE`` operations and is
+          # zero on ``GET_DEVICE`` operations.
+          class Allowedips < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+          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: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # @private
+          BY_NAME: Hash[::Symbol, Attribute]
+
+          # @private
+          BY_TYPE: Hash[::Integer, Attribute]
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see PublicKey
+          def public_key: () -> ::String
+
+          # Set as all zeros to remove.
+          # @rbs return: ::String
+          # @return [String]
+          # @see PresharedKey
+          def preshared_key: () -> ::String
+
+          # ``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: () -> ::Integer
+
+          # struct sockaddr_in or struct sockaddr_in6
+          # @rbs return: ::String
+          # @return [String]
+          # @see Endpoint
+          def endpoint: () -> ::String
+
+          # Set as ``0`` to disable.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see PersistentKeepaliveInterval
+          def persistent_keepalive_interval: () -> ::Integer
+
+          # @rbs return: Structs::KernelTimespec
+          # @return [Structs::KernelTimespec]
+          # @see LastHandshakeTime
+          def last_handshake_time: () -> Structs::KernelTimespec
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see RxBytes
+          def rx_bytes: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see TxBytes
+          def tx_bytes: () -> ::Integer
+
+          # 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: () -> ::Array[AttributeSets::Wgallowedip]
+
+          # 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: () -> ::Integer
+
+          # Looks up Attribute class by name.
+          # @rbs name: Symbol
+          # @rbs return: Attribute
+          # @param [Symbol] name
+          # @return [Attribute]
+          def self.by_name: (Symbol name) -> Attribute
+
+          # Looks up Attribute class by type value.
+          # @rbs type: Integer
+          # @rbs return: Attribute
+          # @param [Integer] type
+          # @return [Attribute]
+          def self.by_type: (Integer type) -> Attribute
+        end
+
+        class Wgallowedip < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          # IP family, either ``AF_INET`` or ``AF_INET6``.
+          class Family < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Either ``struct in_addr`` or ``struct in6_addr``.
+          class Ipaddr < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class CidrMask < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          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: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # @private
+          BY_NAME: Hash[::Symbol, Attribute]
+
+          # @private
+          BY_TYPE: Hash[::Integer, Attribute]
+
+          # IP family, either ``AF_INET`` or ``AF_INET6``.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Family
+          def family: () -> ::Integer
+
+          # Either ``struct in_addr`` or ``struct in6_addr``.
+          # @rbs return: ::String
+          # @return [String]
+          # @see Ipaddr
+          def ipaddr: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see CidrMask
+          def cidr_mask: () -> ::Integer
+
+          # ``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: () -> ::Integer
+
+          # Looks up Attribute class by name.
+          # @rbs name: Symbol
+          # @rbs return: Attribute
+          # @param [Symbol] name
+          # @return [Attribute]
+          def self.by_name: (Symbol name) -> Attribute
+
+          # Looks up Attribute class by type value.
+          # @rbs type: Integer
+          # @rbs return: Attribute
+          # @param [Integer] type
+          # @return [Attribute]
+          def self.by_type: (Integer type) -> Attribute
+        end
+      end
+
+      module Messages
+        # 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.
+        class DumpGetDeviceRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Wgdevice::Ifindex
+          def ifindex: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Wgdevice::Ifname
+          def ifname: () -> ::String
+        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.
+        class DumpGetDeviceReply < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Wgdevice::Ifindex
+          def ifindex: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Wgdevice::Ifname
+          def ifname: () -> ::String
+
+          # Set to all zeros to remove.
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Wgdevice::PrivateKey
+          def private_key: () -> ::String
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Wgdevice::PublicKey
+          def public_key: () -> ::String
+
+          # ``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: () -> ::Integer
+
+          # Set as ``0`` to choose randomly.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Wgdevice::ListenPort
+          def listen_port: () -> ::Integer
+
+          # Set as ``0`` to disable.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Wgdevice::Fwmark
+          def fwmark: () -> ::Integer
+
+          # 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: () -> ::Array[AttributeSets::Wgpeer]
+        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.
+        class DoSetDeviceRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Wgdevice::Ifindex
+          def ifindex: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Wgdevice::Ifname
+          def ifname: () -> ::String
+
+          # Set to all zeros to remove.
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Wgdevice::PrivateKey
+          def private_key: () -> ::String
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Wgdevice::PublicKey
+          def public_key: () -> ::String
+
+          # ``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: () -> ::Integer
+
+          # Set as ``0`` to choose randomly.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Wgdevice::ListenPort
+          def listen_port: () -> ::Integer
+
+          # Set as ``0`` to disable.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Wgdevice::Fwmark
+          def fwmark: () -> ::Integer
+
+          # 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: () -> ::Array[AttributeSets::Wgpeer]
+        end
+      end
+
+      module Notifications
+      end
+
+      # @private
+      NOTIFICATIONS: Hash[::Integer, ::Class]
+
+      # 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) -> 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: (?ifindex: ::Integer, ?ifname: ::String) -> Array[Messages::DumpGetDeviceReply]
+                         | (?ifindex: ::Integer, ?ifname: ::String) { (Messages::DumpGetDeviceReply) -> void } -> void
+
+      # 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])]) -> 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: (?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
+
+      class AsyncOperations
+        # @private
+        def initialize: () ?{ (?) -> untyped } -> untyped
+
+        # 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: (?ifindex: ::Integer, ?ifname: ::String) -> ::Nl::Async::Stream[Messages::DumpGetDeviceReply]
+
+        # 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: (?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]
+      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: ::Integer?) -> AsyncOperations
+    end
+  end
+end