nl-linux 0.2.4 → 0.4.1

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

@@ -0,0 +1,636 @@
+# Generated from generated/nl/linux/dev_energymodel.rb with RBS::Inline
+
+module Nl
+  module Linux
+    # Energy model netlink interface to notify its changes.
+    class DevEnergymodel < ::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 [DevEnergymodel]
+      # @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 [DevEnergymodel] 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 PerfStateFlags
+          # The performance state is inefficient. There is in this perf-domain, another performance state with a higher frequency but a lower or equal power cost.
+          PerfStateInefficient: ::Integer
+        end
+
+        module PerfDomainFlags
+          # The power values are in micro-Watts or some other scale.
+          PerfDomainMicrowatts: ::Integer
+
+          # Skip inefficient states when estimating energy consumption.
+          PerfDomainSkipInefficiencies: ::Integer
+
+          # The power values are artificial and might be created by platform missing real power information.
+          PerfDomainArtificial: ::Integer
+        end
+      end
+
+      module Structs
+      end
+
+      module AttributeSets
+        # Information on a single performance domains.
+        class PerfDomain < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          class Pad < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # A unique ID number for each performance domain.
+          class PerfDomainId < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Bitmask of performance domain flags.
+          #
+          # Known flags are defined in {Flags::PerfDomainFlags}.
+          class Flags < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # CPUs that belong to this performance domain.
+          class Cpus < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            MULTI: bool
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # @private
+          BY_NAME: Hash[::Symbol, Attribute]
+
+          # @private
+          BY_TYPE: Hash[::Integer, Attribute]
+
+          # A unique ID number for each performance domain.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see PerfDomainId
+          def perf_domain_id: () -> ::Integer
+
+          # Bitmask of performance domain flags.
+          #
+          # Known flags are defined in {Flags::PerfDomainFlags}.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Flags
+          def flags: () -> ::Integer
+
+          # CPUs that belong to this performance domain.
+          # @rbs return: ::Array[::Integer]
+          # @return [Array<Integer>]
+          # @see Cpus
+          def cpus: () -> ::Array[::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
+
+        # Performance states table.
+        class PerfTable < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          # A unique ID number for each performance domain.
+          class PerfDomainId < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class PerfState < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            MULTI: bool
+
+            # @private
+            ORDER: ::Integer
+          end
+
+          # @private
+          BY_NAME: Hash[::Symbol, Attribute]
+
+          # @private
+          BY_TYPE: Hash[::Integer, Attribute]
+
+          # A unique ID number for each performance domain.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see PerfDomainId
+          def perf_domain_id: () -> ::Integer
+
+          # @rbs return: ::Array[AttributeSets::PerfState]
+          # @return [Array<AttributeSets::PerfState>]
+          # @see PerfState
+          def perf_state: () -> ::Array[AttributeSets::PerfState]
+
+          # 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
+
+        # Performance state of a performance domain.
+        class PerfState < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          class Pad < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # CPU performance (capacity) at a given frequency.
+          class Performance < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # The frequency in KHz, for consistency with CPUFreq.
+          class Frequency < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # The power consumed at this level (by 1 CPU or by a registered device). It can be a total power: static and dynamic.
+          class Power < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # The cost coefficient associated with this level, used during energy calculation. Equal to: power * max_frequency / frequency.
+          class Cost < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Bitmask of performance state flags.
+          #
+          # Known flags are defined in {Flags::PerfStateFlags}.
+          class Flags < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # @private
+          BY_NAME: Hash[::Symbol, Attribute]
+
+          # @private
+          BY_TYPE: Hash[::Integer, Attribute]
+
+          # CPU performance (capacity) at a given frequency.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Performance
+          def performance: () -> ::Integer
+
+          # The frequency in KHz, for consistency with CPUFreq.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Frequency
+          def frequency: () -> ::Integer
+
+          # The power consumed at this level (by 1 CPU or by a registered device). It can be a total power: static and dynamic.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Power
+          def power: () -> ::Integer
+
+          # The cost coefficient associated with this level, used during energy calculation. Equal to: power * max_frequency / frequency.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Cost
+          def cost: () -> ::Integer
+
+          # Bitmask of performance state flags.
+          #
+          # Known flags are defined in {Flags::PerfStateFlags}.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Flags
+          def flags: () -> ::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
+        # Get the list of information for all performance domains.
+        class DoGetPerfDomainsRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # A unique ID number for each performance domain.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::PerfDomain::PerfDomainId
+          def perf_domain_id: () -> ::Integer
+        end
+
+        # Get the list of information for all performance domains.
+        class DoGetPerfDomainsReply < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # A unique ID number for each performance domain.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::PerfDomain::PerfDomainId
+          def perf_domain_id: () -> ::Integer
+
+          # Bitmask of performance domain flags.
+          #
+          # Known flags are defined in {Flags::PerfDomainFlags}.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::PerfDomain::Flags
+          def flags: () -> ::Integer
+
+          # CPUs that belong to this performance domain.
+          # @rbs return: ::Array[::Integer]
+          # @return [Array<Integer>]
+          # @see AttributeSets::PerfDomain::Cpus
+          def cpus: () -> ::Array[::Integer]
+        end
+
+        # Get the list of information for all performance domains.
+        class DumpGetPerfDomainsRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+        end
+
+        # Get the list of information for all performance domains.
+        class DumpGetPerfDomainsReply < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # A unique ID number for each performance domain.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::PerfDomain::PerfDomainId
+          def perf_domain_id: () -> ::Integer
+
+          # Bitmask of performance domain flags.
+          #
+          # Known flags are defined in {Flags::PerfDomainFlags}.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::PerfDomain::Flags
+          def flags: () -> ::Integer
+
+          # CPUs that belong to this performance domain.
+          # @rbs return: ::Array[::Integer]
+          # @return [Array<Integer>]
+          # @see AttributeSets::PerfDomain::Cpus
+          def cpus: () -> ::Array[::Integer]
+        end
+
+        # Get the energy model table of a performance domain.
+        class DoGetPerfTableRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # A unique ID number for each performance domain.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::PerfTable::PerfDomainId
+          def perf_domain_id: () -> ::Integer
+        end
+
+        # Get the energy model table of a performance domain.
+        class DoGetPerfTableReply < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # A unique ID number for each performance domain.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::PerfTable::PerfDomainId
+          def perf_domain_id: () -> ::Integer
+
+          # @rbs return: ::Array[AttributeSets::PerfState]
+          # @return [Array<AttributeSets::PerfState>]
+          # @see AttributeSets::PerfTable::PerfState
+          def perf_state: () -> ::Array[AttributeSets::PerfState]
+        end
+      end
+
+      module Notifications
+        # A performance domain is created.
+        #
+        # Multicast group: `event`.
+        class PerfDomainCreated < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # A unique ID number for each performance domain.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::PerfTable::PerfDomainId
+          def perf_domain_id: () -> ::Integer
+
+          # @rbs return: ::Array[AttributeSets::PerfState]
+          # @return [Array<AttributeSets::PerfState>]
+          # @see AttributeSets::PerfTable::PerfState
+          def perf_state: () -> ::Array[AttributeSets::PerfState]
+        end
+
+        # A performance domain is updated.
+        #
+        # Multicast group: `event`.
+        class PerfDomainUpdated < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # A unique ID number for each performance domain.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::PerfTable::PerfDomainId
+          def perf_domain_id: () -> ::Integer
+
+          # @rbs return: ::Array[AttributeSets::PerfState]
+          # @return [Array<AttributeSets::PerfState>]
+          # @see AttributeSets::PerfTable::PerfState
+          def perf_state: () -> ::Array[AttributeSets::PerfState]
+        end
+
+        # A performance domain is deleted.
+        #
+        # Multicast group: `event`.
+        class PerfDomainDeleted < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # A unique ID number for each performance domain.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::PerfTable::PerfDomainId
+          def perf_domain_id: () -> ::Integer
+        end
+      end
+
+      # @private
+      NOTIFICATIONS: Hash[::Integer, ::Class]
+
+      # Get the list of information for all performance domains.
+      # @rbs (?perf_domain_id: ::Integer) -> Messages::DoGetPerfDomainsReply
+      # @param [Hash] args
+      # @option args [Integer] perf_domain_id A unique ID number for each performance domain.
+      # @return [Messages::DoGetPerfDomainsReply]
+      # @see Messages::DoGetPerfDomainsRequest
+      def do_get_perf_domains: (?perf_domain_id: ::Integer) -> Messages::DoGetPerfDomainsReply
+
+      # Get the list of information for all performance domains.
+      # @rbs () -> Array[Messages::DumpGetPerfDomainsReply]
+      #   | () { (Messages::DumpGetPerfDomainsReply) -> void } -> void
+      # @overload dump_get_perf_domains(**args)
+      #   Returns an array when no block is given.
+      #   @param [Hash] args
+      #   @return [Array<Messages::DumpGetPerfDomainsReply>]
+      # @overload dump_get_perf_domains(**args, &block)
+      #   Yields each reply when a block is given.
+      #   @param [Hash] args
+      #   @yieldparam [Messages::DumpGetPerfDomainsReply] reply
+      #   @return [void]
+      # @see Messages::DumpGetPerfDomainsRequest
+      def dump_get_perf_domains: () -> Array[Messages::DumpGetPerfDomainsReply]
+                               | () { (Messages::DumpGetPerfDomainsReply) -> void } -> void
+
+      # Get the energy model table of a performance domain.
+      # @rbs (?perf_domain_id: ::Integer) -> Messages::DoGetPerfTableReply
+      # @param [Hash] args
+      # @option args [Integer] perf_domain_id A unique ID number for each performance domain.
+      # @return [Messages::DoGetPerfTableReply]
+      # @see Messages::DoGetPerfTableRequest
+      def do_get_perf_table: (?perf_domain_id: ::Integer) -> Messages::DoGetPerfTableReply
+
+      class AsyncOperations
+        # @private
+        def initialize: () ?{ (?) -> untyped } -> untyped
+
+        # Get the list of information for all performance domains.
+        # @rbs (?perf_domain_id: ::Integer) -> ::Nl::Async::Future[Messages::DoGetPerfDomainsReply]
+        # @param [Hash] args
+        # @option args [Integer] perf_domain_id A unique ID number for each performance domain.
+        # @return [Nl::Async::Future<Messages::DoGetPerfDomainsReply>]
+        # @see Messages::DoGetPerfDomainsRequest
+        def do_get_perf_domains: (?perf_domain_id: ::Integer) -> ::Nl::Async::Future[Messages::DoGetPerfDomainsReply]
+
+        # Get the list of information for all performance domains.
+        # @rbs () -> ::Nl::Async::Stream[Messages::DumpGetPerfDomainsReply]
+        # @param [Hash] args
+        # @return [Nl::Async::Stream<Messages::DumpGetPerfDomainsReply>]
+        # @see Messages::DumpGetPerfDomainsRequest
+        def dump_get_perf_domains: () -> ::Nl::Async::Stream[Messages::DumpGetPerfDomainsReply]
+
+        # Get the energy model table of a performance domain.
+        # @rbs (?perf_domain_id: ::Integer) -> ::Nl::Async::Future[Messages::DoGetPerfTableReply]
+        # @param [Hash] args
+        # @option args [Integer] perf_domain_id A unique ID number for each performance domain.
+        # @return [Nl::Async::Future<Messages::DoGetPerfTableReply>]
+        # @see Messages::DoGetPerfTableRequest
+        def do_get_perf_table: (?perf_domain_id: ::Integer) -> ::Nl::Async::Future[Messages::DoGetPerfTableReply]
+      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 (*(:event) groups) -> self
+      # @param [Array<:event>] groups
+      # @return [self]
+      def subscribe: (*:event groups) -> self
+
+      # @rbs (*(:event) groups) -> self
+      # @param [Array<:event>] groups
+      # @return [self]
+      def unsubscribe: (*:event groups) -> self
+    end
+  end
+end