nl-linux 0.3.0 → 0.4.1

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

@@ -0,0 +1,740 @@
+# Generated from generated/nl/linux/tcp_metrics.rb with RBS::Inline
+
+module Nl
+  module Linux
+    # Management interface for TCP metrics.
+    class TcpMetrics < ::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 [TcpMetrics]
+      # @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 [TcpMetrics] 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
+        TCP_FASTOPEN_COOKIE_MAX: ::Integer
+      end
+
+      module Structs
+      end
+
+      module AttributeSets
+        class TcpMetrics < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          class AddrIpv4 < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class AddrIpv6 < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Age < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # unused
+          class TwTsval < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # unused
+          class TwTsStamp < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Vals < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+          end
+
+          class FopenMss < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class FopenSynDrops < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class FopenSynDropTs < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class FopenCookie < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class SaddrIpv4 < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class SaddrIpv6 < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Pad < 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 AddrIpv4
+          def addr_ipv4: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AddrIpv6
+          def addr_ipv6: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Age
+          def age: () -> ::Integer
+
+          # unused
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see TwTsval
+          def tw_tsval: () -> ::Integer
+
+          # unused
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see TwTsStamp
+          def tw_ts_stamp: () -> ::Integer
+
+          # @rbs return: AttributeSets::Metrics
+          # @return [AttributeSets::Metrics]
+          # @see Vals
+          def vals: () -> AttributeSets::Metrics
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see FopenMss
+          def fopen_mss: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see FopenSynDrops
+          def fopen_syn_drops: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see FopenSynDropTs
+          def fopen_syn_drop_ts: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see FopenCookie
+          def fopen_cookie: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see SaddrIpv4
+          def saddr_ipv4: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see SaddrIpv6
+          def saddr_ipv6: () -> ::String
+
+          # 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
+
+        # Attributes with metrics. Note that the values here do not match
+        # the TCP_METRIC_* defines in the kernel, because kernel defines
+        # are off-by one (e.g. rtt is defined as enum 0, while netlink carries
+        # attribute type 1).
+        class Metrics < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          # Round Trip Time (RTT), in msecs with 3 bits fractional
+          # (left-shift by 3 to get the msec value).
+          class Rtt < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Round Trip Time VARiance (RTT), in msecs with 2 bits fractional
+          # (left-shift by 2 to get the msec value).
+          class Rttvar < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Slow Start THRESHold.
+          class Ssthresh < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Congestion Window.
+          class Cwnd < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Reodering metric.
+          class Reodering < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Round Trip Time (RTT), in usecs, with 3 bits fractional
+          # (left-shift by 3 to get the msec value).
+          class RttUs < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Round Trip Time (RTT), in usecs, with 2 bits fractional
+          # (left-shift by 3 to get the msec value).
+          class RttvarUs < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # @private
+          BY_NAME: Hash[::Symbol, Attribute]
+
+          # @private
+          BY_TYPE: Hash[::Integer, Attribute]
+
+          # Round Trip Time (RTT), in msecs with 3 bits fractional
+          # (left-shift by 3 to get the msec value).
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Rtt
+          def rtt: () -> ::Integer
+
+          # Round Trip Time VARiance (RTT), in msecs with 2 bits fractional
+          # (left-shift by 2 to get the msec value).
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Rttvar
+          def rttvar: () -> ::Integer
+
+          # Slow Start THRESHold.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Ssthresh
+          def ssthresh: () -> ::Integer
+
+          # Congestion Window.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Cwnd
+          def cwnd: () -> ::Integer
+
+          # Reodering metric.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Reodering
+          def reodering: () -> ::Integer
+
+          # Round Trip Time (RTT), in usecs, with 3 bits fractional
+          # (left-shift by 3 to get the msec value).
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see RttUs
+          def rtt_us: () -> ::Integer
+
+          # Round Trip Time (RTT), in usecs, with 2 bits fractional
+          # (left-shift by 3 to get the msec value).
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see RttvarUs
+          def rttvar_us: () -> ::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
+        # Retrieve metrics.
+        class DoGetRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::TcpMetrics::AddrIpv4
+          def addr_ipv4: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::TcpMetrics::AddrIpv6
+          def addr_ipv6: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::TcpMetrics::SaddrIpv4
+          def saddr_ipv4: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::TcpMetrics::SaddrIpv6
+          def saddr_ipv6: () -> ::String
+        end
+
+        # Retrieve metrics.
+        class DoGetReply < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::TcpMetrics::AddrIpv4
+          def addr_ipv4: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::TcpMetrics::AddrIpv6
+          def addr_ipv6: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::TcpMetrics::Age
+          def age: () -> ::Integer
+
+          # @rbs return: AttributeSets::Metrics
+          # @return [AttributeSets::Metrics]
+          # @see AttributeSets::TcpMetrics::Vals
+          def vals: () -> AttributeSets::Metrics
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::TcpMetrics::FopenMss
+          def fopen_mss: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::TcpMetrics::FopenSynDrops
+          def fopen_syn_drops: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::TcpMetrics::FopenSynDropTs
+          def fopen_syn_drop_ts: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::TcpMetrics::FopenCookie
+          def fopen_cookie: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::TcpMetrics::SaddrIpv4
+          def saddr_ipv4: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::TcpMetrics::SaddrIpv6
+          def saddr_ipv6: () -> ::String
+        end
+
+        # Retrieve metrics.
+        class DumpGetRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+        end
+
+        # Retrieve metrics.
+        class DumpGetReply < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::TcpMetrics::AddrIpv4
+          def addr_ipv4: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::TcpMetrics::AddrIpv6
+          def addr_ipv6: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::TcpMetrics::Age
+          def age: () -> ::Integer
+
+          # @rbs return: AttributeSets::Metrics
+          # @return [AttributeSets::Metrics]
+          # @see AttributeSets::TcpMetrics::Vals
+          def vals: () -> AttributeSets::Metrics
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::TcpMetrics::FopenMss
+          def fopen_mss: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::TcpMetrics::FopenSynDrops
+          def fopen_syn_drops: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::TcpMetrics::FopenSynDropTs
+          def fopen_syn_drop_ts: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::TcpMetrics::FopenCookie
+          def fopen_cookie: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::TcpMetrics::SaddrIpv4
+          def saddr_ipv4: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::TcpMetrics::SaddrIpv6
+          def saddr_ipv6: () -> ::String
+        end
+
+        # Delete metrics.
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        class DoDelRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::TcpMetrics::AddrIpv4
+          def addr_ipv4: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::TcpMetrics::AddrIpv6
+          def addr_ipv6: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::TcpMetrics::SaddrIpv4
+          def saddr_ipv4: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::TcpMetrics::SaddrIpv6
+          def saddr_ipv6: () -> ::String
+        end
+      end
+
+      module Notifications
+      end
+
+      # @private
+      NOTIFICATIONS: Hash[::Integer, ::Class]
+
+      # Retrieve metrics.
+      # @rbs (?addr_ipv4: ::Integer, ?addr_ipv6: ::String, ?saddr_ipv4: ::Integer, ?saddr_ipv6: ::String) -> Messages::DoGetReply
+      # @param [Hash] args
+      # @option args [Integer] addr_ipv4
+      # @option args [String] addr_ipv6
+      # @option args [Integer] saddr_ipv4
+      # @option args [String] saddr_ipv6
+      # @return [Messages::DoGetReply]
+      # @see Messages::DoGetRequest
+      def do_get: (?addr_ipv4: ::Integer, ?addr_ipv6: ::String, ?saddr_ipv4: ::Integer, ?saddr_ipv6: ::String) -> Messages::DoGetReply
+
+      # Retrieve metrics.
+      # @rbs () -> Array[Messages::DumpGetReply]
+      #   | () { (Messages::DumpGetReply) -> void } -> void
+      # @overload dump_get(**args)
+      #   Returns an array when no block is given.
+      #   @param [Hash] args
+      #   @return [Array<Messages::DumpGetReply>]
+      # @overload dump_get(**args, &block)
+      #   Yields each reply when a block is given.
+      #   @param [Hash] args
+      #   @yieldparam [Messages::DumpGetReply] reply
+      #   @return [void]
+      # @see Messages::DumpGetRequest
+      def dump_get: () -> Array[Messages::DumpGetReply]
+                  | () { (Messages::DumpGetReply) -> void } -> void
+
+      # Delete metrics.
+      #
+      # Requires CAP_NET_ADMIN in the initial user namespace.
+      # @rbs (?addr_ipv4: ::Integer, ?addr_ipv6: ::String, ?saddr_ipv4: ::Integer, ?saddr_ipv6: ::String) -> void
+      # @param [Hash] args
+      # @option args [Integer] addr_ipv4
+      # @option args [String] addr_ipv6
+      # @option args [Integer] saddr_ipv4
+      # @option args [String] saddr_ipv6
+      # @return [void]
+      # @see Messages::DoDelRequest
+      def do_del: (?addr_ipv4: ::Integer, ?addr_ipv6: ::String, ?saddr_ipv4: ::Integer, ?saddr_ipv6: ::String) -> void
+
+      class AsyncOperations
+        # @private
+        def initialize: () ?{ (?) -> untyped } -> untyped
+
+        # Retrieve metrics.
+        # @rbs (?addr_ipv4: ::Integer, ?addr_ipv6: ::String, ?saddr_ipv4: ::Integer, ?saddr_ipv6: ::String) -> ::Nl::Async::Future[Messages::DoGetReply]
+        # @param [Hash] args
+        # @option args [Integer] addr_ipv4
+        # @option args [String] addr_ipv6
+        # @option args [Integer] saddr_ipv4
+        # @option args [String] saddr_ipv6
+        # @return [Nl::Async::Future<Messages::DoGetReply>]
+        # @see Messages::DoGetRequest
+        def do_get: (?addr_ipv4: ::Integer, ?addr_ipv6: ::String, ?saddr_ipv4: ::Integer, ?saddr_ipv6: ::String) -> ::Nl::Async::Future[Messages::DoGetReply]
+
+        # Retrieve metrics.
+        # @rbs () -> ::Nl::Async::Stream[Messages::DumpGetReply]
+        # @param [Hash] args
+        # @return [Nl::Async::Stream<Messages::DumpGetReply>]
+        # @see Messages::DumpGetRequest
+        def dump_get: () -> ::Nl::Async::Stream[Messages::DumpGetReply]
+
+        # Delete metrics.
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        # @rbs (?addr_ipv4: ::Integer, ?addr_ipv6: ::String, ?saddr_ipv4: ::Integer, ?saddr_ipv6: ::String) -> ::Nl::Async::Future[void]
+        # @param [Hash] args
+        # @option args [Integer] addr_ipv4
+        # @option args [String] addr_ipv6
+        # @option args [Integer] saddr_ipv4
+        # @option args [String] saddr_ipv6
+        # @return [Nl::Async::Future<void>]
+        # @see Messages::DoDelRequest
+        def do_del: (?addr_ipv4: ::Integer, ?addr_ipv6: ::String, ?saddr_ipv4: ::Integer, ?saddr_ipv6: ::String) -> ::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
+    end
+  end
+end