nl-linux 0.3.0 → 0.4.1

data/generated/nl/linux/ovs_datapath.rb

@@ -3,33 +3,65 @@
 # This file is based on Documentation/netlink/specs/ovs_datapath.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
 # OVS datapath configuration over generic netlink.
-class OvsDatapath < ::Nl::Family
+class OvsDatapath < ::Nl::Genl::Family
   NAME = "ovs_datapath"
-  PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Genl.new("ovs_datapath"))
+  VERSION = 2
+  # @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 [OvsDatapath]
+  # @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 [OvsDatapath] 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({:"ovs_datapath" => ::Nl::McastGroup.new("ovs_datapath", nil)}) #: Hash[::Symbol, ::Nl::McastGroup]
+  module Flags
+    module UserFeatures
+      # Allow last Netlink attribute to be unaligned
+      Unaligned = 1
+      # Allow datapath to associate multiple Netlink PIDs to each vport
+      VportPids = 2
+      # Allow tc offload recirc sharing
+      TcRecircSharing = 4
+      # Allow per-cpu dispatch of upcalls
+      DispatchUpcallPerCpu = 8
+    end
+  end
   module Structs
     OvsHeader = Struct.new(
       :"dp_ifindex", #: ::Integer
     )
     class OvsHeader
-      # :nodoc:
-      MEMBERS = Ractor.make_shareable({dp_ifindex: ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)}) #: Hash[::Symbol, ::Nl::_DataType]
+      # @!attribute [rw] dp_ifindex
+      #   @return [Integer]
+      # @private
+      MEMBERS = Ractor.make_shareable({dp_ifindex: ::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
@@ -41,19 +73,29 @@ class OvsDatapath < ::Nl::Family
       :"n_flows", #: ::Integer
     )
     class OvsDpStats
-      # :nodoc:
-      MEMBERS = Ractor.make_shareable({n_hit: ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil), n_missed: ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil), n_lost: ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil), n_flows: ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)}) #: Hash[::Symbol, ::Nl::_DataType]
+      # @!attribute [rw] n_hit
+      #   @return [Integer]
+      # @!attribute [rw] n_missed
+      #   @return [Integer]
+      # @!attribute [rw] n_lost
+      #   @return [Integer]
+      # @!attribute [rw] n_flows
+      #   @return [Integer]
+      # @private
+      MEMBERS = Ractor.make_shareable({n_hit: ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil), n_missed: ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil), n_lost: ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil), n_flows: ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)}) #: Hash[::Symbol, ::Nl::_DataType]
       # Decodes the struct.
-      #--
       # @rbs decoder: ::Nl::Decoder
       # @rbs return: instance
+      # @param [Nl::Decoder] decoder
+      # @return [self]
       def self.decode(decoder)
         self.new(*MEMBERS.map {|name, datatype| datatype.decode(decoder) })
       end
       # Encodes the struct.
-      #--
       # @rbs encoder: ::Nl::Encoder
       # @rbs return: void
+      # @param [Nl::Encoder] encoder
+      # @return [void]
       def encode(encoder)
         MEMBERS.each {|name, datatype| datatype.encode(encoder, self.public_send(name)) }
       end
@@ -66,305 +108,428 @@ class OvsDatapath < ::Nl::Family
       :"pad1", #: ::Integer
     )
     class OvsDpMegaflowStats
-      # :nodoc:
-      MEMBERS = Ractor.make_shareable({n_mask_hit: ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil), n_masks: ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil), padding: ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil), n_cache_hit: ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil), pad1: ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)}) #: Hash[::Symbol, ::Nl::_DataType]
+      # @!attribute [rw] n_mask_hit
+      #   @return [Integer]
+      # @!attribute [rw] n_masks
+      #   @return [Integer]
+      # @!attribute [rw] padding
+      #   @return [Integer]
+      # @!attribute [rw] n_cache_hit
+      #   @return [Integer]
+      # @!attribute [rw] pad1
+      #   @return [Integer]
+      # @private
+      MEMBERS = Ractor.make_shareable({n_mask_hit: ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil), n_masks: ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil), padding: ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil), n_cache_hit: ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil), pad1: ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)}) #: Hash[::Symbol, ::Nl::_DataType]
       # Decodes the struct.
-      #--
       # @rbs decoder: ::Nl::Decoder
       # @rbs return: instance
+      # @param [Nl::Decoder] decoder
+      # @return [self]
       def self.decode(decoder)
         self.new(*MEMBERS.map {|name, datatype| datatype.decode(decoder) })
       end
       # Encodes the struct.
-      #--
       # @rbs encoder: ::Nl::Encoder
       # @rbs return: void
+      # @param [Nl::Encoder] encoder
+      # @return [void]
       def encode(encoder)
         MEMBERS.each {|name, datatype| datatype.encode(encoder, self.public_send(name)) }
       end
     end
   end
   module AttributeSets
-    class Datapath < ::Nl::Protocols::Genl::AttributeSet
+    class Datapath < ::Nl::AttributeSet
       # Abstract class
-      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      class Attribute < ::Nl::AttributeSet::Attribute
       end
       class Name < Attribute
         TYPE = 1
         NAME = :"name"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::String.new(check: nil)
+        # @private
+        ORDER = 0
+        # @private
+        DATATYPE = ::Nl::DataTypes::String.new(check: nil)
       end
+      # upcall pid
       class UpcallPid < Attribute
         TYPE = 2
         NAME = :"upcall_pid"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 1
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
       class Stats < Attribute
         TYPE = 3
         NAME = :"stats"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Binary.new(check: nil)
+        # @private
+        ORDER = 2
+        # @private
+        DATATYPE = ::Nl::DataTypes::Struct.new(Structs::OvsDpStats, check: nil, consume_remaining: true)
       end
       class MegaflowStats < Attribute
         TYPE = 4
         NAME = :"megaflow_stats"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Binary.new(check: nil)
+        # @private
+        ORDER = 3
+        # @private
+        DATATYPE = ::Nl::DataTypes::Struct.new(Structs::OvsDpMegaflowStats, check: nil, consume_remaining: true)
       end
+      # Known flags are defined in {Flags::UserFeatures}.
       class UserFeatures < Attribute
         TYPE = 5
         NAME = :"user_features"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 4
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
       class MasksCacheSize < Attribute
         TYPE = 7
         NAME = :"masks_cache_size"
-        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 PerCpuPids < Attribute
         TYPE = 8
         NAME = :"per_cpu_pids"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Binary.new(check: nil)
+        # @private
+        ORDER = 6
+        # @private
+        DATATYPE = ::Nl::DataTypes::PackedArray.new(::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil), check: nil)
       end
       class Ifindex < Attribute
         TYPE = 9
         NAME = :"ifindex"
-        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
-      # :nodoc:
+      # @private
       BY_NAME = Ractor.make_shareable({:"name" => Name, :"upcall_pid" => UpcallPid, :"stats" => Stats, :"megaflow_stats" => MegaflowStats, :"user_features" => UserFeatures, :"masks_cache_size" => MasksCacheSize, :"per_cpu_pids" => PerCpuPids, :"ifindex" => Ifindex}) #: Hash[::Symbol, Attribute]
-      # :nodoc:
+      # @private
       BY_TYPE = Ractor.make_shareable({1 => Name, 2 => UpcallPid, 3 => Stats, 4 => MegaflowStats, 5 => UserFeatures, 7 => MasksCacheSize, 8 => PerCpuPids, 9 => Ifindex}) #: Hash[::Integer, Attribute]
+      # @rbs return: ::String
+      # @return [String]
+      # @see Name
+      def name; self[:"name"]&.value; end
+      # upcall pid
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see UpcallPid
+      def upcall_pid; self[:"upcall_pid"]&.value; end
+      # @rbs return: Structs::OvsDpStats
+      # @return [Structs::OvsDpStats]
+      # @see Stats
+      def stats; self[:"stats"]&.value; end
+      # @rbs return: Structs::OvsDpMegaflowStats
+      # @return [Structs::OvsDpMegaflowStats]
+      # @see MegaflowStats
+      def megaflow_stats; self[:"megaflow_stats"]&.value; end
+      # Known flags are defined in {Flags::UserFeatures}.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see UserFeatures
+      def user_features; self[:"user_features"]&.value; end
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see MasksCacheSize
+      def masks_cache_size; self[:"masks_cache_size"]&.value; end
+      # @rbs return: ::Array[::Integer]
+      # @return [Array<Integer>]
+      # @see PerCpuPids
+      def per_cpu_pids; self[:"per_cpu_pids"]&.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
   end
   module Messages
     # Get / dump OVS data path configuration and state
-    class DoGetRequest < ::Nl::Protocols::Genl::Message
+    class DoGetRequest < ::Nl::Genl::Message
       TYPE = 3
       FIXED_HEADER = Structs::OvsHeader
       ATTRIBUTE_SET = AttributeSets::Datapath
       ATTRIBUTES = Ractor.make_shareable(%i[name])
-      # Gets the value of `dp-ifindex` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def dp_ifindex; fixed_header.dp_ifindex; end
-      # Gets the value of `name` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Datapath::Name
       def name; attributes[:"name"]&.value; end
     end
     # Get / dump OVS data path configuration and state
-    class DoGetReply < ::Nl::Protocols::Genl::Message
+    class DoGetReply < ::Nl::Genl::Message
       TYPE = 3
       FIXED_HEADER = Structs::OvsHeader
       ATTRIBUTE_SET = AttributeSets::Datapath
       ATTRIBUTES = Ractor.make_shareable(%i[name upcall_pid stats megaflow_stats user_features masks_cache_size per_cpu_pids])
-      # Gets the value of `dp-ifindex` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def dp_ifindex; fixed_header.dp_ifindex; end
-      # Gets the value of `name` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Datapath::Name
       def name; attributes[:"name"]&.value; end
-      # Gets the value of `upcall-pid` attribute in the message.
-      #--
+      # upcall pid
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Datapath::UpcallPid
       def upcall_pid; attributes[:"upcall_pid"]&.value; end
-      # Gets the value of `stats` attribute in the message.
-      #--
-      # @rbs return: ::String
+      # @rbs return: Structs::OvsDpStats
+      # @return [Structs::OvsDpStats]
+      # @see AttributeSets::Datapath::Stats
       def stats; attributes[:"stats"]&.value; end
-      # Gets the value of `megaflow-stats` attribute in the message.
-      #--
-      # @rbs return: ::String
+      # @rbs return: Structs::OvsDpMegaflowStats
+      # @return [Structs::OvsDpMegaflowStats]
+      # @see AttributeSets::Datapath::MegaflowStats
       def megaflow_stats; attributes[:"megaflow_stats"]&.value; end
-      # Gets the value of `user-features` attribute in the message.
-      #--
+      # Known flags are defined in {Flags::UserFeatures}.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Datapath::UserFeatures
       def user_features; attributes[:"user_features"]&.value; end
-      # Gets the value of `masks-cache-size` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Datapath::MasksCacheSize
       def masks_cache_size; attributes[:"masks_cache_size"]&.value; end
-      # Gets the value of `per-cpu-pids` attribute in the message.
-      #--
-      # @rbs return: ::String
+      # @rbs return: ::Array[::Integer]
+      # @return [Array<Integer>]
+      # @see AttributeSets::Datapath::PerCpuPids
       def per_cpu_pids; attributes[:"per_cpu_pids"]&.value; end
     end
     # Get / dump OVS data path configuration and state
-    class DumpGetRequest < ::Nl::Protocols::Genl::Message
+    class DumpGetRequest < ::Nl::Genl::Message
       TYPE = 3
       FIXED_HEADER = Structs::OvsHeader
       ATTRIBUTE_SET = AttributeSets::Datapath
       ATTRIBUTES = Ractor.make_shareable(%i[name])
-      # Gets the value of `dp-ifindex` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def dp_ifindex; fixed_header.dp_ifindex; end
-      # Gets the value of `name` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Datapath::Name
       def name; attributes[:"name"]&.value; end
     end
     # Get / dump OVS data path configuration and state
-    class DumpGetReply < ::Nl::Protocols::Genl::Message
+    class DumpGetReply < ::Nl::Genl::Message
       TYPE = 3
       FIXED_HEADER = Structs::OvsHeader
       ATTRIBUTE_SET = AttributeSets::Datapath
       ATTRIBUTES = Ractor.make_shareable(%i[name upcall_pid stats megaflow_stats user_features masks_cache_size per_cpu_pids])
-      # Gets the value of `dp-ifindex` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def dp_ifindex; fixed_header.dp_ifindex; end
-      # Gets the value of `name` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Datapath::Name
       def name; attributes[:"name"]&.value; end
-      # Gets the value of `upcall-pid` attribute in the message.
-      #--
+      # upcall pid
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Datapath::UpcallPid
       def upcall_pid; attributes[:"upcall_pid"]&.value; end
-      # Gets the value of `stats` attribute in the message.
-      #--
-      # @rbs return: ::String
+      # @rbs return: Structs::OvsDpStats
+      # @return [Structs::OvsDpStats]
+      # @see AttributeSets::Datapath::Stats
       def stats; attributes[:"stats"]&.value; end
-      # Gets the value of `megaflow-stats` attribute in the message.
-      #--
-      # @rbs return: ::String
+      # @rbs return: Structs::OvsDpMegaflowStats
+      # @return [Structs::OvsDpMegaflowStats]
+      # @see AttributeSets::Datapath::MegaflowStats
       def megaflow_stats; attributes[:"megaflow_stats"]&.value; end
-      # Gets the value of `user-features` attribute in the message.
-      #--
+      # Known flags are defined in {Flags::UserFeatures}.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Datapath::UserFeatures
       def user_features; attributes[:"user_features"]&.value; end
-      # Gets the value of `masks-cache-size` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Datapath::MasksCacheSize
       def masks_cache_size; attributes[:"masks_cache_size"]&.value; end
-      # Gets the value of `per-cpu-pids` attribute in the message.
-      #--
-      # @rbs return: ::String
+      # @rbs return: ::Array[::Integer]
+      # @return [Array<Integer>]
+      # @see AttributeSets::Datapath::PerCpuPids
       def per_cpu_pids; attributes[:"per_cpu_pids"]&.value; end
     end
     # Create new OVS data path
-    class DoNewRequest < ::Nl::Protocols::Genl::Message
+    class DoNewRequest < ::Nl::Genl::Message
       TYPE = 1
       FIXED_HEADER = Structs::OvsHeader
       ATTRIBUTE_SET = AttributeSets::Datapath
       ATTRIBUTES = Ractor.make_shareable(%i[name upcall_pid user_features])
-      # Gets the value of `dp-ifindex` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def dp_ifindex; fixed_header.dp_ifindex; end
-      # Gets the value of `name` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Datapath::Name
       def name; attributes[:"name"]&.value; end
-      # Gets the value of `upcall-pid` attribute in the message.
-      #--
+      # upcall pid
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Datapath::UpcallPid
       def upcall_pid; attributes[:"upcall_pid"]&.value; end
-      # Gets the value of `user-features` attribute in the message.
-      #--
+      # Known flags are defined in {Flags::UserFeatures}.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Datapath::UserFeatures
       def user_features; attributes[:"user_features"]&.value; end
     end
     # Delete existing OVS data path
-    class DoDelRequest < ::Nl::Protocols::Genl::Message
+    class DoDelRequest < ::Nl::Genl::Message
       TYPE = 2
       FIXED_HEADER = Structs::OvsHeader
       ATTRIBUTE_SET = AttributeSets::Datapath
       ATTRIBUTES = Ractor.make_shareable(%i[name])
-      # Gets the value of `dp-ifindex` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def dp_ifindex; fixed_header.dp_ifindex; end
-      # Gets the value of `name` attribute in the message.
-      #--
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Datapath::Name
       def name; attributes[:"name"]&.value; end
     end
   end
   module Notifications
   end
+  # @private
   NOTIFICATIONS = Ractor.make_shareable({}) #: Hash[::Integer, ::Class]
   # Get / dump OVS data path configuration and state
-  #--
   # @rbs (?dp_ifindex: ::Integer, ?name: ::String) -> Messages::DoGetReply
+  # @param [Hash] args
+  # @option args [Integer] dp_ifindex
+  # @option args [String] name
+  # @return [Messages::DoGetReply]
+  # @see Messages::DoGetRequest
   def do_get(**args)
     exchange_message(:"do", Messages::DoGetRequest, Messages::DoGetReply, args)
   end
   # Get / dump OVS data path configuration and state
-  #--
-  # @rbs (?dp_ifindex: ::Integer, ?name: ::String) -> Enumerable[Messages::DumpGetReply]
+  # @rbs (?dp_ifindex: ::Integer, ?name: ::String) -> Array[Messages::DumpGetReply]
   #   | (?dp_ifindex: ::Integer, ?name: ::String) { (Messages::DumpGetReply) -> void } -> void
+  # @overload dump_get(**args)
+  #   Returns an array when no block is given.
+  #   @param [Hash] args
+  #   @option args [Integer] dp_ifindex
+  #   @option args [String] name
+  #   @return [Array<Messages::DumpGetReply>]
+  # @overload dump_get(**args, &block)
+  #   Yields each reply when a block is given.
+  #   @param [Hash] args
+  #   @option args [Integer] dp_ifindex
+  #   @option args [String] name
+  #   @yieldparam [Messages::DumpGetReply] reply
+  #   @return [void]
+  # @see Messages::DumpGetRequest
   def dump_get(**args, &block)
     exchange_message(:"dump", Messages::DumpGetRequest, Messages::DumpGetReply, args, &block)
   end
   # Create new OVS data path
-  #--
   # @rbs (?dp_ifindex: ::Integer, ?name: ::String, ?upcall_pid: ::Integer, ?user_features: ::Integer) -> void
+  # @param [Hash] args
+  # @option args [Integer] dp_ifindex
+  # @option args [String] name
+  # @option args [Integer] upcall_pid upcall pid
+  # @option args [Integer] user_features Known flags are defined in {Flags::UserFeatures}.
+  # @return [void]
+  # @see Messages::DoNewRequest
   def do_new(**args)
     exchange_message(:"do", Messages::DoNewRequest, nil, args)
   end
   # Delete existing OVS data path
-  #--
   # @rbs (?dp_ifindex: ::Integer, ?name: ::String) -> void
+  # @param [Hash] args
+  # @option args [Integer] dp_ifindex
+  # @option args [String] name
+  # @return [void]
+  # @see Messages::DoDelRequest
   def do_del(**args)
     exchange_message(:"do", Messages::DoDelRequest, nil, args)
   end
   class AsyncOperations
-    # :nodoc:
+    # @private
     def initialize(&exchange)
       @exchange = exchange
     end
     # Get / dump OVS data path configuration and state
-    #--
     # @rbs (?dp_ifindex: ::Integer, ?name: ::String) -> ::Nl::Async::Future[Messages::DoGetReply]
+    # @param [Hash] args
+    # @option args [Integer] dp_ifindex
+    # @option args [String] name
+    # @return [Nl::Async::Future<Messages::DoGetReply>]
+    # @see Messages::DoGetRequest
     def do_get(**args)
       @exchange.call(:"do", Messages::DoGetRequest, Messages::DoGetReply, args)
     end
     # Get / dump OVS data path configuration and state
-    #--
     # @rbs (?dp_ifindex: ::Integer, ?name: ::String) -> ::Nl::Async::Stream[Messages::DumpGetReply]
+    # @param [Hash] args
+    # @option args [Integer] dp_ifindex
+    # @option args [String] name
+    # @return [Nl::Async::Stream<Messages::DumpGetReply>]
+    # @see Messages::DumpGetRequest
     def dump_get(**args)
       @exchange.call(:"dump", Messages::DumpGetRequest, Messages::DumpGetReply, args)
     end
     # Create new OVS data path
-    #--
     # @rbs (?dp_ifindex: ::Integer, ?name: ::String, ?upcall_pid: ::Integer, ?user_features: ::Integer) -> ::Nl::Async::Future[void]
+    # @param [Hash] args
+    # @option args [Integer] dp_ifindex
+    # @option args [String] name
+    # @option args [Integer] upcall_pid upcall pid
+    # @option args [Integer] user_features Known flags are defined in {Flags::UserFeatures}.
+    # @return [Nl::Async::Future<void>]
+    # @see Messages::DoNewRequest
     def do_new(**args)
       @exchange.call(:"do", Messages::DoNewRequest, nil, args)
     end
     # Delete existing OVS data path
-    #--
     # @rbs (?dp_ifindex: ::Integer, ?name: ::String) -> ::Nl::Async::Future[void]
+    # @param [Hash] args
+    # @option args [Integer] dp_ifindex
+    # @option args [String] name
+    # @return [Nl::Async::Future<void>]
+    # @see Messages::DoDelRequest
     def do_del(**args)
       @exchange.call(:"do", Messages::DoDelRequest, nil, args)
     end
   end
   # Returns the asynchronous operation facade for this family.
-  #--
   # @rbs (?stream_capacity: ::Integer?) -> AsyncOperations
+  # @param [::Integer, nil] stream_capacity
+  # @return [AsyncOperations]
   def async(stream_capacity: nil)
     return @async_operations ||= build_async_facade(AsyncOperations) if stream_capacity.nil?
     build_async_facade(AsyncOperations, stream_capacity:)
   end
-  #--
   # @rbs (*(:ovs_datapath) groups) -> self
+  # @param [Array<:ovs_datapath>] groups
+  # @return [self]
   def subscribe(*groups) = super
-  #--
   # @rbs (*(:ovs_datapath) groups) -> self
+  # @param [Array<:ovs_datapath>] groups
+  # @return [self]
   def unsubscribe(*groups) = super
 end
 end; end