nl-linux 0.2.3 → 0.3.0

data/generated/nl/linux/rt_rule.rb

@@ -1,4 +1,6 @@
 # SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
+#
+# This file is based on Documentation/netlink/specs/rt-rule.yaml from Linux v7.2.
 #--
 # frozen_string_literal: true
 # rbs_inline: enabled
@@ -9,6 +11,7 @@ module Nl; module Linux
 class RtRule < ::Nl::Family
   NAME = "rt-rule"
   PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Raw.new("rt-rule", 0))
+  MCAST_GROUPS = Ractor.make_shareable({:"rtnlgrp_ipv4_rule" => ::Nl::McastGroup.new("rtnlgrp-ipv4-rule", 8), :"rtnlgrp_ipv6_rule" => ::Nl::McastGroup.new("rtnlgrp-ipv6-rule", 19)}) #: Hash[::Symbol, ::Nl::McastGroup]
   module Structs
     Rtgenmsg = Struct.new(
       :"family", #: ::Integer
@@ -360,7 +363,7 @@ class RtRule < ::Nl::Family
       def l3mdev; attributes[:"l3mdev"]&.value; end
       # Gets the value of `uid-range` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def uid_range; attributes[:"uid_range"]&.value; end
       # Gets the value of `protocol` attribute in the message.
       #--
@@ -372,11 +375,11 @@ class RtRule < ::Nl::Family
       def ip_proto; attributes[:"ip_proto"]&.value; end
       # Gets the value of `sport-range` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def sport_range; attributes[:"sport_range"]&.value; end
       # Gets the value of `dport-range` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def dport_range; attributes[:"dport_range"]&.value; end
       # Gets the value of `dscp` attribute in the message.
       #--
@@ -483,7 +486,7 @@ class RtRule < ::Nl::Family
       def l3mdev; attributes[:"l3mdev"]&.value; end
       # Gets the value of `uid-range` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def uid_range; attributes[:"uid_range"]&.value; end
       # Gets the value of `protocol` attribute in the message.
       #--
@@ -495,11 +498,11 @@ class RtRule < ::Nl::Family
       def ip_proto; attributes[:"ip_proto"]&.value; end
       # Gets the value of `sport-range` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def sport_range; attributes[:"sport_range"]&.value; end
       # Gets the value of `dport-range` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def dport_range; attributes[:"dport_range"]&.value; end
       # Gets the value of `dscp` attribute in the message.
       #--
@@ -641,7 +644,255 @@ class RtRule < ::Nl::Family
       def l3mdev; attributes[:"l3mdev"]&.value; end
       # Gets the value of `uid-range` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
+      def uid_range; attributes[:"uid_range"]&.value; end
+      # Gets the value of `protocol` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def protocol; attributes[:"protocol"]&.value; end
+      # Gets the value of `ip-proto` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def ip_proto; attributes[:"ip_proto"]&.value; end
+      # Gets the value of `sport-range` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def sport_range; attributes[:"sport_range"]&.value; end
+      # Gets the value of `dport-range` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def dport_range; attributes[:"dport_range"]&.value; end
+      # Gets the value of `dscp` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def dscp; attributes[:"dscp"]&.value; end
+      # Gets the value of `flowlabel` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def flowlabel; attributes[:"flowlabel"]&.value; end
+      # Gets the value of `flowlabel-mask` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def flowlabel_mask; attributes[:"flowlabel_mask"]&.value; end
+      # Gets the value of `sport-mask` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def sport_mask; attributes[:"sport_mask"]&.value; end
+      # Gets the value of `dport-mask` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def dport_mask; attributes[:"dport_mask"]&.value; end
+      # Gets the value of `dscp-mask` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def dscp_mask; attributes[:"dscp_mask"]&.value; end
+    end
+  end
+  module Notifications
+    # Notify a rule creation
+    class NewruleNtf < ::Nl::Protocols::Raw::Message
+      TYPE = 32
+      FIXED_HEADER = Structs::FibRuleHdr
+      ATTRIBUTE_SET = AttributeSets::FibRuleAttrs
+      ATTRIBUTES = Ractor.make_shareable(%i[iifname goto priority fwmark flow tun_id suppress_ifgroup suppress_prefixlen table fwmask oifname l3mdev uid_range protocol ip_proto sport_range dport_range dscp flowlabel flowlabel_mask sport_mask dport_mask dscp_mask])
+      # Gets the value of `family` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def family; fixed_header.family; end
+      # Gets the value of `dst-len` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def dst_len; fixed_header.dst_len; end
+      # Gets the value of `src-len` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def src_len; fixed_header.src_len; end
+      # Gets the value of `tos` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def tos; fixed_header.tos; end
+      # Gets the value of `action` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def action; fixed_header.action; end
+      # Gets the value of `flags` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def flags; fixed_header.flags; end
+      # Gets the value of `iifname` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def iifname; attributes[:"iifname"]&.value; end
+      # Gets the value of `goto` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def goto; attributes[:"goto"]&.value; end
+      # Gets the value of `priority` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def priority; attributes[:"priority"]&.value; end
+      # Gets the value of `fwmark` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def fwmark; attributes[:"fwmark"]&.value; end
+      # Gets the value of `flow` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def flow; attributes[:"flow"]&.value; end
+      # Gets the value of `tun-id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def tun_id; attributes[:"tun_id"]&.value; end
+      # Gets the value of `suppress-ifgroup` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def suppress_ifgroup; attributes[:"suppress_ifgroup"]&.value; end
+      # Gets the value of `suppress-prefixlen` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def suppress_prefixlen; attributes[:"suppress_prefixlen"]&.value; end
+      # Gets the value of `table` attribute or fixed header in the message.
+      #--
+      # @rbs return: ::Integer
+      def table; attributes[:"table"]&.value || fixed_header.table; end
+      # Gets the value of `fwmask` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def fwmask; attributes[:"fwmask"]&.value; end
+      # Gets the value of `oifname` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def oifname; attributes[:"oifname"]&.value; end
+      # Gets the value of `l3mdev` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def l3mdev; attributes[:"l3mdev"]&.value; end
+      # Gets the value of `uid-range` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def uid_range; attributes[:"uid_range"]&.value; end
+      # Gets the value of `protocol` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def protocol; attributes[:"protocol"]&.value; end
+      # Gets the value of `ip-proto` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def ip_proto; attributes[:"ip_proto"]&.value; end
+      # Gets the value of `sport-range` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def sport_range; attributes[:"sport_range"]&.value; end
+      # Gets the value of `dport-range` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def dport_range; attributes[:"dport_range"]&.value; end
+      # Gets the value of `dscp` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def dscp; attributes[:"dscp"]&.value; end
+      # Gets the value of `flowlabel` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def flowlabel; attributes[:"flowlabel"]&.value; end
+      # Gets the value of `flowlabel-mask` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def flowlabel_mask; attributes[:"flowlabel_mask"]&.value; end
+      # Gets the value of `sport-mask` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def sport_mask; attributes[:"sport_mask"]&.value; end
+      # Gets the value of `dport-mask` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def dport_mask; attributes[:"dport_mask"]&.value; end
+      # Gets the value of `dscp-mask` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def dscp_mask; attributes[:"dscp_mask"]&.value; end
+    end
+    # Notify a rule deletion
+    class DelruleNtf < ::Nl::Protocols::Raw::Message
+      TYPE = 33
+      FIXED_HEADER = Structs::FibRuleHdr
+      ATTRIBUTE_SET = AttributeSets::FibRuleAttrs
+      ATTRIBUTES = Ractor.make_shareable(%i[iifname goto priority fwmark flow tun_id suppress_ifgroup suppress_prefixlen table fwmask oifname l3mdev uid_range protocol ip_proto sport_range dport_range dscp flowlabel flowlabel_mask sport_mask dport_mask dscp_mask])
+      # Gets the value of `family` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def family; fixed_header.family; end
+      # Gets the value of `dst-len` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def dst_len; fixed_header.dst_len; end
+      # Gets the value of `src-len` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def src_len; fixed_header.src_len; end
+      # Gets the value of `tos` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def tos; fixed_header.tos; end
+      # Gets the value of `action` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def action; fixed_header.action; end
+      # Gets the value of `flags` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def flags; fixed_header.flags; end
+      # Gets the value of `iifname` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def iifname; attributes[:"iifname"]&.value; end
+      # Gets the value of `goto` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def goto; attributes[:"goto"]&.value; end
+      # Gets the value of `priority` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def priority; attributes[:"priority"]&.value; end
+      # Gets the value of `fwmark` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def fwmark; attributes[:"fwmark"]&.value; end
+      # Gets the value of `flow` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def flow; attributes[:"flow"]&.value; end
+      # Gets the value of `tun-id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def tun_id; attributes[:"tun_id"]&.value; end
+      # Gets the value of `suppress-ifgroup` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def suppress_ifgroup; attributes[:"suppress_ifgroup"]&.value; end
+      # Gets the value of `suppress-prefixlen` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def suppress_prefixlen; attributes[:"suppress_prefixlen"]&.value; end
+      # Gets the value of `table` attribute or fixed header in the message.
+      #--
+      # @rbs return: ::Integer
+      def table; attributes[:"table"]&.value || fixed_header.table; end
+      # Gets the value of `fwmask` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def fwmask; attributes[:"fwmask"]&.value; end
+      # Gets the value of `oifname` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def oifname; attributes[:"oifname"]&.value; end
+      # Gets the value of `l3mdev` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def l3mdev; attributes[:"l3mdev"]&.value; end
+      # Gets the value of `uid-range` attribute in the message.
+      #--
+      # @rbs return: ::String
       def uid_range; attributes[:"uid_range"]&.value; end
       # Gets the value of `protocol` attribute in the message.
       #--
@@ -653,11 +904,11 @@ class RtRule < ::Nl::Family
       def ip_proto; attributes[:"ip_proto"]&.value; end
       # Gets the value of `sport-range` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def sport_range; attributes[:"sport_range"]&.value; end
       # Gets the value of `dport-range` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def dport_range; attributes[:"dport_range"]&.value; end
       # Gets the value of `dscp` attribute in the message.
       #--
@@ -685,15 +936,16 @@ class RtRule < ::Nl::Family
       def dscp_mask; attributes[:"dscp_mask"]&.value; end
     end
   end
+  NOTIFICATIONS = Ractor.make_shareable({32 => Notifications::NewruleNtf, 33 => Notifications::DelruleNtf}) #: Hash[::Integer, ::Class]
   # Add new FIB rule
   #--
-  # @rbs (?family: ::Integer, ?dst_len: ::Integer, ?src_len: ::Integer, ?tos: ::Integer, ?table: ::Integer, ?action: ::Integer, ?flags: ::Integer, ?iifname: ::String, ?goto: ::Integer, ?priority: ::Integer, ?fwmark: ::Integer, ?flow: ::Integer, ?tun_id: ::Integer, ?suppress_ifgroup: ::Integer, ?suppress_prefixlen: ::Integer, ?fwmask: ::Integer, ?oifname: ::String, ?l3mdev: ::Integer, ?uid_range: untyped, ?protocol: ::Integer, ?ip_proto: ::Integer, ?sport_range: untyped, ?dport_range: untyped, ?dscp: ::Integer, ?flowlabel: ::Integer, ?flowlabel_mask: ::Integer, ?sport_mask: ::Integer, ?dport_mask: ::Integer, ?dscp_mask: ::Integer) -> void
+  # @rbs (?family: ::Integer, ?dst_len: ::Integer, ?src_len: ::Integer, ?tos: ::Integer, ?table: ::Integer, ?action: ::Integer, ?flags: ::Integer, ?iifname: ::String, ?goto: ::Integer, ?priority: ::Integer, ?fwmark: ::Integer, ?flow: ::Integer, ?tun_id: ::Integer, ?suppress_ifgroup: ::Integer, ?suppress_prefixlen: ::Integer, ?fwmask: ::Integer, ?oifname: ::String, ?l3mdev: ::Integer, ?uid_range: ::String, ?protocol: ::Integer, ?ip_proto: ::Integer, ?sport_range: ::String, ?dport_range: ::String, ?dscp: ::Integer, ?flowlabel: ::Integer, ?flowlabel_mask: ::Integer, ?sport_mask: ::Integer, ?dport_mask: ::Integer, ?dscp_mask: ::Integer) -> void
   def do_newrule(**args)
     exchange_message(:"do", Messages::DoNewruleRequest, nil, args)
   end
   # Remove an existing FIB rule
   #--
-  # @rbs (?family: ::Integer, ?dst_len: ::Integer, ?src_len: ::Integer, ?tos: ::Integer, ?table: ::Integer, ?action: ::Integer, ?flags: ::Integer, ?iifname: ::String, ?goto: ::Integer, ?priority: ::Integer, ?fwmark: ::Integer, ?flow: ::Integer, ?tun_id: ::Integer, ?suppress_ifgroup: ::Integer, ?suppress_prefixlen: ::Integer, ?fwmask: ::Integer, ?oifname: ::String, ?l3mdev: ::Integer, ?uid_range: untyped, ?protocol: ::Integer, ?ip_proto: ::Integer, ?sport_range: untyped, ?dport_range: untyped, ?dscp: ::Integer, ?flowlabel: ::Integer, ?flowlabel_mask: ::Integer, ?sport_mask: ::Integer, ?dport_mask: ::Integer, ?dscp_mask: ::Integer) -> void
+  # @rbs (?family: ::Integer, ?dst_len: ::Integer, ?src_len: ::Integer, ?tos: ::Integer, ?table: ::Integer, ?action: ::Integer, ?flags: ::Integer, ?iifname: ::String, ?goto: ::Integer, ?priority: ::Integer, ?fwmark: ::Integer, ?flow: ::Integer, ?tun_id: ::Integer, ?suppress_ifgroup: ::Integer, ?suppress_prefixlen: ::Integer, ?fwmask: ::Integer, ?oifname: ::String, ?l3mdev: ::Integer, ?uid_range: ::String, ?protocol: ::Integer, ?ip_proto: ::Integer, ?sport_range: ::String, ?dport_range: ::String, ?dscp: ::Integer, ?flowlabel: ::Integer, ?flowlabel_mask: ::Integer, ?sport_mask: ::Integer, ?dport_mask: ::Integer, ?dscp_mask: ::Integer) -> void
   def do_delrule(**args)
     exchange_message(:"do", Messages::DoDelruleRequest, nil, args)
   end
@@ -704,5 +956,42 @@ class RtRule < ::Nl::Family
   def dump_getrule(**args, &block)
     exchange_message(:"dump", Messages::DumpGetruleRequest, Messages::DumpGetruleReply, args, &block)
   end
+  class AsyncOperations
+    # :nodoc:
+    def initialize(&exchange)
+      @exchange = exchange
+    end
+    # Add new FIB rule
+    #--
+    # @rbs (?family: ::Integer, ?dst_len: ::Integer, ?src_len: ::Integer, ?tos: ::Integer, ?table: ::Integer, ?action: ::Integer, ?flags: ::Integer, ?iifname: ::String, ?goto: ::Integer, ?priority: ::Integer, ?fwmark: ::Integer, ?flow: ::Integer, ?tun_id: ::Integer, ?suppress_ifgroup: ::Integer, ?suppress_prefixlen: ::Integer, ?fwmask: ::Integer, ?oifname: ::String, ?l3mdev: ::Integer, ?uid_range: ::String, ?protocol: ::Integer, ?ip_proto: ::Integer, ?sport_range: ::String, ?dport_range: ::String, ?dscp: ::Integer, ?flowlabel: ::Integer, ?flowlabel_mask: ::Integer, ?sport_mask: ::Integer, ?dport_mask: ::Integer, ?dscp_mask: ::Integer) -> ::Nl::Async::Future[void]
+    def do_newrule(**args)
+      @exchange.call(:"do", Messages::DoNewruleRequest, nil, args)
+    end
+    # Remove an existing FIB rule
+    #--
+    # @rbs (?family: ::Integer, ?dst_len: ::Integer, ?src_len: ::Integer, ?tos: ::Integer, ?table: ::Integer, ?action: ::Integer, ?flags: ::Integer, ?iifname: ::String, ?goto: ::Integer, ?priority: ::Integer, ?fwmark: ::Integer, ?flow: ::Integer, ?tun_id: ::Integer, ?suppress_ifgroup: ::Integer, ?suppress_prefixlen: ::Integer, ?fwmask: ::Integer, ?oifname: ::String, ?l3mdev: ::Integer, ?uid_range: ::String, ?protocol: ::Integer, ?ip_proto: ::Integer, ?sport_range: ::String, ?dport_range: ::String, ?dscp: ::Integer, ?flowlabel: ::Integer, ?flowlabel_mask: ::Integer, ?sport_mask: ::Integer, ?dport_mask: ::Integer, ?dscp_mask: ::Integer) -> ::Nl::Async::Future[void]
+    def do_delrule(**args)
+      @exchange.call(:"do", Messages::DoDelruleRequest, nil, args)
+    end
+    # Dump all FIB rules
+    #--
+    # @rbs (?family: ::Integer, ?dst_len: ::Integer, ?src_len: ::Integer, ?tos: ::Integer, ?table: ::Integer, ?action: ::Integer, ?flags: ::Integer) -> ::Nl::Async::Stream[Messages::DumpGetruleReply]
+    def dump_getrule(**args)
+      @exchange.call(:"dump", Messages::DumpGetruleRequest, Messages::DumpGetruleReply, args)
+    end
+  end
+  # Returns the asynchronous operation facade for this family.
+  #--
+  # @rbs (?stream_capacity: ::Integer?) -> AsyncOperations
+  def async(stream_capacity: nil)
+    return @async_operations ||= build_async_facade(AsyncOperations) if stream_capacity.nil?
+    build_async_facade(AsyncOperations, stream_capacity:)
+  end
+  #--
+  # @rbs (*(:rtnlgrp_ipv4_rule | :rtnlgrp_ipv6_rule) groups) -> self
+  def subscribe(*groups) = super
+  #--
+  # @rbs (*(:rtnlgrp_ipv4_rule | :rtnlgrp_ipv6_rule) groups) -> self
+  def unsubscribe(*groups) = super
 end
 end; end