nl-linux 0.2.4 → 0.4.1

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

@@ -0,0 +1,702 @@
+# Generated from generated/nl/linux/fou.rb with RBS::Inline
+
+module Nl
+  module Linux
+    # Foo-over-UDP.
+    class Fou < ::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 [Fou]
+      # @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 [Fou] 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 Enums
+        module EncapType
+          Unspec: ::Integer
+
+          Direct: ::Integer
+
+          Gue: ::Integer
+        end
+      end
+
+      module Structs
+      end
+
+      module AttributeSets
+        class Fou < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          class Port < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Af < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Ipproto < 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 RemcsumNopartial < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class LocalV4 < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class LocalV6 < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class PeerV4 < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class PeerV6 < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class PeerPort < 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: ::Integer
+          # @return [Integer]
+          # @see Port
+          def port: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Af
+          def af: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Ipproto
+          def ipproto: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Type
+          def type: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see RemcsumNopartial
+          def remcsum_nopartial: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see LocalV4
+          def local_v4: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see LocalV6
+          def local_v6: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see PeerV4
+          def peer_v4: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see PeerV6
+          def peer_v6: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see PeerPort
+          def peer_port: () -> ::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
+        # Add port.
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        class DoAddRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::Port
+          def port: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::Ipproto
+          def ipproto: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::Type
+          def type: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::RemcsumNopartial
+          def remcsum_nopartial: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::LocalV4
+          def local_v4: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Fou::LocalV6
+          def local_v6: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::PeerV4
+          def peer_v4: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Fou::PeerV6
+          def peer_v6: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::PeerPort
+          def peer_port: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::Ifindex
+          def ifindex: () -> ::Integer
+        end
+
+        # Delete port.
+        #
+        # 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::Fou::Port
+          def port: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::Af
+          def af: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::LocalV4
+          def local_v4: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Fou::LocalV6
+          def local_v6: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::PeerV4
+          def peer_v4: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Fou::PeerV6
+          def peer_v6: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::PeerPort
+          def peer_port: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::Ifindex
+          def ifindex: () -> ::Integer
+        end
+
+        # Get tunnel info.
+        class DoGetRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::Port
+          def port: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::Af
+          def af: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::LocalV4
+          def local_v4: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Fou::LocalV6
+          def local_v6: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::PeerV4
+          def peer_v4: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Fou::PeerV6
+          def peer_v6: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::PeerPort
+          def peer_port: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::Ifindex
+          def ifindex: () -> ::Integer
+        end
+
+        # Get tunnel info.
+        class DoGetReply < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::Port
+          def port: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::Ipproto
+          def ipproto: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::Type
+          def type: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::RemcsumNopartial
+          def remcsum_nopartial: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::LocalV4
+          def local_v4: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Fou::LocalV6
+          def local_v6: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::PeerV4
+          def peer_v4: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Fou::PeerV6
+          def peer_v6: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::PeerPort
+          def peer_port: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::Ifindex
+          def ifindex: () -> ::Integer
+        end
+
+        # Get tunnel info.
+        class DumpGetRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+        end
+
+        # Get tunnel info.
+        class DumpGetReply < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::Port
+          def port: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::Ipproto
+          def ipproto: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::Type
+          def type: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::RemcsumNopartial
+          def remcsum_nopartial: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::LocalV4
+          def local_v4: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Fou::LocalV6
+          def local_v6: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::PeerV4
+          def peer_v4: () -> ::Integer
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Fou::PeerV6
+          def peer_v6: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::PeerPort
+          def peer_port: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Fou::Ifindex
+          def ifindex: () -> ::Integer
+        end
+      end
+
+      module Notifications
+      end
+
+      # @private
+      NOTIFICATIONS: Hash[::Integer, ::Class]
+
+      # Add port.
+      #
+      # Requires CAP_NET_ADMIN in the initial user namespace.
+      # @rbs (?port: ::Integer, ?ipproto: ::Integer, ?type: ::Integer, ?remcsum_nopartial: ::Integer, ?local_v4: ::Integer, ?local_v6: ::String, ?peer_v4: ::Integer, ?peer_v6: ::String, ?peer_port: ::Integer, ?ifindex: ::Integer) -> void
+      # @param [Hash] args
+      # @option args [Integer] port
+      # @option args [Integer] ipproto
+      # @option args [Integer] type
+      # @option args [Integer] remcsum_nopartial
+      # @option args [Integer] local_v4
+      # @option args [String] local_v6
+      # @option args [Integer] peer_v4
+      # @option args [String] peer_v6
+      # @option args [Integer] peer_port
+      # @option args [Integer] ifindex
+      # @return [void]
+      # @see Messages::DoAddRequest
+      def do_add: (?port: ::Integer, ?ipproto: ::Integer, ?type: ::Integer, ?remcsum_nopartial: ::Integer, ?local_v4: ::Integer, ?local_v6: ::String, ?peer_v4: ::Integer, ?peer_v6: ::String, ?peer_port: ::Integer, ?ifindex: ::Integer) -> void
+
+      # Delete port.
+      #
+      # Requires CAP_NET_ADMIN in the initial user namespace.
+      # @rbs (?port: ::Integer, ?af: ::Integer, ?local_v4: ::Integer, ?local_v6: ::String, ?peer_v4: ::Integer, ?peer_v6: ::String, ?peer_port: ::Integer, ?ifindex: ::Integer) -> void
+      # @param [Hash] args
+      # @option args [Integer] port
+      # @option args [Integer] af
+      # @option args [Integer] local_v4
+      # @option args [String] local_v6
+      # @option args [Integer] peer_v4
+      # @option args [String] peer_v6
+      # @option args [Integer] peer_port
+      # @option args [Integer] ifindex
+      # @return [void]
+      # @see Messages::DoDelRequest
+      def do_del: (?port: ::Integer, ?af: ::Integer, ?local_v4: ::Integer, ?local_v6: ::String, ?peer_v4: ::Integer, ?peer_v6: ::String, ?peer_port: ::Integer, ?ifindex: ::Integer) -> void
+
+      # Get tunnel info.
+      # @rbs (?port: ::Integer, ?af: ::Integer, ?local_v4: ::Integer, ?local_v6: ::String, ?peer_v4: ::Integer, ?peer_v6: ::String, ?peer_port: ::Integer, ?ifindex: ::Integer) -> Messages::DoGetReply
+      # @param [Hash] args
+      # @option args [Integer] port
+      # @option args [Integer] af
+      # @option args [Integer] local_v4
+      # @option args [String] local_v6
+      # @option args [Integer] peer_v4
+      # @option args [String] peer_v6
+      # @option args [Integer] peer_port
+      # @option args [Integer] ifindex
+      # @return [Messages::DoGetReply]
+      # @see Messages::DoGetRequest
+      def do_get: (?port: ::Integer, ?af: ::Integer, ?local_v4: ::Integer, ?local_v6: ::String, ?peer_v4: ::Integer, ?peer_v6: ::String, ?peer_port: ::Integer, ?ifindex: ::Integer) -> Messages::DoGetReply
+
+      # Get tunnel info.
+      # @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
+
+      class AsyncOperations
+        # @private
+        def initialize: () ?{ (?) -> untyped } -> untyped
+
+        # Add port.
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        # @rbs (?port: ::Integer, ?ipproto: ::Integer, ?type: ::Integer, ?remcsum_nopartial: ::Integer, ?local_v4: ::Integer, ?local_v6: ::String, ?peer_v4: ::Integer, ?peer_v6: ::String, ?peer_port: ::Integer, ?ifindex: ::Integer) -> ::Nl::Async::Future[void]
+        # @param [Hash] args
+        # @option args [Integer] port
+        # @option args [Integer] ipproto
+        # @option args [Integer] type
+        # @option args [Integer] remcsum_nopartial
+        # @option args [Integer] local_v4
+        # @option args [String] local_v6
+        # @option args [Integer] peer_v4
+        # @option args [String] peer_v6
+        # @option args [Integer] peer_port
+        # @option args [Integer] ifindex
+        # @return [Nl::Async::Future<void>]
+        # @see Messages::DoAddRequest
+        def do_add: (?port: ::Integer, ?ipproto: ::Integer, ?type: ::Integer, ?remcsum_nopartial: ::Integer, ?local_v4: ::Integer, ?local_v6: ::String, ?peer_v4: ::Integer, ?peer_v6: ::String, ?peer_port: ::Integer, ?ifindex: ::Integer) -> ::Nl::Async::Future[void]
+
+        # Delete port.
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        # @rbs (?port: ::Integer, ?af: ::Integer, ?local_v4: ::Integer, ?local_v6: ::String, ?peer_v4: ::Integer, ?peer_v6: ::String, ?peer_port: ::Integer, ?ifindex: ::Integer) -> ::Nl::Async::Future[void]
+        # @param [Hash] args
+        # @option args [Integer] port
+        # @option args [Integer] af
+        # @option args [Integer] local_v4
+        # @option args [String] local_v6
+        # @option args [Integer] peer_v4
+        # @option args [String] peer_v6
+        # @option args [Integer] peer_port
+        # @option args [Integer] ifindex
+        # @return [Nl::Async::Future<void>]
+        # @see Messages::DoDelRequest
+        def do_del: (?port: ::Integer, ?af: ::Integer, ?local_v4: ::Integer, ?local_v6: ::String, ?peer_v4: ::Integer, ?peer_v6: ::String, ?peer_port: ::Integer, ?ifindex: ::Integer) -> ::Nl::Async::Future[void]
+
+        # Get tunnel info.
+        # @rbs (?port: ::Integer, ?af: ::Integer, ?local_v4: ::Integer, ?local_v6: ::String, ?peer_v4: ::Integer, ?peer_v6: ::String, ?peer_port: ::Integer, ?ifindex: ::Integer) -> ::Nl::Async::Future[Messages::DoGetReply]
+        # @param [Hash] args
+        # @option args [Integer] port
+        # @option args [Integer] af
+        # @option args [Integer] local_v4
+        # @option args [String] local_v6
+        # @option args [Integer] peer_v4
+        # @option args [String] peer_v6
+        # @option args [Integer] peer_port
+        # @option args [Integer] ifindex
+        # @return [Nl::Async::Future<Messages::DoGetReply>]
+        # @see Messages::DoGetRequest
+        def do_get: (?port: ::Integer, ?af: ::Integer, ?local_v4: ::Integer, ?local_v6: ::String, ?peer_v4: ::Integer, ?peer_v6: ::String, ?peer_port: ::Integer, ?ifindex: ::Integer) -> ::Nl::Async::Future[Messages::DoGetReply]
+
+        # Get tunnel info.
+        # @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]
+      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