nl-linux 0.2.4 → 0.4.1

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

@@ -0,0 +1,733 @@
+# Generated from generated/nl/linux/team.rb with RBS::Inline
+
+module Nl
+  module Linux
+    # Network team device driver.
+    class Team < ::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 [Team]
+      # @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 [Team] 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 Constants
+        STRING_MAX_LEN: ::Integer
+
+        GENL_CHANGE_EVENT_MC_GRP_NAME: ::String
+      end
+
+      module Structs
+      end
+
+      module AttributeSets
+        # The team nested layout of get/set msg looks like::
+        #
+        #     [TEAM_ATTR_LIST_OPTION]
+        #         [TEAM_ATTR_ITEM_OPTION]
+        #             [TEAM_ATTR_OPTION_*], ...
+        #         [TEAM_ATTR_ITEM_OPTION]
+        #             [TEAM_ATTR_OPTION_*], ...
+        #         ...
+        #     [TEAM_ATTR_LIST_PORT]
+        #         [TEAM_ATTR_ITEM_PORT]
+        #             [TEAM_ATTR_PORT_*], ...
+        #         [TEAM_ATTR_ITEM_PORT]
+        #             [TEAM_ATTR_PORT_*], ...
+        #         ...
+        class Team < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          class TeamIfindex < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class ListOption < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+          end
+
+          class ListPort < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+          end
+
+          # @private
+          BY_NAME: Hash[::Symbol, Attribute]
+
+          # @private
+          BY_TYPE: Hash[::Integer, Attribute]
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see TeamIfindex
+          def team_ifindex: () -> ::Integer
+
+          # @rbs return: AttributeSets::ItemOption
+          # @return [AttributeSets::ItemOption]
+          # @see ListOption
+          def list_option: () -> AttributeSets::ItemOption
+
+          # @rbs return: AttributeSets::ItemPort
+          # @return [AttributeSets::ItemPort]
+          # @see ListPort
+          def list_port: () -> AttributeSets::ItemPort
+
+          # 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 ItemOption < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          class Option < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+          end
+
+          # @private
+          BY_NAME: Hash[::Symbol, Attribute]
+
+          # @private
+          BY_TYPE: Hash[::Integer, Attribute]
+
+          # @rbs return: AttributeSets::AttrOption
+          # @return [AttributeSets::AttrOption]
+          # @see Option
+          def option: () -> AttributeSets::AttrOption
+
+          # 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 AttrOption < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          class Name < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Changed < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Type < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Data < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Removed < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # for per-port options
+          class PortIfindex < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # for array options
+          class ArrayIndex < 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: ::String
+          # @return [String]
+          # @see Name
+          def name: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Changed
+          def changed: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Type
+          def type: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see Data
+          def data: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Removed
+          def removed: () -> ::Integer
+
+          # for per-port options
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see PortIfindex
+          def port_ifindex: () -> ::Integer
+
+          # for array options
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see ArrayIndex
+          def array_index: () -> ::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 ItemPort < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          class Port < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+          end
+
+          # @private
+          BY_NAME: Hash[::Symbol, Attribute]
+
+          # @private
+          BY_TYPE: Hash[::Integer, Attribute]
+
+          # @rbs return: AttributeSets::AttrPort
+          # @return [AttributeSets::AttrPort]
+          # @see Port
+          def port: () -> AttributeSets::AttrPort
+
+          # 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 AttrPort < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          class Ifindex < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Changed < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Linkup < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Speed < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Duplex < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Removed < 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 Ifindex
+          def ifindex: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Changed
+          def changed: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Linkup
+          def linkup: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Speed
+          def speed: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Duplex
+          def duplex: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Removed
+          def removed: () -> ::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
+        # No operation
+        class DoNoopRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+        end
+
+        # No operation
+        class DoNoopReply < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Team::TeamIfindex
+          def team_ifindex: () -> ::Integer
+        end
+
+        # Set team options
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        class DoOptionsSetRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Team::TeamIfindex
+          def team_ifindex: () -> ::Integer
+
+          # @rbs return: AttributeSets::ItemOption
+          # @return [AttributeSets::ItemOption]
+          # @see AttributeSets::Team::ListOption
+          def list_option: () -> AttributeSets::ItemOption
+        end
+
+        # Set team options
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        class DoOptionsSetReply < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Team::TeamIfindex
+          def team_ifindex: () -> ::Integer
+
+          # @rbs return: AttributeSets::ItemOption
+          # @return [AttributeSets::ItemOption]
+          # @see AttributeSets::Team::ListOption
+          def list_option: () -> AttributeSets::ItemOption
+        end
+
+        # Get team options info
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        class DoOptionsGetRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Team::TeamIfindex
+          def team_ifindex: () -> ::Integer
+        end
+
+        # Get team options info
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        class DoOptionsGetReply < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Team::TeamIfindex
+          def team_ifindex: () -> ::Integer
+
+          # @rbs return: AttributeSets::ItemOption
+          # @return [AttributeSets::ItemOption]
+          # @see AttributeSets::Team::ListOption
+          def list_option: () -> AttributeSets::ItemOption
+        end
+
+        # Get team ports info
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        class DoPortListGetRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Team::TeamIfindex
+          def team_ifindex: () -> ::Integer
+        end
+
+        # Get team ports info
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        class DoPortListGetReply < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Team::TeamIfindex
+          def team_ifindex: () -> ::Integer
+
+          # @rbs return: AttributeSets::ItemPort
+          # @return [AttributeSets::ItemPort]
+          # @see AttributeSets::Team::ListPort
+          def list_port: () -> AttributeSets::ItemPort
+        end
+      end
+
+      module Notifications
+      end
+
+      # @private
+      NOTIFICATIONS: Hash[::Integer, ::Class]
+
+      # No operation
+      # @rbs () -> Messages::DoNoopReply
+      # @param [Hash] args
+      # @return [Messages::DoNoopReply]
+      # @see Messages::DoNoopRequest
+      def do_noop: () -> Messages::DoNoopReply
+
+      # Set team options
+      #
+      # Requires CAP_NET_ADMIN in the initial user namespace.
+      # @rbs (?team_ifindex: ::Integer, ?list_option: (AttributeSets::ItemOption | ::Hash[::Symbol, untyped])) -> Messages::DoOptionsSetReply
+      # @param [Hash] args
+      # @option args [Integer] team_ifindex
+      # @option args [AttributeSets::ItemOption, Hash<Symbol, Object>] list_option
+      # @return [Messages::DoOptionsSetReply]
+      # @see Messages::DoOptionsSetRequest
+      def do_options_set: (?team_ifindex: ::Integer, ?list_option: AttributeSets::ItemOption | ::Hash[::Symbol, untyped]) -> Messages::DoOptionsSetReply
+
+      # Get team options info
+      #
+      # Requires CAP_NET_ADMIN in the initial user namespace.
+      # @rbs (?team_ifindex: ::Integer) -> Messages::DoOptionsGetReply
+      # @param [Hash] args
+      # @option args [Integer] team_ifindex
+      # @return [Messages::DoOptionsGetReply]
+      # @see Messages::DoOptionsGetRequest
+      def do_options_get: (?team_ifindex: ::Integer) -> Messages::DoOptionsGetReply
+
+      # Get team ports info
+      #
+      # Requires CAP_NET_ADMIN in the initial user namespace.
+      # @rbs (?team_ifindex: ::Integer) -> Messages::DoPortListGetReply
+      # @param [Hash] args
+      # @option args [Integer] team_ifindex
+      # @return [Messages::DoPortListGetReply]
+      # @see Messages::DoPortListGetRequest
+      def do_port_list_get: (?team_ifindex: ::Integer) -> Messages::DoPortListGetReply
+
+      class AsyncOperations
+        # @private
+        def initialize: () ?{ (?) -> untyped } -> untyped
+
+        # No operation
+        # @rbs () -> ::Nl::Async::Future[Messages::DoNoopReply]
+        # @param [Hash] args
+        # @return [Nl::Async::Future<Messages::DoNoopReply>]
+        # @see Messages::DoNoopRequest
+        def do_noop: () -> ::Nl::Async::Future[Messages::DoNoopReply]
+
+        # Set team options
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        # @rbs (?team_ifindex: ::Integer, ?list_option: (AttributeSets::ItemOption | ::Hash[::Symbol, untyped])) -> ::Nl::Async::Future[Messages::DoOptionsSetReply]
+        # @param [Hash] args
+        # @option args [Integer] team_ifindex
+        # @option args [AttributeSets::ItemOption, Hash<Symbol, Object>] list_option
+        # @return [Nl::Async::Future<Messages::DoOptionsSetReply>]
+        # @see Messages::DoOptionsSetRequest
+        def do_options_set: (?team_ifindex: ::Integer, ?list_option: AttributeSets::ItemOption | ::Hash[::Symbol, untyped]) -> ::Nl::Async::Future[Messages::DoOptionsSetReply]
+
+        # Get team options info
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        # @rbs (?team_ifindex: ::Integer) -> ::Nl::Async::Future[Messages::DoOptionsGetReply]
+        # @param [Hash] args
+        # @option args [Integer] team_ifindex
+        # @return [Nl::Async::Future<Messages::DoOptionsGetReply>]
+        # @see Messages::DoOptionsGetRequest
+        def do_options_get: (?team_ifindex: ::Integer) -> ::Nl::Async::Future[Messages::DoOptionsGetReply]
+
+        # Get team ports info
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        # @rbs (?team_ifindex: ::Integer) -> ::Nl::Async::Future[Messages::DoPortListGetReply]
+        # @param [Hash] args
+        # @option args [Integer] team_ifindex
+        # @return [Nl::Async::Future<Messages::DoPortListGetReply>]
+        # @see Messages::DoPortListGetRequest
+        def do_port_list_get: (?team_ifindex: ::Integer) -> ::Nl::Async::Future[Messages::DoPortListGetReply]
+      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
+    end
+  end
+end