nl-linux 0.3.0 → 0.4.1

data/generated/nl/linux/lockd.rb

@@ -3,51 +3,90 @@
 # This file is based on Documentation/netlink/specs/lockd.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
 # lockd configuration over generic netlink
-class Lockd < ::Nl::Family
+class Lockd < ::Nl::Genl::Family
   NAME = "lockd"
-  PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Genl.new("lockd"))
+  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 [Lockd]
+  # @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 [Lockd] 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 Structs
   end
   module AttributeSets
-    class Server < ::Nl::Protocols::Genl::AttributeSet
+    class Server < ::Nl::AttributeSet
       # Abstract class
-      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      class Attribute < ::Nl::AttributeSet::Attribute
       end
       class Gracetime < Attribute
         TYPE = 1
         NAME = :"gracetime"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 0
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
       class TcpPort < Attribute
         TYPE = 2
         NAME = :"tcp_port"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U16, check: nil)
+        # @private
+        ORDER = 1
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U16, check: nil)
       end
       class UdpPort < Attribute
         TYPE = 3
         NAME = :"udp_port"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U16, check: nil)
+        # @private
+        ORDER = 2
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U16, check: nil)
       end
-      # :nodoc:
+      # @private
       BY_NAME = Ractor.make_shareable({:"gracetime" => Gracetime, :"tcp_port" => TcpPort, :"udp_port" => UdpPort}) #: Hash[::Symbol, Attribute]
-      # :nodoc:
+      # @private
       BY_TYPE = Ractor.make_shareable({1 => Gracetime, 2 => TcpPort, 3 => UdpPort}) #: Hash[::Integer, Attribute]
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Gracetime
+      def gracetime; self[:"gracetime"]&.value; end
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see TcpPort
+      def tcp_port; self[:"tcp_port"]&.value; end
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see UdpPort
+      def udp_port; self[:"udp_port"]&.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
@@ -56,91 +95,107 @@ class Lockd < ::Nl::Family
     # set the lockd server parameters
     # 
     # Requires CAP_NET_ADMIN in the initial user namespace.
-    class DoServerSetRequest < ::Nl::Protocols::Genl::Message
+    class DoServerSetRequest < ::Nl::Genl::Message
       TYPE = 1
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::Server
       ATTRIBUTES = Ractor.make_shareable(%i[gracetime tcp_port udp_port])
-      # Gets the value of `gracetime` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Server::Gracetime
       def gracetime; attributes[:"gracetime"]&.value; end
-      # Gets the value of `tcp-port` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Server::TcpPort
       def tcp_port; attributes[:"tcp_port"]&.value; end
-      # Gets the value of `udp-port` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Server::UdpPort
       def udp_port; attributes[:"udp_port"]&.value; end
     end
     # get the lockd server parameters
-    class DoServerGetRequest < ::Nl::Protocols::Genl::Message
+    class DoServerGetRequest < ::Nl::Genl::Message
       TYPE = 2
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::Server
       ATTRIBUTES = Ractor.make_shareable(%i[])
     end
     # get the lockd server parameters
-    class DoServerGetReply < ::Nl::Protocols::Genl::Message
+    class DoServerGetReply < ::Nl::Genl::Message
       TYPE = 2
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::Server
       ATTRIBUTES = Ractor.make_shareable(%i[gracetime tcp_port udp_port])
-      # Gets the value of `gracetime` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Server::Gracetime
       def gracetime; attributes[:"gracetime"]&.value; end
-      # Gets the value of `tcp-port` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Server::TcpPort
       def tcp_port; attributes[:"tcp_port"]&.value; end
-      # Gets the value of `udp-port` attribute in the message.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Server::UdpPort
       def udp_port; attributes[:"udp_port"]&.value; end
     end
   end
   module Notifications
   end
+  # @private
   NOTIFICATIONS = Ractor.make_shareable({}) #: Hash[::Integer, ::Class]
   # set the lockd server parameters
   # 
   # Requires CAP_NET_ADMIN in the initial user namespace.
-  #--
   # @rbs (?gracetime: ::Integer, ?tcp_port: ::Integer, ?udp_port: ::Integer) -> void
+  # @param [Hash] args
+  # @option args [Integer] gracetime
+  # @option args [Integer] tcp_port
+  # @option args [Integer] udp_port
+  # @return [void]
+  # @see Messages::DoServerSetRequest
   def do_server_set(**args)
     exchange_message(:"do", Messages::DoServerSetRequest, nil, args)
   end
   # get the lockd server parameters
-  #--
   # @rbs () -> Messages::DoServerGetReply
+  # @param [Hash] args
+  # @return [Messages::DoServerGetReply]
+  # @see Messages::DoServerGetRequest
   def do_server_get(**args)
     exchange_message(:"do", Messages::DoServerGetRequest, Messages::DoServerGetReply, args)
   end
   class AsyncOperations
-    # :nodoc:
+    # @private
     def initialize(&exchange)
       @exchange = exchange
     end
     # set the lockd server parameters
     # 
     # Requires CAP_NET_ADMIN in the initial user namespace.
-    #--
     # @rbs (?gracetime: ::Integer, ?tcp_port: ::Integer, ?udp_port: ::Integer) -> ::Nl::Async::Future[void]
+    # @param [Hash] args
+    # @option args [Integer] gracetime
+    # @option args [Integer] tcp_port
+    # @option args [Integer] udp_port
+    # @return [Nl::Async::Future<void>]
+    # @see Messages::DoServerSetRequest
     def do_server_set(**args)
       @exchange.call(:"do", Messages::DoServerSetRequest, nil, args)
     end
     # get the lockd server parameters
-    #--
     # @rbs () -> ::Nl::Async::Future[Messages::DoServerGetReply]
+    # @param [Hash] args
+    # @return [Nl::Async::Future<Messages::DoServerGetReply>]
+    # @see Messages::DoServerGetRequest
     def do_server_get(**args)
       @exchange.call(:"do", Messages::DoServerGetRequest, Messages::DoServerGetReply, 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:)