nl-linux 0.3.0 → 0.4.1

data/generated/nl/linux/handshake.rb

@@ -10,321 +10,499 @@
 #
 #--
 # frozen_string_literal: true
-# rbs_inline: enabled
 # This code is generated by Ynl::Generator. DO NOT EDIT.
 require 'nl'
 module Nl; module Linux
 # Netlink protocol to request a transport layer security handshake.
-class Handshake < ::Nl::Family
+class Handshake < ::Nl::Genl::Family
   NAME = "handshake"
-  PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Genl.new("handshake"))
+  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 [Handshake]
+  # @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 [Handshake] 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({:"none" => ::Nl::McastGroup.new("none", nil), :"tlshd" => ::Nl::McastGroup.new("tlshd", nil)}) #: Hash[::Symbol, ::Nl::McastGroup]
+  module Constants
+    MAX_ERRNO = 4095
+  end
+  module Enums
+    module HandlerClass
+      None = 0
+      Tlshd = 1
+      Max = 2
+    end
+    module MsgType
+      Unspec = 0
+      Clienthello = 1
+      Serverhello = 2
+    end
+    module Auth
+      Unspec = 0
+      Unauth = 1
+      Psk = 2
+      X509 = 3
+    end
+  end
   module Structs
   end
   module AttributeSets
-    class X509 < ::Nl::Protocols::Genl::AttributeSet
+    class X509 < ::Nl::AttributeSet
       # Abstract class
-      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      class Attribute < ::Nl::AttributeSet::Attribute
       end
       class Cert < Attribute
         TYPE = 1
         NAME = :"cert"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::S32, check: nil)
+        # @private
+        ORDER = 0
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::S32, check: nil)
       end
       class Privkey < Attribute
         TYPE = 2
         NAME = :"privkey"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::S32, check: nil)
+        # @private
+        ORDER = 1
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::S32, check: nil)
       end
-      # :nodoc:
+      # @private
       BY_NAME = Ractor.make_shareable({:"cert" => Cert, :"privkey" => Privkey}) #: Hash[::Symbol, Attribute]
-      # :nodoc:
+      # @private
       BY_TYPE = Ractor.make_shareable({1 => Cert, 2 => Privkey}) #: Hash[::Integer, Attribute]
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Cert
+      def cert; self[:"cert"]&.value; end
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Privkey
+      def privkey; self[:"privkey"]&.value; end
       class << self
         # Looks up Attribute class by name.
-        #--
         # @rbs name: Symbol
         # @rbs return: Attribute
+        # @param [Symbol] name
+        # @return [Attribute]
         def by_name(name); BY_NAME.fetch(name); end
         # Looks up Attribute class by type value.
-        #--
         # @rbs type: Integer
         # @rbs return: Attribute
+        # @param [Integer] type
+        # @return [Attribute]
         def by_type(type); BY_TYPE.fetch(type); end
       end
     end
-    class Accept < ::Nl::Protocols::Genl::AttributeSet
+    class Accept < ::Nl::AttributeSet
       # Abstract class
-      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      class Attribute < ::Nl::AttributeSet::Attribute
       end
       class Sockfd < Attribute
         TYPE = 1
         NAME = :"sockfd"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::S32, check: nil)
+        # @private
+        ORDER = 0
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::S32, check: nil)
       end
+      # Known enum values are defined in {Enums::HandlerClass}.
       class HandlerClass < Attribute
         TYPE = 2
         NAME = :"handler_class"
-        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
+      # Known enum values are defined in {Enums::MsgType}.
       class MessageType < Attribute
         TYPE = 3
         NAME = :"message_type"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 2
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
       class Timeout < Attribute
         TYPE = 4
         NAME = :"timeout"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 3
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
+      # Known enum values are defined in {Enums::Auth}.
       class AuthMode < Attribute
         TYPE = 5
         NAME = :"auth_mode"
-        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 PeerIdentity < Attribute
         TYPE = 6
         NAME = :"peer_identity"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        MULTI = true
+        # @private
+        ORDER = 5
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
       class Certificate < Attribute
         TYPE = 7
         NAME = :"certificate"
+        # @private
+        MULTI = true
+        # @private
+        ORDER = 6
       end
       class Peername < Attribute
         TYPE = 8
         NAME = :"peername"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::String.new(check: nil)
+        # @private
+        ORDER = 7
+        # @private
+        DATATYPE = ::Nl::DataTypes::String.new(check: nil)
       end
       class Keyring < Attribute
         TYPE = 9
         NAME = :"keyring"
-        DATATYPE = ::Nl::Protocols::Genl::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
-      # :nodoc:
+      # @private
       BY_NAME = Ractor.make_shareable({:"sockfd" => Sockfd, :"handler_class" => HandlerClass, :"message_type" => MessageType, :"timeout" => Timeout, :"auth_mode" => AuthMode, :"peer_identity" => PeerIdentity, :"certificate" => Certificate, :"peername" => Peername, :"keyring" => Keyring}) #: Hash[::Symbol, Attribute]
-      # :nodoc:
+      # @private
       BY_TYPE = Ractor.make_shareable({1 => Sockfd, 2 => HandlerClass, 3 => MessageType, 4 => Timeout, 5 => AuthMode, 6 => PeerIdentity, 7 => Certificate, 8 => Peername, 9 => Keyring}) #: Hash[::Integer, Attribute]
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Sockfd
+      def sockfd; self[:"sockfd"]&.value; end
+      # Known enum values are defined in {Enums::HandlerClass}.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see HandlerClass
+      def handler_class; self[:"handler_class"]&.value; end
+      # Known enum values are defined in {Enums::MsgType}.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see MessageType
+      def message_type; self[:"message_type"]&.value; end
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Timeout
+      def timeout; self[:"timeout"]&.value; end
+      # Known enum values are defined in {Enums::Auth}.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AuthMode
+      def auth_mode; self[:"auth_mode"]&.value; end
+      # @rbs return: ::Array[::Integer]
+      # @return [Array<Integer>]
+      # @see PeerIdentity
+      def peer_identity; self[:"peer_identity"].map(&:value); end
+      # @rbs return: ::Array[AttributeSets::X509]
+      # @return [Array<AttributeSets::X509>]
+      # @see Certificate
+      def certificate; self[:"certificate"].map(&:value); end
+      # @rbs return: ::String
+      # @return [String]
+      # @see Peername
+      def peername; self[:"peername"]&.value; end
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Keyring
+      def keyring; self[:"keyring"]&.value; end
       class << self
         # Looks up Attribute class by name.
-        #--
         # @rbs name: Symbol
         # @rbs return: Attribute
+        # @param [Symbol] name
+        # @return [Attribute]
         def by_name(name); BY_NAME.fetch(name); end
         # Looks up Attribute class by type value.
-        #--
         # @rbs type: Integer
         # @rbs return: Attribute
+        # @param [Integer] type
+        # @return [Attribute]
         def by_type(type); BY_TYPE.fetch(type); end
       end
     end
-    class Done < ::Nl::Protocols::Genl::AttributeSet
+    class Done < ::Nl::AttributeSet
       # Abstract class
-      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      class Attribute < ::Nl::AttributeSet::Attribute
       end
       class Status < Attribute
         TYPE = 1
         NAME = :"status"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: -> { raise ArgumentError, "Value #{it.inspect} is greater than maximum 4095" unless it <= 4095 })
+        # @private
+        ORDER = 0
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: -> { raise ArgumentError, "Value #{it.inspect} is greater than maximum #{Constants::MAX_ERRNO}" unless it <= Constants::MAX_ERRNO })
       end
       class Sockfd < Attribute
         TYPE = 2
         NAME = :"sockfd"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::S32, check: nil)
+        # @private
+        ORDER = 1
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::S32, check: nil)
       end
       class RemoteAuth < Attribute
         TYPE = 3
         NAME = :"remote_auth"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        MULTI = true
+        # @private
+        ORDER = 2
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
-      # :nodoc:
+      # @private
       BY_NAME = Ractor.make_shareable({:"status" => Status, :"sockfd" => Sockfd, :"remote_auth" => RemoteAuth}) #: Hash[::Symbol, Attribute]
-      # :nodoc:
+      # @private
       BY_TYPE = Ractor.make_shareable({1 => Status, 2 => Sockfd, 3 => RemoteAuth}) #: Hash[::Integer, Attribute]
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Status
+      def status; self[:"status"]&.value; end
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Sockfd
+      def sockfd; self[:"sockfd"]&.value; end
+      # @rbs return: ::Array[::Integer]
+      # @return [Array<Integer>]
+      # @see RemoteAuth
+      def remote_auth; self[:"remote_auth"].map(&: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
-    Accept::Certificate::DATATYPE = ::Nl::Protocols::Genl::DataTypes::NestedAttributes.new(X509)
+    # @private
+    Accept::Certificate::DATATYPE = ::Nl::DataTypes::NestedAttributes.new(AttributeSets::X509, selector_bindings: Ractor.make_shareable([]))
   end
   module Messages
     # Handler retrieves next queued handshake request
     # 
     # Requires CAP_NET_ADMIN in the initial user namespace.
-    class DoAcceptRequest < ::Nl::Protocols::Genl::Message
+    class DoAcceptRequest < ::Nl::Genl::Message
       TYPE = 2
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::Accept
       ATTRIBUTES = Ractor.make_shareable(%i[handler_class])
-      # Gets the value of `handler-class` attribute in the message.
-      #--
+      # Known enum values are defined in {Enums::HandlerClass}.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Accept::HandlerClass
       def handler_class; attributes[:"handler_class"]&.value; end
     end
     # Handler retrieves next queued handshake request
     # 
     # Requires CAP_NET_ADMIN in the initial user namespace.
-    class DoAcceptReply < ::Nl::Protocols::Genl::Message
+    class DoAcceptReply < ::Nl::Genl::Message
       TYPE = 2
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::Accept
       ATTRIBUTES = Ractor.make_shareable(%i[sockfd message_type timeout auth_mode peer_identity certificate peername keyring])
-      # Gets the value of `sockfd` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Accept::Sockfd
       def sockfd; attributes[:"sockfd"]&.value; end
-      # Gets the value of `message-type` attribute in the message.
-      #--
+      # Known enum values are defined in {Enums::MsgType}.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Accept::MessageType
       def message_type; attributes[:"message_type"]&.value; end
-      # Gets the value of `timeout` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Accept::Timeout
       def timeout; attributes[:"timeout"]&.value; end
-      # Gets the value of `auth-mode` attribute in the message.
-      #--
+      # Known enum values are defined in {Enums::Auth}.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Accept::AuthMode
       def auth_mode; attributes[:"auth_mode"]&.value; end
-      # Gets the value of `peer-identity` attribute in the message.
-      #--
-      # @rbs return: ::Integer
-      def peer_identity; attributes[:"peer_identity"]&.value; end
-      # Gets the value of `certificate` attribute in the message.
-      #--
-      # @rbs return: AttributeSets::X509
-      def certificate; attributes[:"certificate"]&.value; end
-      # Gets the value of `peername` attribute in the message.
-      #--
+      # @rbs return: ::Array[::Integer]
+      # @return [Array<Integer>]
+      # @see AttributeSets::Accept::PeerIdentity
+      def peer_identity; attributes[:"peer_identity"].map(&:value); end
+      # @rbs return: ::Array[AttributeSets::X509]
+      # @return [Array<AttributeSets::X509>]
+      # @see AttributeSets::Accept::Certificate
+      def certificate; attributes[:"certificate"].map(&:value); end
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Accept::Peername
       def peername; attributes[:"peername"]&.value; end
-      # Gets the value of `keyring` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Accept::Keyring
       def keyring; attributes[:"keyring"]&.value; end
     end
     # Handler reports handshake completion
     # 
     # Requires CAP_NET_ADMIN in the initial user namespace.
-    class DoDoneRequest < ::Nl::Protocols::Genl::Message
+    class DoDoneRequest < ::Nl::Genl::Message
       TYPE = 3
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::Done
       ATTRIBUTES = Ractor.make_shareable(%i[status sockfd remote_auth])
-      # Gets the value of `status` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Done::Status
       def status; attributes[:"status"]&.value; end
-      # Gets the value of `sockfd` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Done::Sockfd
       def sockfd; attributes[:"sockfd"]&.value; end
-      # Gets the value of `remote-auth` attribute in the message.
-      #--
-      # @rbs return: ::Integer
-      def remote_auth; attributes[:"remote_auth"]&.value; end
+      # @rbs return: ::Array[::Integer]
+      # @return [Array<Integer>]
+      # @see AttributeSets::Done::RemoteAuth
+      def remote_auth; attributes[:"remote_auth"].map(&:value); end
     end
   end
   module Notifications
     # Notify handlers that a new handshake request is waiting
-    class Ready < ::Nl::Protocols::Genl::Message
+    class Ready < ::Nl::Genl::Message
       TYPE = 1
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::Accept
       ATTRIBUTES = Ractor.make_shareable(%i[sockfd message_type timeout auth_mode peer_identity certificate peername keyring])
-      # Gets the value of `sockfd` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Accept::Sockfd
       def sockfd; attributes[:"sockfd"]&.value; end
-      # Gets the value of `message-type` attribute in the message.
-      #--
+      # Known enum values are defined in {Enums::MsgType}.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Accept::MessageType
       def message_type; attributes[:"message_type"]&.value; end
-      # Gets the value of `timeout` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Accept::Timeout
       def timeout; attributes[:"timeout"]&.value; end
-      # Gets the value of `auth-mode` attribute in the message.
-      #--
+      # Known enum values are defined in {Enums::Auth}.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Accept::AuthMode
       def auth_mode; attributes[:"auth_mode"]&.value; end
-      # Gets the value of `peer-identity` attribute in the message.
-      #--
-      # @rbs return: ::Integer
-      def peer_identity; attributes[:"peer_identity"]&.value; end
-      # Gets the value of `certificate` attribute in the message.
-      #--
-      # @rbs return: AttributeSets::X509
-      def certificate; attributes[:"certificate"]&.value; end
-      # Gets the value of `peername` attribute in the message.
-      #--
+      # @rbs return: ::Array[::Integer]
+      # @return [Array<Integer>]
+      # @see AttributeSets::Accept::PeerIdentity
+      def peer_identity; attributes[:"peer_identity"].map(&:value); end
+      # @rbs return: ::Array[AttributeSets::X509]
+      # @return [Array<AttributeSets::X509>]
+      # @see AttributeSets::Accept::Certificate
+      def certificate; attributes[:"certificate"].map(&:value); end
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Accept::Peername
       def peername; attributes[:"peername"]&.value; end
-      # Gets the value of `keyring` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Accept::Keyring
       def keyring; attributes[:"keyring"]&.value; end
     end
   end
+  # @private
   NOTIFICATIONS = Ractor.make_shareable({1 => Notifications::Ready}) #: Hash[::Integer, ::Class]
   # Handler retrieves next queued handshake request
   # 
   # Requires CAP_NET_ADMIN in the initial user namespace.
-  #--
   # @rbs (?handler_class: ::Integer) -> Messages::DoAcceptReply
+  # @param [Hash] args
+  # @option args [Integer] handler_class Known enum values are defined in {Enums::HandlerClass}.
+  # @return [Messages::DoAcceptReply]
+  # @see Messages::DoAcceptRequest
   def do_accept(**args)
     exchange_message(:"do", Messages::DoAcceptRequest, Messages::DoAcceptReply, args)
   end
   # Handler reports handshake completion
   # 
   # Requires CAP_NET_ADMIN in the initial user namespace.
-  #--
-  # @rbs (?status: ::Integer, ?sockfd: ::Integer, ?remote_auth: ::Integer) -> void
+  # @rbs (?status: ::Integer, ?sockfd: ::Integer, ?remote_auth: ::Array[::Integer]) -> void
+  # @param [Hash] args
+  # @option args [Integer] status
+  # @option args [Integer] sockfd
+  # @option args [Array<Integer>] remote_auth
+  # @return [void]
+  # @see Messages::DoDoneRequest
   def do_done(**args)
     exchange_message(:"do", Messages::DoDoneRequest, nil, args)
   end
   class AsyncOperations
-    # :nodoc:
+    # @private
     def initialize(&exchange)
       @exchange = exchange
     end
     # Handler retrieves next queued handshake request
     # 
     # Requires CAP_NET_ADMIN in the initial user namespace.
-    #--
     # @rbs (?handler_class: ::Integer) -> ::Nl::Async::Future[Messages::DoAcceptReply]
+    # @param [Hash] args
+    # @option args [Integer] handler_class Known enum values are defined in {Enums::HandlerClass}.
+    # @return [Nl::Async::Future<Messages::DoAcceptReply>]
+    # @see Messages::DoAcceptRequest
     def do_accept(**args)
       @exchange.call(:"do", Messages::DoAcceptRequest, Messages::DoAcceptReply, args)
     end
     # Handler reports handshake completion
     # 
     # Requires CAP_NET_ADMIN in the initial user namespace.
-    #--
-    # @rbs (?status: ::Integer, ?sockfd: ::Integer, ?remote_auth: ::Integer) -> ::Nl::Async::Future[void]
+    # @rbs (?status: ::Integer, ?sockfd: ::Integer, ?remote_auth: ::Array[::Integer]) -> ::Nl::Async::Future[void]
+    # @param [Hash] args
+    # @option args [Integer] status
+    # @option args [Integer] sockfd
+    # @option args [Array<Integer>] remote_auth
+    # @return [Nl::Async::Future<void>]
+    # @see Messages::DoDoneRequest
     def do_done(**args)
       @exchange.call(:"do", Messages::DoDoneRequest, 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 (*(:none | :tlshd) groups) -> self
+  # @param [Array<:none, :tlshd>] groups
+  # @return [self]
   def subscribe(*groups) = super
-  #--
   # @rbs (*(:none | :tlshd) groups) -> self
+  # @param [Array<:none, :tlshd>] groups
+  # @return [self]
   def unsubscribe(*groups) = super
 end
 end; end