nl-linux 0.3.0 → 0.4.1

data/sig/generated/nl/linux/sunrpc_cache.rbs

@@ -0,0 +1,739 @@
+# Generated from generated/nl/linux/sunrpc_cache.rb with RBS::Inline
+
+module Nl
+  module Linux
+    # SUNRPC cache upcall support over generic netlink.
+    class Sunrpc < ::Nl::Genl::Family
+      NAME: ::String
+
+      VERSION: ::Integer
+
+      # @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 [Sunrpc]
+      # @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 [Sunrpc] family
+      #   @return [Object] the result of the block
+      def self.open: (?resolver: ^(::Nl::Genl::Client, ::String) -> ::Nl::Genl::FamilyInfo, ?executor: executor?, ?notification_capacity: ::Integer?) -> (::Nl::Family::Session & instance)
+
+      # @private
+      MCAST_GROUPS: Hash[::Symbol, ::Nl::McastGroup]
+
+      module Flags
+        module CacheType
+          IpMap: ::Integer
+
+          UnixGid: ::Integer
+        end
+      end
+
+      module Structs
+      end
+
+      module AttributeSets
+        class CacheNotify < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          # Known flags are defined in {Flags::CacheType}.
+          class CacheType < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # @private
+          BY_NAME: Hash[::Symbol, Attribute]
+
+          # @private
+          BY_TYPE: Hash[::Integer, Attribute]
+
+          # Known flags are defined in {Flags::CacheType}.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see CacheType
+          def cache_type: () -> ::Integer
+
+          # Looks up Attribute class by name.
+          # @rbs name: Symbol
+          # @rbs return: Attribute
+          # @param [Symbol] name
+          # @return [Attribute]
+          def self.by_name: (Symbol name) -> Attribute
+
+          # Looks up Attribute class by type value.
+          # @rbs type: Integer
+          # @rbs return: Attribute
+          # @param [Integer] type
+          # @return [Attribute]
+          def self.by_type: (Integer type) -> Attribute
+        end
+
+        class IpMap < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          class Seqno < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Class < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Addr < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Domain < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Negative < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Expiry < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # @private
+          BY_NAME: Hash[::Symbol, Attribute]
+
+          # @private
+          BY_TYPE: Hash[::Integer, Attribute]
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Seqno
+          def seqno: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see Class
+          def class: () -> ::String
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see Addr
+          def addr: () -> ::String
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see Domain
+          def domain: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Negative
+          def negative: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Expiry
+          def expiry: () -> ::Integer
+
+          # Looks up Attribute class by name.
+          # @rbs name: Symbol
+          # @rbs return: Attribute
+          # @param [Symbol] name
+          # @return [Attribute]
+          def self.by_name: (Symbol name) -> Attribute
+
+          # Looks up Attribute class by type value.
+          # @rbs type: Integer
+          # @rbs return: Attribute
+          # @param [Integer] type
+          # @return [Attribute]
+          def self.by_type: (Integer type) -> Attribute
+        end
+
+        class IpMapReqs < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          class Requests < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            MULTI: bool
+
+            # @private
+            ORDER: ::Integer
+          end
+
+          # @private
+          BY_NAME: Hash[::Symbol, Attribute]
+
+          # @private
+          BY_TYPE: Hash[::Integer, Attribute]
+
+          # @rbs return: ::Array[AttributeSets::IpMap]
+          # @return [Array<AttributeSets::IpMap>]
+          # @see Requests
+          def requests: () -> ::Array[AttributeSets::IpMap]
+
+          # Looks up Attribute class by name.
+          # @rbs name: Symbol
+          # @rbs return: Attribute
+          # @param [Symbol] name
+          # @return [Attribute]
+          def self.by_name: (Symbol name) -> Attribute
+
+          # Looks up Attribute class by type value.
+          # @rbs type: Integer
+          # @rbs return: Attribute
+          # @param [Integer] type
+          # @return [Attribute]
+          def self.by_type: (Integer type) -> Attribute
+        end
+
+        class UnixGid < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          class Seqno < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Uid < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Gids < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            MULTI: bool
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Negative < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Expiry < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # @private
+          BY_NAME: Hash[::Symbol, Attribute]
+
+          # @private
+          BY_TYPE: Hash[::Integer, Attribute]
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Seqno
+          def seqno: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Uid
+          def uid: () -> ::Integer
+
+          # @rbs return: ::Array[::Integer]
+          # @return [Array<Integer>]
+          # @see Gids
+          def gids: () -> ::Array[::Integer]
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Negative
+          def negative: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Expiry
+          def expiry: () -> ::Integer
+
+          # Looks up Attribute class by name.
+          # @rbs name: Symbol
+          # @rbs return: Attribute
+          # @param [Symbol] name
+          # @return [Attribute]
+          def self.by_name: (Symbol name) -> Attribute
+
+          # Looks up Attribute class by type value.
+          # @rbs type: Integer
+          # @rbs return: Attribute
+          # @param [Integer] type
+          # @return [Attribute]
+          def self.by_type: (Integer type) -> Attribute
+        end
+
+        class UnixGidReqs < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          class Requests < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            MULTI: bool
+
+            # @private
+            ORDER: ::Integer
+          end
+
+          # @private
+          BY_NAME: Hash[::Symbol, Attribute]
+
+          # @private
+          BY_TYPE: Hash[::Integer, Attribute]
+
+          # @rbs return: ::Array[AttributeSets::UnixGid]
+          # @return [Array<AttributeSets::UnixGid>]
+          # @see Requests
+          def requests: () -> ::Array[AttributeSets::UnixGid]
+
+          # Looks up Attribute class by name.
+          # @rbs name: Symbol
+          # @rbs return: Attribute
+          # @param [Symbol] name
+          # @return [Attribute]
+          def self.by_name: (Symbol name) -> Attribute
+
+          # Looks up Attribute class by type value.
+          # @rbs type: Integer
+          # @rbs return: Attribute
+          # @param [Integer] type
+          # @return [Attribute]
+          def self.by_type: (Integer type) -> Attribute
+        end
+
+        class CacheFlush < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          # Known flags are defined in {Flags::CacheType}.
+          class Mask < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # @private
+          BY_NAME: Hash[::Symbol, Attribute]
+
+          # @private
+          BY_TYPE: Hash[::Integer, Attribute]
+
+          # Known flags are defined in {Flags::CacheType}.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Mask
+          def mask: () -> ::Integer
+
+          # Looks up Attribute class by name.
+          # @rbs name: Symbol
+          # @rbs return: Attribute
+          # @param [Symbol] name
+          # @return [Attribute]
+          def self.by_name: (Symbol name) -> Attribute
+
+          # Looks up Attribute class by type value.
+          # @rbs type: Integer
+          # @rbs return: Attribute
+          # @param [Integer] type
+          # @return [Attribute]
+          def self.by_type: (Integer type) -> Attribute
+        end
+      end
+
+      module Messages
+        # Dump all pending ip_map requests
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        class DumpIpMapGetReqsRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+        end
+
+        # Dump all pending ip_map requests
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        class DumpIpMapGetReqsReply < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Array[AttributeSets::IpMap]
+          # @return [Array<AttributeSets::IpMap>]
+          # @see AttributeSets::IpMapReqs::Requests
+          def requests: () -> ::Array[AttributeSets::IpMap]
+        end
+
+        # Respond to one or more ip_map requests
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        class DoIpMapSetReqsRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Array[AttributeSets::IpMap]
+          # @return [Array<AttributeSets::IpMap>]
+          # @see AttributeSets::IpMapReqs::Requests
+          def requests: () -> ::Array[AttributeSets::IpMap]
+        end
+
+        # Dump all pending unix_gid requests
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        class DumpUnixGidGetReqsRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+        end
+
+        # Dump all pending unix_gid requests
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        class DumpUnixGidGetReqsReply < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Array[AttributeSets::UnixGid]
+          # @return [Array<AttributeSets::UnixGid>]
+          # @see AttributeSets::UnixGidReqs::Requests
+          def requests: () -> ::Array[AttributeSets::UnixGid]
+        end
+
+        # Respond to one or more unix_gid requests
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        class DoUnixGidSetReqsRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Array[AttributeSets::UnixGid]
+          # @return [Array<AttributeSets::UnixGid>]
+          # @see AttributeSets::UnixGidReqs::Requests
+          def requests: () -> ::Array[AttributeSets::UnixGid]
+        end
+
+        # Flush sunrpc caches (ip_map and/or unix_gid)
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        class DoCacheFlushRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # Known flags are defined in {Flags::CacheType}.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::CacheFlush::Mask
+          def mask: () -> ::Integer
+        end
+      end
+
+      module Notifications
+        # Notification that there are cache requests that need servicing
+        #
+        # Multicast group: `exportd`.
+        class CacheNotify < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # Known flags are defined in {Flags::CacheType}.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::CacheNotify::CacheType
+          def cache_type: () -> ::Integer
+        end
+      end
+
+      # @private
+      NOTIFICATIONS: Hash[::Integer, ::Class]
+
+      # Dump all pending ip_map requests
+      #
+      # Requires CAP_NET_ADMIN in the initial user namespace.
+      # @rbs () -> Array[Messages::DumpIpMapGetReqsReply]
+      #   | () { (Messages::DumpIpMapGetReqsReply) -> void } -> void
+      # @overload dump_ip_map_get_reqs(**args)
+      #   Returns an array when no block is given.
+      #   @param [Hash] args
+      #   @return [Array<Messages::DumpIpMapGetReqsReply>]
+      # @overload dump_ip_map_get_reqs(**args, &block)
+      #   Yields each reply when a block is given.
+      #   @param [Hash] args
+      #   @yieldparam [Messages::DumpIpMapGetReqsReply] reply
+      #   @return [void]
+      # @see Messages::DumpIpMapGetReqsRequest
+      def dump_ip_map_get_reqs: () -> Array[Messages::DumpIpMapGetReqsReply]
+                              | () { (Messages::DumpIpMapGetReqsReply) -> void } -> void
+
+      # Respond to one or more ip_map requests
+      #
+      # Requires CAP_NET_ADMIN in the initial user namespace.
+      # @rbs (?requests: ::Array[(AttributeSets::IpMap | ::Hash[::Symbol, untyped])]) -> void
+      # @param [Hash] args
+      # @option args [Array<AttributeSets::IpMap, Hash<Symbol, Object>>] requests
+      # @return [void]
+      # @see Messages::DoIpMapSetReqsRequest
+      def do_ip_map_set_reqs: (?requests: ::Array[AttributeSets::IpMap | ::Hash[::Symbol, untyped]]) -> void
+
+      # Dump all pending unix_gid requests
+      #
+      # Requires CAP_NET_ADMIN in the initial user namespace.
+      # @rbs () -> Array[Messages::DumpUnixGidGetReqsReply]
+      #   | () { (Messages::DumpUnixGidGetReqsReply) -> void } -> void
+      # @overload dump_unix_gid_get_reqs(**args)
+      #   Returns an array when no block is given.
+      #   @param [Hash] args
+      #   @return [Array<Messages::DumpUnixGidGetReqsReply>]
+      # @overload dump_unix_gid_get_reqs(**args, &block)
+      #   Yields each reply when a block is given.
+      #   @param [Hash] args
+      #   @yieldparam [Messages::DumpUnixGidGetReqsReply] reply
+      #   @return [void]
+      # @see Messages::DumpUnixGidGetReqsRequest
+      def dump_unix_gid_get_reqs: () -> Array[Messages::DumpUnixGidGetReqsReply]
+                                | () { (Messages::DumpUnixGidGetReqsReply) -> void } -> void
+
+      # Respond to one or more unix_gid requests
+      #
+      # Requires CAP_NET_ADMIN in the initial user namespace.
+      # @rbs (?requests: ::Array[(AttributeSets::UnixGid | ::Hash[::Symbol, untyped])]) -> void
+      # @param [Hash] args
+      # @option args [Array<AttributeSets::UnixGid, Hash<Symbol, Object>>] requests
+      # @return [void]
+      # @see Messages::DoUnixGidSetReqsRequest
+      def do_unix_gid_set_reqs: (?requests: ::Array[AttributeSets::UnixGid | ::Hash[::Symbol, untyped]]) -> void
+
+      # Flush sunrpc caches (ip_map and/or unix_gid)
+      #
+      # Requires CAP_NET_ADMIN in the initial user namespace.
+      # @rbs (?mask: ::Integer) -> void
+      # @param [Hash] args
+      # @option args [Integer] mask Known flags are defined in {Flags::CacheType}.
+      # @return [void]
+      # @see Messages::DoCacheFlushRequest
+      def do_cache_flush: (?mask: ::Integer) -> void
+
+      class AsyncOperations
+        # @private
+        def initialize: () ?{ (?) -> untyped } -> untyped
+
+        # Dump all pending ip_map requests
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        # @rbs () -> ::Nl::Async::Stream[Messages::DumpIpMapGetReqsReply]
+        # @param [Hash] args
+        # @return [Nl::Async::Stream<Messages::DumpIpMapGetReqsReply>]
+        # @see Messages::DumpIpMapGetReqsRequest
+        def dump_ip_map_get_reqs: () -> ::Nl::Async::Stream[Messages::DumpIpMapGetReqsReply]
+
+        # Respond to one or more ip_map requests
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        # @rbs (?requests: ::Array[(AttributeSets::IpMap | ::Hash[::Symbol, untyped])]) -> ::Nl::Async::Future[void]
+        # @param [Hash] args
+        # @option args [Array<AttributeSets::IpMap, Hash<Symbol, Object>>] requests
+        # @return [Nl::Async::Future<void>]
+        # @see Messages::DoIpMapSetReqsRequest
+        def do_ip_map_set_reqs: (?requests: ::Array[AttributeSets::IpMap | ::Hash[::Symbol, untyped]]) -> ::Nl::Async::Future[void]
+
+        # Dump all pending unix_gid requests
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        # @rbs () -> ::Nl::Async::Stream[Messages::DumpUnixGidGetReqsReply]
+        # @param [Hash] args
+        # @return [Nl::Async::Stream<Messages::DumpUnixGidGetReqsReply>]
+        # @see Messages::DumpUnixGidGetReqsRequest
+        def dump_unix_gid_get_reqs: () -> ::Nl::Async::Stream[Messages::DumpUnixGidGetReqsReply]
+
+        # Respond to one or more unix_gid requests
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        # @rbs (?requests: ::Array[(AttributeSets::UnixGid | ::Hash[::Symbol, untyped])]) -> ::Nl::Async::Future[void]
+        # @param [Hash] args
+        # @option args [Array<AttributeSets::UnixGid, Hash<Symbol, Object>>] requests
+        # @return [Nl::Async::Future<void>]
+        # @see Messages::DoUnixGidSetReqsRequest
+        def do_unix_gid_set_reqs: (?requests: ::Array[AttributeSets::UnixGid | ::Hash[::Symbol, untyped]]) -> ::Nl::Async::Future[void]
+
+        # Flush sunrpc caches (ip_map and/or unix_gid)
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        # @rbs (?mask: ::Integer) -> ::Nl::Async::Future[void]
+        # @param [Hash] args
+        # @option args [Integer] mask Known flags are defined in {Flags::CacheType}.
+        # @return [Nl::Async::Future<void>]
+        # @see Messages::DoCacheFlushRequest
+        def do_cache_flush: (?mask: ::Integer) -> ::Nl::Async::Future[void]
+      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: ::Integer?) -> AsyncOperations
+
+      # @rbs (*(:none | :exportd) groups) -> self
+      # @param [Array<:none, :exportd>] groups
+      # @return [self]
+      def subscribe: (*:none | :exportd groups) -> self
+
+      # @rbs (*(:none | :exportd) groups) -> self
+      # @param [Array<:none, :exportd>] groups
+      # @return [self]
+      def unsubscribe: (*:none | :exportd groups) -> self
+    end
+  end
+end