nl-linux 0.3.0 → 0.4.1

data/generated/nl/linux/rt_addr.rb

@@ -3,15 +3,45 @@
 # This file is based on Documentation/netlink/specs/rt-addr.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
 # Address configuration over rtnetlink.
-class RtAddr < ::Nl::Family
+class RtAddr < ::Nl::Raw::Family
   NAME = "rt-addr"
-  PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Raw.new("rt-addr", 0))
+  PROTONUM = 0
+  # @rbs (?executor: executor?, ?notification_capacity: ::Integer?) -> (::Nl::Family::Session & instance)
+  # @rbs | [R] (?executor: executor?, ?notification_capacity: ::Integer?) { (instance) -> R } -> R
+  # @overload open(executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY)
+  #   @param [Symbol, nil] executor
+  #   @param [Integer, nil] notification_capacity
+  #   @return [RtAddr]
+  # @overload open(executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY, &block)
+  #   @param [Symbol, nil] executor
+  #   @param [Integer, nil] notification_capacity
+  #   @yieldparam [RtAddr] family
+  #   @return [Object] the result of the block
+  def self.open(executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY)
+    super
+  end
+  # @private
   MCAST_GROUPS = Ractor.make_shareable({:"rtnlgrp_ipv4_ifaddr" => ::Nl::McastGroup.new("rtnlgrp-ipv4-ifaddr", 5), :"rtnlgrp_ipv6_ifaddr" => ::Nl::McastGroup.new("rtnlgrp-ipv6-ifaddr", 9)}) #: Hash[::Symbol, ::Nl::McastGroup]
+  module Flags
+    module IfaFlags
+      Secondary = 1
+      Nodad = 2
+      Optimistic = 4
+      Dadfailed = 8
+      Homeaddress = 16
+      Deprecated = 32
+      Tentative = 64
+      Permanent = 128
+      Managetempaddr = 256
+      Noprefixroute = 512
+      Mcautojoin = 1024
+      StablePrivacy = 2048
+    end
+  end
   module Structs
     Ifaddrmsg = Struct.new(
       :"ifa_family", #: ::Integer
@@ -21,19 +51,31 @@ class RtAddr < ::Nl::Family
       :"ifa_index", #: ::Integer
     )
     class Ifaddrmsg
-      # :nodoc:
-      MEMBERS = Ractor.make_shareable({ifa_family: ::Nl::Protocols::Raw::DataTypes::Scalar.new(::Nl::Endian::Host::U8, check: nil), ifa_prefixlen: ::Nl::Protocols::Raw::DataTypes::Scalar.new(::Nl::Endian::Host::U8, check: nil), ifa_flags: ::Nl::Protocols::Raw::DataTypes::Scalar.new(::Nl::Endian::Host::U8, check: nil), ifa_scope: ::Nl::Protocols::Raw::DataTypes::Scalar.new(::Nl::Endian::Host::U8, check: nil), ifa_index: ::Nl::Protocols::Raw::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)}) #: Hash[::Symbol, ::Nl::_DataType]
+      # @!attribute [rw] ifa_family
+      #   @return [Integer]
+      # @!attribute [rw] ifa_prefixlen
+      #   @return [Integer]
+      # @!attribute [rw] ifa_flags
+      #   @return [Integer]
+      # @!attribute [rw] ifa_scope
+      #   @return [Integer]
+      # @!attribute [rw] ifa_index
+      #   @return [Integer]
+      # @private
+      MEMBERS = Ractor.make_shareable({ifa_family: ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U8, check: nil), ifa_prefixlen: ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U8, check: nil), ifa_flags: ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U8, check: nil), ifa_scope: ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U8, check: nil), ifa_index: ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, 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
@@ -45,459 +87,620 @@ class RtAddr < ::Nl::Family
       :"tstamp", #: ::Integer
     )
     class IfaCacheinfo
-      # :nodoc:
-      MEMBERS = Ractor.make_shareable({ifa_prefered: ::Nl::Protocols::Raw::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil), ifa_valid: ::Nl::Protocols::Raw::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil), cstamp: ::Nl::Protocols::Raw::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil), tstamp: ::Nl::Protocols::Raw::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)}) #: Hash[::Symbol, ::Nl::_DataType]
+      # @!attribute [rw] ifa_prefered
+      #   @return [Integer]
+      # @!attribute [rw] ifa_valid
+      #   @return [Integer]
+      # @!attribute [rw] cstamp
+      #   @return [Integer]
+      # @!attribute [rw] tstamp
+      #   @return [Integer]
+      # @private
+      MEMBERS = Ractor.make_shareable({ifa_prefered: ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil), ifa_valid: ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil), cstamp: ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil), tstamp: ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, 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 AddrAttrs < ::Nl::Protocols::Raw::AttributeSet
+    class AddrAttrs < ::Nl::AttributeSet
       # Abstract class
-      class Attribute < ::Nl::Protocols::Raw::AttributeSet::Attribute
+      class Attribute < ::Nl::AttributeSet::Attribute
       end
       class Address < Attribute
         TYPE = 1
         NAME = :"address"
-        DATATYPE = ::Nl::Protocols::Raw::DataTypes::Binary.new(check: nil)
+        # @private
+        ORDER = 0
+        # @private
+        DATATYPE = ::Nl::DataTypes::Binary.new(check: nil)
       end
       class Local < Attribute
         TYPE = 2
         NAME = :"local"
-        DATATYPE = ::Nl::Protocols::Raw::DataTypes::Binary.new(check: nil)
+        # @private
+        ORDER = 1
+        # @private
+        DATATYPE = ::Nl::DataTypes::Binary.new(check: nil)
       end
       class Label < Attribute
         TYPE = 3
         NAME = :"label"
-        DATATYPE = ::Nl::Protocols::Raw::DataTypes::String.new(check: nil)
+        # @private
+        ORDER = 2
+        # @private
+        DATATYPE = ::Nl::DataTypes::String.new(check: nil)
       end
       class Broadcast < Attribute
         TYPE = 4
         NAME = :"broadcast"
-        DATATYPE = ::Nl::Protocols::Raw::DataTypes::Scalar.new(::Nl::Endian::Big::U32, check: nil)
+        # @private
+        ORDER = 3
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Big::U32, check: nil)
       end
       class Anycast < Attribute
         TYPE = 5
         NAME = :"anycast"
-        DATATYPE = ::Nl::Protocols::Raw::DataTypes::Binary.new(check: nil)
+        # @private
+        ORDER = 4
+        # @private
+        DATATYPE = ::Nl::DataTypes::Binary.new(check: nil)
       end
       class Cacheinfo < Attribute
         TYPE = 6
         NAME = :"cacheinfo"
-        DATATYPE = ::Nl::Protocols::Raw::DataTypes::Binary.new(check: nil)
+        # @private
+        ORDER = 5
+        # @private
+        DATATYPE = ::Nl::DataTypes::Struct.new(Structs::IfaCacheinfo, check: nil, consume_remaining: true)
       end
       class Multicast < Attribute
         TYPE = 7
         NAME = :"multicast"
-        DATATYPE = ::Nl::Protocols::Raw::DataTypes::Binary.new(check: nil)
+        # @private
+        ORDER = 6
+        # @private
+        DATATYPE = ::Nl::DataTypes::Binary.new(check: nil)
       end
+      # Known flags are defined in {Flags::IfaFlags}.
       class Flags < Attribute
         TYPE = 8
         NAME = :"flags"
-        DATATYPE = ::Nl::Protocols::Raw::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 RtPriority < Attribute
         TYPE = 9
         NAME = :"rt_priority"
-        DATATYPE = ::Nl::Protocols::Raw::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 8
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
       class TargetNetnsid < Attribute
         TYPE = 10
         NAME = :"target_netnsid"
-        DATATYPE = ::Nl::Protocols::Raw::DataTypes::Binary.new(check: nil)
+        # @private
+        ORDER = 9
+        # @private
+        DATATYPE = ::Nl::DataTypes::Binary.new(check: nil)
       end
       class Proto < Attribute
         TYPE = 11
         NAME = :"proto"
-        DATATYPE = ::Nl::Protocols::Raw::DataTypes::Scalar.new(::Nl::Endian::Host::U8, check: nil)
+        # @private
+        ORDER = 10
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U8, check: nil)
       end
-      # :nodoc:
+      # @private
       BY_NAME = Ractor.make_shareable({:"address" => Address, :"local" => Local, :"label" => Label, :"broadcast" => Broadcast, :"anycast" => Anycast, :"cacheinfo" => Cacheinfo, :"multicast" => Multicast, :"flags" => Flags, :"rt_priority" => RtPriority, :"target_netnsid" => TargetNetnsid, :"proto" => Proto}) #: Hash[::Symbol, Attribute]
-      # :nodoc:
+      # @private
       BY_TYPE = Ractor.make_shareable({1 => Address, 2 => Local, 3 => Label, 4 => Broadcast, 5 => Anycast, 6 => Cacheinfo, 7 => Multicast, 8 => Flags, 9 => RtPriority, 10 => TargetNetnsid, 11 => Proto}) #: Hash[::Integer, Attribute]
+      # @rbs return: ::String
+      # @return [String]
+      # @see Address
+      def address; self[:"address"]&.value; end
+      # @rbs return: ::String
+      # @return [String]
+      # @see Local
+      def local; self[:"local"]&.value; end
+      # @rbs return: ::String
+      # @return [String]
+      # @see Label
+      def label; self[:"label"]&.value; end
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Broadcast
+      def broadcast; self[:"broadcast"]&.value; end
+      # @rbs return: ::String
+      # @return [String]
+      # @see Anycast
+      def anycast; self[:"anycast"]&.value; end
+      # @rbs return: Structs::IfaCacheinfo
+      # @return [Structs::IfaCacheinfo]
+      # @see Cacheinfo
+      def cacheinfo; self[:"cacheinfo"]&.value; end
+      # @rbs return: ::String
+      # @return [String]
+      # @see Multicast
+      def multicast; self[:"multicast"]&.value; end
+      # Known flags are defined in {Flags::IfaFlags}.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Flags
+      def flags; self[:"flags"]&.value; end
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see RtPriority
+      def rt_priority; self[:"rt_priority"]&.value; end
+      # @rbs return: ::String
+      # @return [String]
+      # @see TargetNetnsid
+      def target_netnsid; self[:"target_netnsid"]&.value; end
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Proto
+      def proto; self[:"proto"]&.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
   end
   module Messages
     # Add new address
-    class DoNewaddrRequest < ::Nl::Protocols::Raw::Message
+    class DoNewaddrRequest < ::Nl::Raw::Message
       TYPE = 20
       FIXED_HEADER = Structs::Ifaddrmsg
       ATTRIBUTE_SET = AttributeSets::AddrAttrs
       ATTRIBUTES = Ractor.make_shareable(%i[address local label cacheinfo])
-      # Gets the value of `ifa-family` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_family; fixed_header.ifa_family; end
-      # Gets the value of `ifa-prefixlen` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_prefixlen; fixed_header.ifa_prefixlen; end
-      # Gets the value of `ifa-flags` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_flags; fixed_header.ifa_flags; end
-      # Gets the value of `ifa-scope` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_scope; fixed_header.ifa_scope; end
-      # Gets the value of `ifa-index` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_index; fixed_header.ifa_index; end
-      # Gets the value of `address` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::AddrAttrs::Address
       def address; attributes[:"address"]&.value; end
-      # Gets the value of `local` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::AddrAttrs::Local
       def local; attributes[:"local"]&.value; end
-      # Gets the value of `label` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::AddrAttrs::Label
       def label; attributes[:"label"]&.value; end
-      # Gets the value of `cacheinfo` attribute in the message.
-      #--
-      # @rbs return: ::String
+      # @rbs return: Structs::IfaCacheinfo
+      # @return [Structs::IfaCacheinfo]
+      # @see AttributeSets::AddrAttrs::Cacheinfo
       def cacheinfo; attributes[:"cacheinfo"]&.value; end
     end
     # Remove address
-    class DoDeladdrRequest < ::Nl::Protocols::Raw::Message
+    class DoDeladdrRequest < ::Nl::Raw::Message
       TYPE = 21
       FIXED_HEADER = Structs::Ifaddrmsg
       ATTRIBUTE_SET = AttributeSets::AddrAttrs
       ATTRIBUTES = Ractor.make_shareable(%i[address local])
-      # Gets the value of `ifa-family` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_family; fixed_header.ifa_family; end
-      # Gets the value of `ifa-prefixlen` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_prefixlen; fixed_header.ifa_prefixlen; end
-      # Gets the value of `ifa-flags` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_flags; fixed_header.ifa_flags; end
-      # Gets the value of `ifa-scope` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_scope; fixed_header.ifa_scope; end
-      # Gets the value of `ifa-index` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_index; fixed_header.ifa_index; end
-      # Gets the value of `address` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::AddrAttrs::Address
       def address; attributes[:"address"]&.value; end
-      # Gets the value of `local` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::AddrAttrs::Local
       def local; attributes[:"local"]&.value; end
     end
     # Dump address information.
-    class DumpGetaddrRequest < ::Nl::Protocols::Raw::Message
+    class DumpGetaddrRequest < ::Nl::Raw::Message
       TYPE = 22
       FIXED_HEADER = Structs::Ifaddrmsg
       ATTRIBUTE_SET = AttributeSets::AddrAttrs
       ATTRIBUTES = Ractor.make_shareable(%i[])
-      # Gets the value of `ifa-family` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_family; fixed_header.ifa_family; end
-      # Gets the value of `ifa-prefixlen` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_prefixlen; fixed_header.ifa_prefixlen; end
-      # Gets the value of `ifa-flags` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_flags; fixed_header.ifa_flags; end
-      # Gets the value of `ifa-scope` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_scope; fixed_header.ifa_scope; end
-      # Gets the value of `ifa-index` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_index; fixed_header.ifa_index; end
     end
     # Dump address information.
-    class DumpGetaddrReply < ::Nl::Protocols::Raw::Message
+    class DumpGetaddrReply < ::Nl::Raw::Message
       TYPE = 20
       FIXED_HEADER = Structs::Ifaddrmsg
       ATTRIBUTE_SET = AttributeSets::AddrAttrs
       ATTRIBUTES = Ractor.make_shareable(%i[address local label cacheinfo])
-      # Gets the value of `ifa-family` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_family; fixed_header.ifa_family; end
-      # Gets the value of `ifa-prefixlen` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_prefixlen; fixed_header.ifa_prefixlen; end
-      # Gets the value of `ifa-flags` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_flags; fixed_header.ifa_flags; end
-      # Gets the value of `ifa-scope` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_scope; fixed_header.ifa_scope; end
-      # Gets the value of `ifa-index` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_index; fixed_header.ifa_index; end
-      # Gets the value of `address` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::AddrAttrs::Address
       def address; attributes[:"address"]&.value; end
-      # Gets the value of `local` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::AddrAttrs::Local
       def local; attributes[:"local"]&.value; end
-      # Gets the value of `label` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::AddrAttrs::Label
       def label; attributes[:"label"]&.value; end
-      # Gets the value of `cacheinfo` attribute in the message.
-      #--
-      # @rbs return: ::String
+      # @rbs return: Structs::IfaCacheinfo
+      # @return [Structs::IfaCacheinfo]
+      # @see AttributeSets::AddrAttrs::Cacheinfo
       def cacheinfo; attributes[:"cacheinfo"]&.value; end
     end
     # Get / dump IPv4/IPv6 multicast addresses.
-    class DoGetmulticastRequest < ::Nl::Protocols::Raw::Message
+    class DoGetmulticastRequest < ::Nl::Raw::Message
       TYPE = 58
       FIXED_HEADER = Structs::Ifaddrmsg
       ATTRIBUTE_SET = AttributeSets::AddrAttrs
       ATTRIBUTES = Ractor.make_shareable(%i[])
-      # Gets the value of `ifa-family` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_family; fixed_header.ifa_family; end
-      # Gets the value of `ifa-prefixlen` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_prefixlen; fixed_header.ifa_prefixlen; end
-      # Gets the value of `ifa-flags` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_flags; fixed_header.ifa_flags; end
-      # Gets the value of `ifa-scope` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_scope; fixed_header.ifa_scope; end
-      # Gets the value of `ifa-index` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_index; fixed_header.ifa_index; end
     end
     # Get / dump IPv4/IPv6 multicast addresses.
-    class DoGetmulticastReply < ::Nl::Protocols::Raw::Message
+    class DoGetmulticastReply < ::Nl::Raw::Message
       TYPE = 58
       FIXED_HEADER = Structs::Ifaddrmsg
       ATTRIBUTE_SET = AttributeSets::AddrAttrs
       ATTRIBUTES = Ractor.make_shareable(%i[cacheinfo multicast])
-      # Gets the value of `ifa-family` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_family; fixed_header.ifa_family; end
-      # Gets the value of `ifa-prefixlen` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_prefixlen; fixed_header.ifa_prefixlen; end
-      # Gets the value of `ifa-flags` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_flags; fixed_header.ifa_flags; end
-      # Gets the value of `ifa-scope` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_scope; fixed_header.ifa_scope; end
-      # Gets the value of `ifa-index` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_index; fixed_header.ifa_index; end
-      # Gets the value of `cacheinfo` attribute in the message.
-      #--
-      # @rbs return: ::String
+      # @rbs return: Structs::IfaCacheinfo
+      # @return [Structs::IfaCacheinfo]
+      # @see AttributeSets::AddrAttrs::Cacheinfo
       def cacheinfo; attributes[:"cacheinfo"]&.value; end
-      # Gets the value of `multicast` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::AddrAttrs::Multicast
       def multicast; attributes[:"multicast"]&.value; end
     end
     # Get / dump IPv4/IPv6 multicast addresses.
-    class DumpGetmulticastRequest < ::Nl::Protocols::Raw::Message
+    class DumpGetmulticastRequest < ::Nl::Raw::Message
       TYPE = 58
       FIXED_HEADER = Structs::Ifaddrmsg
       ATTRIBUTE_SET = AttributeSets::AddrAttrs
       ATTRIBUTES = Ractor.make_shareable(%i[])
-      # Gets the value of `ifa-family` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_family; fixed_header.ifa_family; end
-      # Gets the value of `ifa-prefixlen` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_prefixlen; fixed_header.ifa_prefixlen; end
-      # Gets the value of `ifa-flags` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_flags; fixed_header.ifa_flags; end
-      # Gets the value of `ifa-scope` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_scope; fixed_header.ifa_scope; end
-      # Gets the value of `ifa-index` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_index; fixed_header.ifa_index; end
     end
     # Get / dump IPv4/IPv6 multicast addresses.
-    class DumpGetmulticastReply < ::Nl::Protocols::Raw::Message
+    class DumpGetmulticastReply < ::Nl::Raw::Message
       TYPE = 58
       FIXED_HEADER = Structs::Ifaddrmsg
       ATTRIBUTE_SET = AttributeSets::AddrAttrs
       ATTRIBUTES = Ractor.make_shareable(%i[cacheinfo multicast])
-      # Gets the value of `ifa-family` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_family; fixed_header.ifa_family; end
-      # Gets the value of `ifa-prefixlen` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_prefixlen; fixed_header.ifa_prefixlen; end
-      # Gets the value of `ifa-flags` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_flags; fixed_header.ifa_flags; end
-      # Gets the value of `ifa-scope` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_scope; fixed_header.ifa_scope; end
-      # Gets the value of `ifa-index` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def ifa_index; fixed_header.ifa_index; end
-      # Gets the value of `cacheinfo` attribute in the message.
-      #--
-      # @rbs return: ::String
+      # @rbs return: Structs::IfaCacheinfo
+      # @return [Structs::IfaCacheinfo]
+      # @see AttributeSets::AddrAttrs::Cacheinfo
       def cacheinfo; attributes[:"cacheinfo"]&.value; end
-      # Gets the value of `multicast` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::AddrAttrs::Multicast
       def multicast; attributes[:"multicast"]&.value; end
     end
   end
   module Notifications
   end
+  # @private
   NOTIFICATIONS = Ractor.make_shareable({}) #: Hash[::Integer, ::Class]
   # Add new address
-  #--
-  # @rbs (?ifa_family: ::Integer, ?ifa_prefixlen: ::Integer, ?ifa_flags: ::Integer, ?ifa_scope: ::Integer, ?ifa_index: ::Integer, ?address: ::String, ?local: ::String, ?label: ::String, ?cacheinfo: ::String) -> void
+  # @rbs (?ifa_family: ::Integer, ?ifa_prefixlen: ::Integer, ?ifa_flags: ::Integer, ?ifa_scope: ::Integer, ?ifa_index: ::Integer, ?address: ::String, ?local: ::String, ?label: ::String, ?cacheinfo: (Structs::IfaCacheinfo | ::Hash[::Symbol, untyped])) -> void
+  # @param [Hash] args
+  # @option args [Integer] ifa_family
+  # @option args [Integer] ifa_prefixlen
+  # @option args [Integer] ifa_flags
+  # @option args [Integer] ifa_scope
+  # @option args [Integer] ifa_index
+  # @option args [String] address
+  # @option args [String] local
+  # @option args [String] label
+  # @option args [Structs::IfaCacheinfo, Hash<Symbol, Object>] cacheinfo
+  # @return [void]
+  # @see Messages::DoNewaddrRequest
   def do_newaddr(**args)
     exchange_message(:"do", Messages::DoNewaddrRequest, nil, args)
   end
   # Remove address
-  #--
   # @rbs (?ifa_family: ::Integer, ?ifa_prefixlen: ::Integer, ?ifa_flags: ::Integer, ?ifa_scope: ::Integer, ?ifa_index: ::Integer, ?address: ::String, ?local: ::String) -> void
+  # @param [Hash] args
+  # @option args [Integer] ifa_family
+  # @option args [Integer] ifa_prefixlen
+  # @option args [Integer] ifa_flags
+  # @option args [Integer] ifa_scope
+  # @option args [Integer] ifa_index
+  # @option args [String] address
+  # @option args [String] local
+  # @return [void]
+  # @see Messages::DoDeladdrRequest
   def do_deladdr(**args)
     exchange_message(:"do", Messages::DoDeladdrRequest, nil, args)
   end
   # Dump address information.
-  #--
-  # @rbs (?ifa_family: ::Integer, ?ifa_prefixlen: ::Integer, ?ifa_flags: ::Integer, ?ifa_scope: ::Integer, ?ifa_index: ::Integer) -> Enumerable[Messages::DumpGetaddrReply]
+  # @rbs (?ifa_family: ::Integer, ?ifa_prefixlen: ::Integer, ?ifa_flags: ::Integer, ?ifa_scope: ::Integer, ?ifa_index: ::Integer) -> Array[Messages::DumpGetaddrReply]
   #   | (?ifa_family: ::Integer, ?ifa_prefixlen: ::Integer, ?ifa_flags: ::Integer, ?ifa_scope: ::Integer, ?ifa_index: ::Integer) { (Messages::DumpGetaddrReply) -> void } -> void
+  # @overload dump_getaddr(**args)
+  #   Returns an array when no block is given.
+  #   @param [Hash] args
+  #   @option args [Integer] ifa_family
+  #   @option args [Integer] ifa_prefixlen
+  #   @option args [Integer] ifa_flags
+  #   @option args [Integer] ifa_scope
+  #   @option args [Integer] ifa_index
+  #   @return [Array<Messages::DumpGetaddrReply>]
+  # @overload dump_getaddr(**args, &block)
+  #   Yields each reply when a block is given.
+  #   @param [Hash] args
+  #   @option args [Integer] ifa_family
+  #   @option args [Integer] ifa_prefixlen
+  #   @option args [Integer] ifa_flags
+  #   @option args [Integer] ifa_scope
+  #   @option args [Integer] ifa_index
+  #   @yieldparam [Messages::DumpGetaddrReply] reply
+  #   @return [void]
+  # @see Messages::DumpGetaddrRequest
   def dump_getaddr(**args, &block)
     exchange_message(:"dump", Messages::DumpGetaddrRequest, Messages::DumpGetaddrReply, args, &block)
   end
   # Get / dump IPv4/IPv6 multicast addresses.
-  #--
   # @rbs (?ifa_family: ::Integer, ?ifa_prefixlen: ::Integer, ?ifa_flags: ::Integer, ?ifa_scope: ::Integer, ?ifa_index: ::Integer) -> Messages::DoGetmulticastReply
+  # @param [Hash] args
+  # @option args [Integer] ifa_family
+  # @option args [Integer] ifa_prefixlen
+  # @option args [Integer] ifa_flags
+  # @option args [Integer] ifa_scope
+  # @option args [Integer] ifa_index
+  # @return [Messages::DoGetmulticastReply]
+  # @see Messages::DoGetmulticastRequest
   def do_getmulticast(**args)
     exchange_message(:"do", Messages::DoGetmulticastRequest, Messages::DoGetmulticastReply, args)
   end
   # Get / dump IPv4/IPv6 multicast addresses.
-  #--
-  # @rbs (?ifa_family: ::Integer, ?ifa_prefixlen: ::Integer, ?ifa_flags: ::Integer, ?ifa_scope: ::Integer, ?ifa_index: ::Integer) -> Enumerable[Messages::DumpGetmulticastReply]
+  # @rbs (?ifa_family: ::Integer, ?ifa_prefixlen: ::Integer, ?ifa_flags: ::Integer, ?ifa_scope: ::Integer, ?ifa_index: ::Integer) -> Array[Messages::DumpGetmulticastReply]
   #   | (?ifa_family: ::Integer, ?ifa_prefixlen: ::Integer, ?ifa_flags: ::Integer, ?ifa_scope: ::Integer, ?ifa_index: ::Integer) { (Messages::DumpGetmulticastReply) -> void } -> void
+  # @overload dump_getmulticast(**args)
+  #   Returns an array when no block is given.
+  #   @param [Hash] args
+  #   @option args [Integer] ifa_family
+  #   @option args [Integer] ifa_prefixlen
+  #   @option args [Integer] ifa_flags
+  #   @option args [Integer] ifa_scope
+  #   @option args [Integer] ifa_index
+  #   @return [Array<Messages::DumpGetmulticastReply>]
+  # @overload dump_getmulticast(**args, &block)
+  #   Yields each reply when a block is given.
+  #   @param [Hash] args
+  #   @option args [Integer] ifa_family
+  #   @option args [Integer] ifa_prefixlen
+  #   @option args [Integer] ifa_flags
+  #   @option args [Integer] ifa_scope
+  #   @option args [Integer] ifa_index
+  #   @yieldparam [Messages::DumpGetmulticastReply] reply
+  #   @return [void]
+  # @see Messages::DumpGetmulticastRequest
   def dump_getmulticast(**args, &block)
     exchange_message(:"dump", Messages::DumpGetmulticastRequest, Messages::DumpGetmulticastReply, args, &block)
   end
   class AsyncOperations
-    # :nodoc:
+    # @private
     def initialize(&exchange)
       @exchange = exchange
     end
     # Add new address
-    #--
-    # @rbs (?ifa_family: ::Integer, ?ifa_prefixlen: ::Integer, ?ifa_flags: ::Integer, ?ifa_scope: ::Integer, ?ifa_index: ::Integer, ?address: ::String, ?local: ::String, ?label: ::String, ?cacheinfo: ::String) -> ::Nl::Async::Future[void]
+    # @rbs (?ifa_family: ::Integer, ?ifa_prefixlen: ::Integer, ?ifa_flags: ::Integer, ?ifa_scope: ::Integer, ?ifa_index: ::Integer, ?address: ::String, ?local: ::String, ?label: ::String, ?cacheinfo: (Structs::IfaCacheinfo | ::Hash[::Symbol, untyped])) -> ::Nl::Async::Future[void]
+    # @param [Hash] args
+    # @option args [Integer] ifa_family
+    # @option args [Integer] ifa_prefixlen
+    # @option args [Integer] ifa_flags
+    # @option args [Integer] ifa_scope
+    # @option args [Integer] ifa_index
+    # @option args [String] address
+    # @option args [String] local
+    # @option args [String] label
+    # @option args [Structs::IfaCacheinfo, Hash<Symbol, Object>] cacheinfo
+    # @return [Nl::Async::Future<void>]
+    # @see Messages::DoNewaddrRequest
     def do_newaddr(**args)
       @exchange.call(:"do", Messages::DoNewaddrRequest, nil, args)
     end
     # Remove address
-    #--
     # @rbs (?ifa_family: ::Integer, ?ifa_prefixlen: ::Integer, ?ifa_flags: ::Integer, ?ifa_scope: ::Integer, ?ifa_index: ::Integer, ?address: ::String, ?local: ::String) -> ::Nl::Async::Future[void]
+    # @param [Hash] args
+    # @option args [Integer] ifa_family
+    # @option args [Integer] ifa_prefixlen
+    # @option args [Integer] ifa_flags
+    # @option args [Integer] ifa_scope
+    # @option args [Integer] ifa_index
+    # @option args [String] address
+    # @option args [String] local
+    # @return [Nl::Async::Future<void>]
+    # @see Messages::DoDeladdrRequest
     def do_deladdr(**args)
       @exchange.call(:"do", Messages::DoDeladdrRequest, nil, args)
     end
     # Dump address information.
-    #--
     # @rbs (?ifa_family: ::Integer, ?ifa_prefixlen: ::Integer, ?ifa_flags: ::Integer, ?ifa_scope: ::Integer, ?ifa_index: ::Integer) -> ::Nl::Async::Stream[Messages::DumpGetaddrReply]
+    # @param [Hash] args
+    # @option args [Integer] ifa_family
+    # @option args [Integer] ifa_prefixlen
+    # @option args [Integer] ifa_flags
+    # @option args [Integer] ifa_scope
+    # @option args [Integer] ifa_index
+    # @return [Nl::Async::Stream<Messages::DumpGetaddrReply>]
+    # @see Messages::DumpGetaddrRequest
     def dump_getaddr(**args)
       @exchange.call(:"dump", Messages::DumpGetaddrRequest, Messages::DumpGetaddrReply, args)
     end
     # Get / dump IPv4/IPv6 multicast addresses.
-    #--
     # @rbs (?ifa_family: ::Integer, ?ifa_prefixlen: ::Integer, ?ifa_flags: ::Integer, ?ifa_scope: ::Integer, ?ifa_index: ::Integer) -> ::Nl::Async::Future[Messages::DoGetmulticastReply]
+    # @param [Hash] args
+    # @option args [Integer] ifa_family
+    # @option args [Integer] ifa_prefixlen
+    # @option args [Integer] ifa_flags
+    # @option args [Integer] ifa_scope
+    # @option args [Integer] ifa_index
+    # @return [Nl::Async::Future<Messages::DoGetmulticastReply>]
+    # @see Messages::DoGetmulticastRequest
     def do_getmulticast(**args)
       @exchange.call(:"do", Messages::DoGetmulticastRequest, Messages::DoGetmulticastReply, args)
     end
     # Get / dump IPv4/IPv6 multicast addresses.
-    #--
     # @rbs (?ifa_family: ::Integer, ?ifa_prefixlen: ::Integer, ?ifa_flags: ::Integer, ?ifa_scope: ::Integer, ?ifa_index: ::Integer) -> ::Nl::Async::Stream[Messages::DumpGetmulticastReply]
+    # @param [Hash] args
+    # @option args [Integer] ifa_family
+    # @option args [Integer] ifa_prefixlen
+    # @option args [Integer] ifa_flags
+    # @option args [Integer] ifa_scope
+    # @option args [Integer] ifa_index
+    # @return [Nl::Async::Stream<Messages::DumpGetmulticastReply>]
+    # @see Messages::DumpGetmulticastRequest
     def dump_getmulticast(**args)
       @exchange.call(:"dump", Messages::DumpGetmulticastRequest, Messages::DumpGetmulticastReply, 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
-  #--
   # @rbs (*(:rtnlgrp_ipv4_ifaddr | :rtnlgrp_ipv6_ifaddr) groups) -> self
+  # @param [Array<:rtnlgrp_ipv4_ifaddr, :rtnlgrp_ipv6_ifaddr>] groups
+  # @return [self]
   def subscribe(*groups) = super
-  #--
   # @rbs (*(:rtnlgrp_ipv4_ifaddr | :rtnlgrp_ipv6_ifaddr) groups) -> self
+  # @param [Array<:rtnlgrp_ipv4_ifaddr, :rtnlgrp_ipv6_ifaddr>] groups
+  # @return [self]
   def unsubscribe(*groups) = super
 end
 end; end