nl-linux 0.3.0 → 0.4.1

data/generated/nl/linux/fou.rb

@@ -3,91 +3,193 @@
 # This file is based on Documentation/netlink/specs/fou.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
 # Foo-over-UDP.
-class Fou < ::Nl::Family
+class Fou < ::Nl::Genl::Family
   NAME = "fou"
-  PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Genl.new("fou"))
+  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 [Fou]
+  # @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 [Fou] 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 Enums
+    module EncapType
+      Unspec = 0
+      Direct = 1
+      Gue = 2
+    end
+  end
   module Structs
   end
   module AttributeSets
-    class Fou < ::Nl::Protocols::Genl::AttributeSet
+    class Fou < ::Nl::AttributeSet
       # Abstract class
-      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      class Attribute < ::Nl::AttributeSet::Attribute
       end
       class Port < Attribute
         TYPE = 1
         NAME = :"port"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Big::U16, check: nil)
+        # @private
+        ORDER = 0
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Big::U16, check: nil)
       end
       class Af < Attribute
         TYPE = 2
         NAME = :"af"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U8, check: nil)
+        # @private
+        ORDER = 1
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U8, check: nil)
       end
       class Ipproto < Attribute
         TYPE = 3
         NAME = :"ipproto"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U8, check: -> { raise ArgumentError, "Value #{it.inspect} is less than minimum 1" unless it >= 1 })
+        # @private
+        ORDER = 2
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U8, check: -> { raise ArgumentError, "Value #{it.inspect} is less than minimum 1" unless it >= 1 })
       end
       class Type < Attribute
         TYPE = 4
         NAME = :"type"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U8, check: nil)
+        # @private
+        ORDER = 3
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U8, check: nil)
       end
       class RemcsumNopartial < Attribute
         TYPE = 5
         NAME = :"remcsum_nopartial"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Flag.new
+        # @private
+        ORDER = 4
+        # @private
+        DATATYPE = ::Nl::DataTypes::Flag.new
       end
       class LocalV4 < Attribute
         TYPE = 6
         NAME = :"local_v4"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 5
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
       class LocalV6 < Attribute
         TYPE = 7
         NAME = :"local_v6"
-        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 = 6
+        # @private
+        DATATYPE = ::Nl::DataTypes::Binary.new(check: -> { raise ArgumentError, "Value #{it.inspect} is not equal to length 16" unless it.bytesize == 16 })
       end
       class PeerV4 < Attribute
         TYPE = 8
         NAME = :"peer_v4"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 7
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
       class PeerV6 < Attribute
         TYPE = 9
         NAME = :"peer_v6"
-        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 = 8
+        # @private
+        DATATYPE = ::Nl::DataTypes::Binary.new(check: -> { raise ArgumentError, "Value #{it.inspect} is not equal to length 16" unless it.bytesize == 16 })
       end
       class PeerPort < Attribute
         TYPE = 10
         NAME = :"peer_port"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Big::U16, check: nil)
+        # @private
+        ORDER = 9
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Big::U16, check: nil)
       end
       class Ifindex < Attribute
         TYPE = 11
         NAME = :"ifindex"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::S32, check: nil)
+        # @private
+        ORDER = 10
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::S32, check: nil)
       end
-      # :nodoc:
+      # @private
       BY_NAME = Ractor.make_shareable({:"port" => Port, :"af" => Af, :"ipproto" => Ipproto, :"type" => Type, :"remcsum_nopartial" => RemcsumNopartial, :"local_v4" => LocalV4, :"local_v6" => LocalV6, :"peer_v4" => PeerV4, :"peer_v6" => PeerV6, :"peer_port" => PeerPort, :"ifindex" => Ifindex}) #: Hash[::Symbol, Attribute]
-      # :nodoc:
+      # @private
       BY_TYPE = Ractor.make_shareable({1 => Port, 2 => Af, 3 => Ipproto, 4 => Type, 5 => RemcsumNopartial, 6 => LocalV4, 7 => LocalV6, 8 => PeerV4, 9 => PeerV6, 10 => PeerPort, 11 => Ifindex}) #: Hash[::Integer, Attribute]
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Port
+      def port; self[:"port"]&.value; end
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Af
+      def af; self[:"af"]&.value; end
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Ipproto
+      def ipproto; self[:"ipproto"]&.value; end
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Type
+      def type; self[:"type"]&.value; end
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see RemcsumNopartial
+      def remcsum_nopartial; self[:"remcsum_nopartial"]&.value; end
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see LocalV4
+      def local_v4; self[:"local_v4"]&.value; end
+      # @rbs return: ::String
+      # @return [String]
+      # @see LocalV6
+      def local_v6; self[:"local_v6"]&.value; end
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see PeerV4
+      def peer_v4; self[:"peer_v4"]&.value; end
+      # @rbs return: ::String
+      # @return [String]
+      # @see PeerV6
+      def peer_v6; self[:"peer_v6"]&.value; end
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see PeerPort
+      def peer_port; self[:"peer_port"]&.value; end
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Ifindex
+      def ifindex; self[:"ifindex"]&.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
@@ -96,303 +198,380 @@ class Fou < ::Nl::Family
     # Add port.
     # 
     # Requires CAP_NET_ADMIN in the initial user namespace.
-    class DoAddRequest < ::Nl::Protocols::Genl::Message
+    class DoAddRequest < ::Nl::Genl::Message
       TYPE = 1
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::Fou
       ATTRIBUTES = Ractor.make_shareable(%i[port ipproto type remcsum_nopartial local_v4 local_v6 peer_v4 peer_v6 peer_port ifindex])
-      # Gets the value of `port` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::Port
       def port; attributes[:"port"]&.value; end
-      # Gets the value of `ipproto` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::Ipproto
       def ipproto; attributes[:"ipproto"]&.value; end
-      # Gets the value of `type` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::Type
       def type; attributes[:"type"]&.value; end
-      # Gets the value of `remcsum-nopartial` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::RemcsumNopartial
       def remcsum_nopartial; attributes[:"remcsum_nopartial"]&.value; end
-      # Gets the value of `local-v4` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::LocalV4
       def local_v4; attributes[:"local_v4"]&.value; end
-      # Gets the value of `local-v6` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Fou::LocalV6
       def local_v6; attributes[:"local_v6"]&.value; end
-      # Gets the value of `peer-v4` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::PeerV4
       def peer_v4; attributes[:"peer_v4"]&.value; end
-      # Gets the value of `peer-v6` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Fou::PeerV6
       def peer_v6; attributes[:"peer_v6"]&.value; end
-      # Gets the value of `peer-port` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::PeerPort
       def peer_port; attributes[:"peer_port"]&.value; end
-      # Gets the value of `ifindex` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::Ifindex
       def ifindex; attributes[:"ifindex"]&.value; end
     end
     # Delete port.
     # 
     # Requires CAP_NET_ADMIN in the initial user namespace.
-    class DoDelRequest < ::Nl::Protocols::Genl::Message
+    class DoDelRequest < ::Nl::Genl::Message
       TYPE = 2
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::Fou
       ATTRIBUTES = Ractor.make_shareable(%i[port af local_v4 local_v6 peer_v4 peer_v6 peer_port ifindex])
-      # Gets the value of `port` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::Port
       def port; attributes[:"port"]&.value; end
-      # Gets the value of `af` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::Af
       def af; attributes[:"af"]&.value; end
-      # Gets the value of `local-v4` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::LocalV4
       def local_v4; attributes[:"local_v4"]&.value; end
-      # Gets the value of `local-v6` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Fou::LocalV6
       def local_v6; attributes[:"local_v6"]&.value; end
-      # Gets the value of `peer-v4` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::PeerV4
       def peer_v4; attributes[:"peer_v4"]&.value; end
-      # Gets the value of `peer-v6` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Fou::PeerV6
       def peer_v6; attributes[:"peer_v6"]&.value; end
-      # Gets the value of `peer-port` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::PeerPort
       def peer_port; attributes[:"peer_port"]&.value; end
-      # Gets the value of `ifindex` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::Ifindex
       def ifindex; attributes[:"ifindex"]&.value; end
     end
     # Get tunnel info.
-    class DoGetRequest < ::Nl::Protocols::Genl::Message
+    class DoGetRequest < ::Nl::Genl::Message
       TYPE = 3
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::Fou
       ATTRIBUTES = Ractor.make_shareable(%i[port af local_v4 local_v6 peer_v4 peer_v6 peer_port ifindex])
-      # Gets the value of `port` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::Port
       def port; attributes[:"port"]&.value; end
-      # Gets the value of `af` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::Af
       def af; attributes[:"af"]&.value; end
-      # Gets the value of `local-v4` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::LocalV4
       def local_v4; attributes[:"local_v4"]&.value; end
-      # Gets the value of `local-v6` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Fou::LocalV6
       def local_v6; attributes[:"local_v6"]&.value; end
-      # Gets the value of `peer-v4` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::PeerV4
       def peer_v4; attributes[:"peer_v4"]&.value; end
-      # Gets the value of `peer-v6` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Fou::PeerV6
       def peer_v6; attributes[:"peer_v6"]&.value; end
-      # Gets the value of `peer-port` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::PeerPort
       def peer_port; attributes[:"peer_port"]&.value; end
-      # Gets the value of `ifindex` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::Ifindex
       def ifindex; attributes[:"ifindex"]&.value; end
     end
     # Get tunnel info.
-    class DoGetReply < ::Nl::Protocols::Genl::Message
+    class DoGetReply < ::Nl::Genl::Message
       TYPE = 3
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::Fou
       ATTRIBUTES = Ractor.make_shareable(%i[port ipproto type remcsum_nopartial local_v4 local_v6 peer_v4 peer_v6 peer_port ifindex])
-      # Gets the value of `port` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::Port
       def port; attributes[:"port"]&.value; end
-      # Gets the value of `ipproto` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::Ipproto
       def ipproto; attributes[:"ipproto"]&.value; end
-      # Gets the value of `type` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::Type
       def type; attributes[:"type"]&.value; end
-      # Gets the value of `remcsum-nopartial` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::RemcsumNopartial
       def remcsum_nopartial; attributes[:"remcsum_nopartial"]&.value; end
-      # Gets the value of `local-v4` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::LocalV4
       def local_v4; attributes[:"local_v4"]&.value; end
-      # Gets the value of `local-v6` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Fou::LocalV6
       def local_v6; attributes[:"local_v6"]&.value; end
-      # Gets the value of `peer-v4` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::PeerV4
       def peer_v4; attributes[:"peer_v4"]&.value; end
-      # Gets the value of `peer-v6` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Fou::PeerV6
       def peer_v6; attributes[:"peer_v6"]&.value; end
-      # Gets the value of `peer-port` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::PeerPort
       def peer_port; attributes[:"peer_port"]&.value; end
-      # Gets the value of `ifindex` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::Ifindex
       def ifindex; attributes[:"ifindex"]&.value; end
     end
     # Get tunnel info.
-    class DumpGetRequest < ::Nl::Protocols::Genl::Message
+    class DumpGetRequest < ::Nl::Genl::Message
       TYPE = 3
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::Fou
       ATTRIBUTES = Ractor.make_shareable(%i[])
     end
     # Get tunnel info.
-    class DumpGetReply < ::Nl::Protocols::Genl::Message
+    class DumpGetReply < ::Nl::Genl::Message
       TYPE = 3
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::Fou
       ATTRIBUTES = Ractor.make_shareable(%i[port ipproto type remcsum_nopartial local_v4 local_v6 peer_v4 peer_v6 peer_port ifindex])
-      # Gets the value of `port` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::Port
       def port; attributes[:"port"]&.value; end
-      # Gets the value of `ipproto` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::Ipproto
       def ipproto; attributes[:"ipproto"]&.value; end
-      # Gets the value of `type` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::Type
       def type; attributes[:"type"]&.value; end
-      # Gets the value of `remcsum-nopartial` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::RemcsumNopartial
       def remcsum_nopartial; attributes[:"remcsum_nopartial"]&.value; end
-      # Gets the value of `local-v4` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::LocalV4
       def local_v4; attributes[:"local_v4"]&.value; end
-      # Gets the value of `local-v6` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Fou::LocalV6
       def local_v6; attributes[:"local_v6"]&.value; end
-      # Gets the value of `peer-v4` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::PeerV4
       def peer_v4; attributes[:"peer_v4"]&.value; end
-      # Gets the value of `peer-v6` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Fou::PeerV6
       def peer_v6; attributes[:"peer_v6"]&.value; end
-      # Gets the value of `peer-port` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::PeerPort
       def peer_port; attributes[:"peer_port"]&.value; end
-      # Gets the value of `ifindex` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Fou::Ifindex
       def ifindex; attributes[:"ifindex"]&.value; end
     end
   end
   module Notifications
   end
+  # @private
   NOTIFICATIONS = Ractor.make_shareable({}) #: Hash[::Integer, ::Class]
   # Add port.
   # 
   # Requires CAP_NET_ADMIN in the initial user namespace.
-  #--
   # @rbs (?port: ::Integer, ?ipproto: ::Integer, ?type: ::Integer, ?remcsum_nopartial: ::Integer, ?local_v4: ::Integer, ?local_v6: ::String, ?peer_v4: ::Integer, ?peer_v6: ::String, ?peer_port: ::Integer, ?ifindex: ::Integer) -> void
+  # @param [Hash] args
+  # @option args [Integer] port
+  # @option args [Integer] ipproto
+  # @option args [Integer] type
+  # @option args [Integer] remcsum_nopartial
+  # @option args [Integer] local_v4
+  # @option args [String] local_v6
+  # @option args [Integer] peer_v4
+  # @option args [String] peer_v6
+  # @option args [Integer] peer_port
+  # @option args [Integer] ifindex
+  # @return [void]
+  # @see Messages::DoAddRequest
   def do_add(**args)
     exchange_message(:"do", Messages::DoAddRequest, nil, args)
   end
   # Delete port.
   # 
   # Requires CAP_NET_ADMIN in the initial user namespace.
-  #--
   # @rbs (?port: ::Integer, ?af: ::Integer, ?local_v4: ::Integer, ?local_v6: ::String, ?peer_v4: ::Integer, ?peer_v6: ::String, ?peer_port: ::Integer, ?ifindex: ::Integer) -> void
+  # @param [Hash] args
+  # @option args [Integer] port
+  # @option args [Integer] af
+  # @option args [Integer] local_v4
+  # @option args [String] local_v6
+  # @option args [Integer] peer_v4
+  # @option args [String] peer_v6
+  # @option args [Integer] peer_port
+  # @option args [Integer] ifindex
+  # @return [void]
+  # @see Messages::DoDelRequest
   def do_del(**args)
     exchange_message(:"do", Messages::DoDelRequest, nil, args)
   end
   # Get tunnel info.
-  #--
   # @rbs (?port: ::Integer, ?af: ::Integer, ?local_v4: ::Integer, ?local_v6: ::String, ?peer_v4: ::Integer, ?peer_v6: ::String, ?peer_port: ::Integer, ?ifindex: ::Integer) -> Messages::DoGetReply
+  # @param [Hash] args
+  # @option args [Integer] port
+  # @option args [Integer] af
+  # @option args [Integer] local_v4
+  # @option args [String] local_v6
+  # @option args [Integer] peer_v4
+  # @option args [String] peer_v6
+  # @option args [Integer] peer_port
+  # @option args [Integer] ifindex
+  # @return [Messages::DoGetReply]
+  # @see Messages::DoGetRequest
   def do_get(**args)
     exchange_message(:"do", Messages::DoGetRequest, Messages::DoGetReply, args)
   end
   # Get tunnel info.
-  #--
-  # @rbs () -> Enumerable[Messages::DumpGetReply]
+  # @rbs () -> Array[Messages::DumpGetReply]
   #   | () { (Messages::DumpGetReply) -> void } -> void
+  # @overload dump_get(**args)
+  #   Returns an array when no block is given.
+  #   @param [Hash] args
+  #   @return [Array<Messages::DumpGetReply>]
+  # @overload dump_get(**args, &block)
+  #   Yields each reply when a block is given.
+  #   @param [Hash] args
+  #   @yieldparam [Messages::DumpGetReply] reply
+  #   @return [void]
+  # @see Messages::DumpGetRequest
   def dump_get(**args, &block)
     exchange_message(:"dump", Messages::DumpGetRequest, Messages::DumpGetReply, args, &block)
   end
   class AsyncOperations
-    # :nodoc:
+    # @private
     def initialize(&exchange)
       @exchange = exchange
     end
     # Add port.
     # 
     # Requires CAP_NET_ADMIN in the initial user namespace.
-    #--
     # @rbs (?port: ::Integer, ?ipproto: ::Integer, ?type: ::Integer, ?remcsum_nopartial: ::Integer, ?local_v4: ::Integer, ?local_v6: ::String, ?peer_v4: ::Integer, ?peer_v6: ::String, ?peer_port: ::Integer, ?ifindex: ::Integer) -> ::Nl::Async::Future[void]
+    # @param [Hash] args
+    # @option args [Integer] port
+    # @option args [Integer] ipproto
+    # @option args [Integer] type
+    # @option args [Integer] remcsum_nopartial
+    # @option args [Integer] local_v4
+    # @option args [String] local_v6
+    # @option args [Integer] peer_v4
+    # @option args [String] peer_v6
+    # @option args [Integer] peer_port
+    # @option args [Integer] ifindex
+    # @return [Nl::Async::Future<void>]
+    # @see Messages::DoAddRequest
     def do_add(**args)
       @exchange.call(:"do", Messages::DoAddRequest, nil, args)
     end
     # Delete port.
     # 
     # Requires CAP_NET_ADMIN in the initial user namespace.
-    #--
     # @rbs (?port: ::Integer, ?af: ::Integer, ?local_v4: ::Integer, ?local_v6: ::String, ?peer_v4: ::Integer, ?peer_v6: ::String, ?peer_port: ::Integer, ?ifindex: ::Integer) -> ::Nl::Async::Future[void]
+    # @param [Hash] args
+    # @option args [Integer] port
+    # @option args [Integer] af
+    # @option args [Integer] local_v4
+    # @option args [String] local_v6
+    # @option args [Integer] peer_v4
+    # @option args [String] peer_v6
+    # @option args [Integer] peer_port
+    # @option args [Integer] ifindex
+    # @return [Nl::Async::Future<void>]
+    # @see Messages::DoDelRequest
     def do_del(**args)
       @exchange.call(:"do", Messages::DoDelRequest, nil, args)
     end
     # Get tunnel info.
-    #--
     # @rbs (?port: ::Integer, ?af: ::Integer, ?local_v4: ::Integer, ?local_v6: ::String, ?peer_v4: ::Integer, ?peer_v6: ::String, ?peer_port: ::Integer, ?ifindex: ::Integer) -> ::Nl::Async::Future[Messages::DoGetReply]
+    # @param [Hash] args
+    # @option args [Integer] port
+    # @option args [Integer] af
+    # @option args [Integer] local_v4
+    # @option args [String] local_v6
+    # @option args [Integer] peer_v4
+    # @option args [String] peer_v6
+    # @option args [Integer] peer_port
+    # @option args [Integer] ifindex
+    # @return [Nl::Async::Future<Messages::DoGetReply>]
+    # @see Messages::DoGetRequest
     def do_get(**args)
       @exchange.call(:"do", Messages::DoGetRequest, Messages::DoGetReply, args)
     end
     # Get tunnel info.
-    #--
     # @rbs () -> ::Nl::Async::Stream[Messages::DumpGetReply]
+    # @param [Hash] args
+    # @return [Nl::Async::Stream<Messages::DumpGetReply>]
+    # @see Messages::DumpGetRequest
     def dump_get(**args)
       @exchange.call(:"dump", Messages::DumpGetRequest, Messages::DumpGetReply, 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:)