nl-linux 0.3.0 → 0.4.1

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

@@ -0,0 +1,640 @@
+# Generated from generated/nl/linux/ovs_datapath.rb with RBS::Inline
+
+module Nl
+  module Linux
+    # OVS datapath configuration over generic netlink.
+    class OvsDatapath < ::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 [OvsDatapath]
+      # @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 [OvsDatapath] 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 UserFeatures
+          # Allow last Netlink attribute to be unaligned
+          Unaligned: ::Integer
+
+          # Allow datapath to associate multiple Netlink PIDs to each vport
+          VportPids: ::Integer
+
+          # Allow tc offload recirc sharing
+          TcRecircSharing: ::Integer
+
+          # Allow per-cpu dispatch of upcalls
+          DispatchUpcallPerCpu: ::Integer
+        end
+      end
+
+      module Structs
+        class OvsHeader < Struct[::Integer]
+          attr_accessor dp_ifindex(): ::Integer
+
+          def self.new: (?::Integer dp_ifindex) -> instance
+                      | (?dp_ifindex: ::Integer) -> instance
+        end
+
+        class OvsHeader
+          # @!attribute [rw] dp_ifindex
+          #   @return [Integer]
+          # @private
+          MEMBERS: Hash[::Symbol, ::Nl::_DataType]
+
+          # Decodes the struct.
+          # @rbs decoder: ::Nl::Decoder
+          # @rbs return: instance
+          # @param [Nl::Decoder] decoder
+          # @return [self]
+          def self.decode: (::Nl::Decoder decoder) -> instance
+
+          # Encodes the struct.
+          # @rbs encoder: ::Nl::Encoder
+          # @rbs return: void
+          # @param [Nl::Encoder] encoder
+          # @return [void]
+          def encode: (::Nl::Encoder encoder) -> void
+        end
+
+        class OvsDpStats < Struct[::Integer]
+          attr_accessor n_hit(): ::Integer
+
+          attr_accessor n_missed(): ::Integer
+
+          attr_accessor n_lost(): ::Integer
+
+          attr_accessor n_flows(): ::Integer
+
+          def self.new: (?::Integer n_hit, ?::Integer n_missed, ?::Integer n_lost, ?::Integer n_flows) -> instance
+                      | (?n_hit: ::Integer, ?n_missed: ::Integer, ?n_lost: ::Integer, ?n_flows: ::Integer) -> instance
+        end
+
+        class OvsDpStats
+          # @!attribute [rw] n_hit
+          #   @return [Integer]
+          # @!attribute [rw] n_missed
+          #   @return [Integer]
+          # @!attribute [rw] n_lost
+          #   @return [Integer]
+          # @!attribute [rw] n_flows
+          #   @return [Integer]
+          # @private
+          MEMBERS: Hash[::Symbol, ::Nl::_DataType]
+
+          # Decodes the struct.
+          # @rbs decoder: ::Nl::Decoder
+          # @rbs return: instance
+          # @param [Nl::Decoder] decoder
+          # @return [self]
+          def self.decode: (::Nl::Decoder decoder) -> instance
+
+          # Encodes the struct.
+          # @rbs encoder: ::Nl::Encoder
+          # @rbs return: void
+          # @param [Nl::Encoder] encoder
+          # @return [void]
+          def encode: (::Nl::Encoder encoder) -> void
+        end
+
+        class OvsDpMegaflowStats < Struct[::Integer]
+          attr_accessor n_mask_hit(): ::Integer
+
+          attr_accessor n_masks(): ::Integer
+
+          attr_accessor padding(): ::Integer
+
+          attr_accessor n_cache_hit(): ::Integer
+
+          attr_accessor pad1(): ::Integer
+
+          def self.new: (?::Integer n_mask_hit, ?::Integer n_masks, ?::Integer padding, ?::Integer n_cache_hit, ?::Integer pad1) -> instance
+                      | (?n_mask_hit: ::Integer, ?n_masks: ::Integer, ?padding: ::Integer, ?n_cache_hit: ::Integer, ?pad1: ::Integer) -> instance
+        end
+
+        class OvsDpMegaflowStats
+          # @!attribute [rw] n_mask_hit
+          #   @return [Integer]
+          # @!attribute [rw] n_masks
+          #   @return [Integer]
+          # @!attribute [rw] padding
+          #   @return [Integer]
+          # @!attribute [rw] n_cache_hit
+          #   @return [Integer]
+          # @!attribute [rw] pad1
+          #   @return [Integer]
+          # @private
+          MEMBERS: Hash[::Symbol, ::Nl::_DataType]
+
+          # Decodes the struct.
+          # @rbs decoder: ::Nl::Decoder
+          # @rbs return: instance
+          # @param [Nl::Decoder] decoder
+          # @return [self]
+          def self.decode: (::Nl::Decoder decoder) -> instance
+
+          # Encodes the struct.
+          # @rbs encoder: ::Nl::Encoder
+          # @rbs return: void
+          # @param [Nl::Encoder] encoder
+          # @return [void]
+          def encode: (::Nl::Encoder encoder) -> void
+        end
+      end
+
+      module AttributeSets
+        class Datapath < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          class Name < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # upcall pid
+          class UpcallPid < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Stats < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class MegaflowStats < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Known flags are defined in {Flags::UserFeatures}.
+          class UserFeatures < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class MasksCacheSize < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class PerCpuPids < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Ifindex < 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
+
+          # upcall pid
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see UpcallPid
+          def upcall_pid: () -> ::Integer
+
+          # @rbs return: Structs::OvsDpStats
+          # @return [Structs::OvsDpStats]
+          # @see Stats
+          def stats: () -> Structs::OvsDpStats
+
+          # @rbs return: Structs::OvsDpMegaflowStats
+          # @return [Structs::OvsDpMegaflowStats]
+          # @see MegaflowStats
+          def megaflow_stats: () -> Structs::OvsDpMegaflowStats
+
+          # Known flags are defined in {Flags::UserFeatures}.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see UserFeatures
+          def user_features: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see MasksCacheSize
+          def masks_cache_size: () -> ::Integer
+
+          # @rbs return: ::Array[::Integer]
+          # @return [Array<Integer>]
+          # @see PerCpuPids
+          def per_cpu_pids: () -> ::Array[::Integer]
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Ifindex
+          def ifindex: () -> ::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 / dump OVS data path configuration and state
+        class DoGetRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          def dp_ifindex: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Datapath::Name
+          def name: () -> ::String
+        end
+
+        # Get / dump OVS data path configuration and state
+        class DoGetReply < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          def dp_ifindex: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Datapath::Name
+          def name: () -> ::String
+
+          # upcall pid
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Datapath::UpcallPid
+          def upcall_pid: () -> ::Integer
+
+          # @rbs return: Structs::OvsDpStats
+          # @return [Structs::OvsDpStats]
+          # @see AttributeSets::Datapath::Stats
+          def stats: () -> Structs::OvsDpStats
+
+          # @rbs return: Structs::OvsDpMegaflowStats
+          # @return [Structs::OvsDpMegaflowStats]
+          # @see AttributeSets::Datapath::MegaflowStats
+          def megaflow_stats: () -> Structs::OvsDpMegaflowStats
+
+          # Known flags are defined in {Flags::UserFeatures}.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Datapath::UserFeatures
+          def user_features: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Datapath::MasksCacheSize
+          def masks_cache_size: () -> ::Integer
+
+          # @rbs return: ::Array[::Integer]
+          # @return [Array<Integer>]
+          # @see AttributeSets::Datapath::PerCpuPids
+          def per_cpu_pids: () -> ::Array[::Integer]
+        end
+
+        # Get / dump OVS data path configuration and state
+        class DumpGetRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          def dp_ifindex: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Datapath::Name
+          def name: () -> ::String
+        end
+
+        # Get / dump OVS data path configuration and state
+        class DumpGetReply < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          def dp_ifindex: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Datapath::Name
+          def name: () -> ::String
+
+          # upcall pid
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Datapath::UpcallPid
+          def upcall_pid: () -> ::Integer
+
+          # @rbs return: Structs::OvsDpStats
+          # @return [Structs::OvsDpStats]
+          # @see AttributeSets::Datapath::Stats
+          def stats: () -> Structs::OvsDpStats
+
+          # @rbs return: Structs::OvsDpMegaflowStats
+          # @return [Structs::OvsDpMegaflowStats]
+          # @see AttributeSets::Datapath::MegaflowStats
+          def megaflow_stats: () -> Structs::OvsDpMegaflowStats
+
+          # Known flags are defined in {Flags::UserFeatures}.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Datapath::UserFeatures
+          def user_features: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Datapath::MasksCacheSize
+          def masks_cache_size: () -> ::Integer
+
+          # @rbs return: ::Array[::Integer]
+          # @return [Array<Integer>]
+          # @see AttributeSets::Datapath::PerCpuPids
+          def per_cpu_pids: () -> ::Array[::Integer]
+        end
+
+        # Create new OVS data path
+        class DoNewRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          def dp_ifindex: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Datapath::Name
+          def name: () -> ::String
+
+          # upcall pid
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Datapath::UpcallPid
+          def upcall_pid: () -> ::Integer
+
+          # Known flags are defined in {Flags::UserFeatures}.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Datapath::UserFeatures
+          def user_features: () -> ::Integer
+        end
+
+        # Delete existing OVS data path
+        class DoDelRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          def dp_ifindex: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Datapath::Name
+          def name: () -> ::String
+        end
+      end
+
+      module Notifications
+      end
+
+      # @private
+      NOTIFICATIONS: Hash[::Integer, ::Class]
+
+      # Get / dump OVS data path configuration and state
+      # @rbs (?dp_ifindex: ::Integer, ?name: ::String) -> Messages::DoGetReply
+      # @param [Hash] args
+      # @option args [Integer] dp_ifindex
+      # @option args [String] name
+      # @return [Messages::DoGetReply]
+      # @see Messages::DoGetRequest
+      def do_get: (?dp_ifindex: ::Integer, ?name: ::String) -> Messages::DoGetReply
+
+      # Get / dump OVS data path configuration and state
+      # @rbs (?dp_ifindex: ::Integer, ?name: ::String) -> Array[Messages::DumpGetReply]
+      #   | (?dp_ifindex: ::Integer, ?name: ::String) { (Messages::DumpGetReply) -> void } -> void
+      # @overload dump_get(**args)
+      #   Returns an array when no block is given.
+      #   @param [Hash] args
+      #   @option args [Integer] dp_ifindex
+      #   @option args [String] name
+      #   @return [Array<Messages::DumpGetReply>]
+      # @overload dump_get(**args, &block)
+      #   Yields each reply when a block is given.
+      #   @param [Hash] args
+      #   @option args [Integer] dp_ifindex
+      #   @option args [String] name
+      #   @yieldparam [Messages::DumpGetReply] reply
+      #   @return [void]
+      # @see Messages::DumpGetRequest
+      def dump_get: (?dp_ifindex: ::Integer, ?name: ::String) -> Array[Messages::DumpGetReply]
+                  | (?dp_ifindex: ::Integer, ?name: ::String) { (Messages::DumpGetReply) -> void } -> void
+
+      # Create new OVS data path
+      # @rbs (?dp_ifindex: ::Integer, ?name: ::String, ?upcall_pid: ::Integer, ?user_features: ::Integer) -> void
+      # @param [Hash] args
+      # @option args [Integer] dp_ifindex
+      # @option args [String] name
+      # @option args [Integer] upcall_pid upcall pid
+      # @option args [Integer] user_features Known flags are defined in {Flags::UserFeatures}.
+      # @return [void]
+      # @see Messages::DoNewRequest
+      def do_new: (?dp_ifindex: ::Integer, ?name: ::String, ?upcall_pid: ::Integer, ?user_features: ::Integer) -> void
+
+      # Delete existing OVS data path
+      # @rbs (?dp_ifindex: ::Integer, ?name: ::String) -> void
+      # @param [Hash] args
+      # @option args [Integer] dp_ifindex
+      # @option args [String] name
+      # @return [void]
+      # @see Messages::DoDelRequest
+      def do_del: (?dp_ifindex: ::Integer, ?name: ::String) -> void
+
+      class AsyncOperations
+        # @private
+        def initialize: () ?{ (?) -> untyped } -> untyped
+
+        # Get / dump OVS data path configuration and state
+        # @rbs (?dp_ifindex: ::Integer, ?name: ::String) -> ::Nl::Async::Future[Messages::DoGetReply]
+        # @param [Hash] args
+        # @option args [Integer] dp_ifindex
+        # @option args [String] name
+        # @return [Nl::Async::Future<Messages::DoGetReply>]
+        # @see Messages::DoGetRequest
+        def do_get: (?dp_ifindex: ::Integer, ?name: ::String) -> ::Nl::Async::Future[Messages::DoGetReply]
+
+        # Get / dump OVS data path configuration and state
+        # @rbs (?dp_ifindex: ::Integer, ?name: ::String) -> ::Nl::Async::Stream[Messages::DumpGetReply]
+        # @param [Hash] args
+        # @option args [Integer] dp_ifindex
+        # @option args [String] name
+        # @return [Nl::Async::Stream<Messages::DumpGetReply>]
+        # @see Messages::DumpGetRequest
+        def dump_get: (?dp_ifindex: ::Integer, ?name: ::String) -> ::Nl::Async::Stream[Messages::DumpGetReply]
+
+        # Create new OVS data path
+        # @rbs (?dp_ifindex: ::Integer, ?name: ::String, ?upcall_pid: ::Integer, ?user_features: ::Integer) -> ::Nl::Async::Future[void]
+        # @param [Hash] args
+        # @option args [Integer] dp_ifindex
+        # @option args [String] name
+        # @option args [Integer] upcall_pid upcall pid
+        # @option args [Integer] user_features Known flags are defined in {Flags::UserFeatures}.
+        # @return [Nl::Async::Future<void>]
+        # @see Messages::DoNewRequest
+        def do_new: (?dp_ifindex: ::Integer, ?name: ::String, ?upcall_pid: ::Integer, ?user_features: ::Integer) -> ::Nl::Async::Future[void]
+
+        # Delete existing OVS data path
+        # @rbs (?dp_ifindex: ::Integer, ?name: ::String) -> ::Nl::Async::Future[void]
+        # @param [Hash] args
+        # @option args [Integer] dp_ifindex
+        # @option args [String] name
+        # @return [Nl::Async::Future<void>]
+        # @see Messages::DoDelRequest
+        def do_del: (?dp_ifindex: ::Integer, ?name: ::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
+
+      # @rbs (*(:ovs_datapath) groups) -> self
+      # @param [Array<:ovs_datapath>] groups
+      # @return [self]
+      def subscribe: (*:ovs_datapath groups) -> self
+
+      # @rbs (*(:ovs_datapath) groups) -> self
+      # @param [Array<:ovs_datapath>] groups
+      # @return [self]
+      def unsubscribe: (*:ovs_datapath groups) -> self
+    end
+  end
+end