nl-linux 0.2.4 → 0.3.0

data/generated/nl/linux/rt_neigh.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-neigh.yaml from Linux v7.2.
 #--
 # frozen_string_literal: true
 # rbs_inline: enabled
@@ -9,6 +11,7 @@ module Nl; module Linux
 class RtNeigh < ::Nl::Family
   NAME = "rt-neigh"
   PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Raw.new("rt-neigh", 0))
+  MCAST_GROUPS = Ractor.make_shareable({:"rtnlgrp_neigh" => ::Nl::McastGroup.new("rtnlgrp-neigh", 3)}) #: Hash[::Symbol, ::Nl::McastGroup]
   module Structs
     Ndmsg = Struct.new(
       :"ndm_family", #: ::Integer
@@ -467,11 +470,11 @@ class RtNeigh < ::Nl::Family
       def ndm_type; fixed_header.ndm_type; end
       # Gets the value of `dst` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def dst; attributes[:"dst"]&.value; end
       # Gets the value of `lladdr` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def lladdr; attributes[:"lladdr"]&.value; end
       # Gets the value of `probes` attribute in the message.
       #--
@@ -507,7 +510,7 @@ class RtNeigh < ::Nl::Family
       def nh_id; attributes[:"nh_id"]&.value; end
       # Gets the value of `fdb-ext-attrs` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def fdb_ext_attrs; attributes[:"fdb_ext_attrs"]&.value; end
       # Gets the value of `flags-ext` attribute in the message.
       #--
@@ -542,7 +545,7 @@ class RtNeigh < ::Nl::Family
       def ndm_type; fixed_header.ndm_type; end
       # Gets the value of `dst` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def dst; attributes[:"dst"]&.value; end
       # Gets the value of `ifindex` attribute in the message.
       #--
@@ -577,7 +580,7 @@ class RtNeigh < ::Nl::Family
       def ndm_type; fixed_header.ndm_type; end
       # Gets the value of `dst` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def dst; attributes[:"dst"]&.value; end
     end
     # Get or dump neighbour entries
@@ -608,11 +611,11 @@ class RtNeigh < ::Nl::Family
       def ndm_type; fixed_header.ndm_type; end
       # Gets the value of `dst` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def dst; attributes[:"dst"]&.value; end
       # Gets the value of `lladdr` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def lladdr; attributes[:"lladdr"]&.value; end
       # Gets the value of `probes` attribute in the message.
       #--
@@ -648,7 +651,7 @@ class RtNeigh < ::Nl::Family
       def nh_id; attributes[:"nh_id"]&.value; end
       # Gets the value of `fdb-ext-attrs` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def fdb_ext_attrs; attributes[:"fdb_ext_attrs"]&.value; end
       # Gets the value of `flags-ext` attribute in the message.
       #--
@@ -718,11 +721,11 @@ class RtNeigh < ::Nl::Family
       def ndm_type; fixed_header.ndm_type; end
       # Gets the value of `dst` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def dst; attributes[:"dst"]&.value; end
       # Gets the value of `lladdr` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def lladdr; attributes[:"lladdr"]&.value; end
       # Gets the value of `probes` attribute in the message.
       #--
@@ -758,7 +761,7 @@ class RtNeigh < ::Nl::Family
       def nh_id; attributes[:"nh_id"]&.value; end
       # Gets the value of `fdb-ext-attrs` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def fdb_ext_attrs; attributes[:"fdb_ext_attrs"]&.value; end
       # Gets the value of `flags-ext` attribute in the message.
       #--
@@ -804,7 +807,7 @@ class RtNeigh < ::Nl::Family
       def thresh3; attributes[:"thresh3"]&.value; end
       # Gets the value of `config` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def config; attributes[:"config"]&.value; end
       # Gets the value of `parms` attribute in the message.
       #--
@@ -812,7 +815,7 @@ class RtNeigh < ::Nl::Family
       def parms; attributes[:"parms"]&.value; end
       # Gets the value of `stats` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def stats; attributes[:"stats"]&.value; end
       # Gets the value of `gc-interval` attribute in the message.
       #--
@@ -855,21 +858,174 @@ class RtNeigh < ::Nl::Family
       def gc_interval; attributes[:"gc_interval"]&.value; end
     end
   end
+  module Notifications
+    # Notify a neighbour deletion
+    class DelneighNtf < ::Nl::Protocols::Raw::Message
+      TYPE = 29
+      FIXED_HEADER = Structs::Ndmsg
+      ATTRIBUTE_SET = AttributeSets::NeighbourAttrs
+      ATTRIBUTES = Ractor.make_shareable(%i[dst lladdr probes vlan port vni ifindex master protocol nh_id fdb_ext_attrs flags_ext])
+      # Gets the value of `ndm-family` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def ndm_family; fixed_header.ndm_family; end
+      # Gets the value of `ndm-ifindex` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def ndm_ifindex; fixed_header.ndm_ifindex; end
+      # Gets the value of `ndm-state` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def ndm_state; fixed_header.ndm_state; end
+      # Gets the value of `ndm-flags` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def ndm_flags; fixed_header.ndm_flags; end
+      # Gets the value of `ndm-type` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def ndm_type; fixed_header.ndm_type; end
+      # Gets the value of `dst` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def dst; attributes[:"dst"]&.value; end
+      # Gets the value of `lladdr` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def lladdr; attributes[:"lladdr"]&.value; end
+      # Gets the value of `probes` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def probes; attributes[:"probes"]&.value; end
+      # Gets the value of `vlan` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def vlan; attributes[:"vlan"]&.value; end
+      # Gets the value of `port` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def port; attributes[:"port"]&.value; end
+      # Gets the value of `vni` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def vni; attributes[:"vni"]&.value; end
+      # Gets the value of `ifindex` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def ifindex; attributes[:"ifindex"]&.value; end
+      # Gets the value of `master` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def master; attributes[:"master"]&.value; end
+      # Gets the value of `protocol` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def protocol; attributes[:"protocol"]&.value; end
+      # Gets the value of `nh-id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def nh_id; attributes[:"nh_id"]&.value; end
+      # Gets the value of `fdb-ext-attrs` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def fdb_ext_attrs; attributes[:"fdb_ext_attrs"]&.value; end
+      # Gets the value of `flags-ext` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def flags_ext; attributes[:"flags_ext"]&.value; end
+    end
+    # Notify a neighbour creation
+    class NewneighNtf < ::Nl::Protocols::Raw::Message
+      TYPE = 28
+      FIXED_HEADER = Structs::Ndmsg
+      ATTRIBUTE_SET = AttributeSets::NeighbourAttrs
+      ATTRIBUTES = Ractor.make_shareable(%i[dst lladdr probes vlan port vni ifindex master protocol nh_id fdb_ext_attrs flags_ext])
+      # Gets the value of `ndm-family` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def ndm_family; fixed_header.ndm_family; end
+      # Gets the value of `ndm-ifindex` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def ndm_ifindex; fixed_header.ndm_ifindex; end
+      # Gets the value of `ndm-state` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def ndm_state; fixed_header.ndm_state; end
+      # Gets the value of `ndm-flags` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def ndm_flags; fixed_header.ndm_flags; end
+      # Gets the value of `ndm-type` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def ndm_type; fixed_header.ndm_type; end
+      # Gets the value of `dst` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def dst; attributes[:"dst"]&.value; end
+      # Gets the value of `lladdr` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def lladdr; attributes[:"lladdr"]&.value; end
+      # Gets the value of `probes` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def probes; attributes[:"probes"]&.value; end
+      # Gets the value of `vlan` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def vlan; attributes[:"vlan"]&.value; end
+      # Gets the value of `port` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def port; attributes[:"port"]&.value; end
+      # Gets the value of `vni` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def vni; attributes[:"vni"]&.value; end
+      # Gets the value of `ifindex` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def ifindex; attributes[:"ifindex"]&.value; end
+      # Gets the value of `master` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def master; attributes[:"master"]&.value; end
+      # Gets the value of `protocol` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def protocol; attributes[:"protocol"]&.value; end
+      # Gets the value of `nh-id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def nh_id; attributes[:"nh_id"]&.value; end
+      # Gets the value of `fdb-ext-attrs` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def fdb_ext_attrs; attributes[:"fdb_ext_attrs"]&.value; end
+      # Gets the value of `flags-ext` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def flags_ext; attributes[:"flags_ext"]&.value; end
+    end
+  end
+  NOTIFICATIONS = Ractor.make_shareable({29 => Notifications::DelneighNtf, 28 => Notifications::NewneighNtf}) #: Hash[::Integer, ::Class]
   # Add new neighbour entry
   #--
-  # @rbs (?ndm_family: ::Integer, ?ndm_ifindex: ::Integer, ?ndm_state: ::Integer, ?ndm_flags: ::Integer, ?ndm_type: ::Integer, ?dst: untyped, ?lladdr: untyped, ?probes: ::Integer, ?vlan: ::Integer, ?port: ::Integer, ?vni: ::Integer, ?ifindex: ::Integer, ?master: ::Integer, ?protocol: ::Integer, ?nh_id: ::Integer, ?fdb_ext_attrs: untyped, ?flags_ext: ::Integer) -> void
+  # @rbs (?ndm_family: ::Integer, ?ndm_ifindex: ::Integer, ?ndm_state: ::Integer, ?ndm_flags: ::Integer, ?ndm_type: ::Integer, ?dst: ::String, ?lladdr: ::String, ?probes: ::Integer, ?vlan: ::Integer, ?port: ::Integer, ?vni: ::Integer, ?ifindex: ::Integer, ?master: ::Integer, ?protocol: ::Integer, ?nh_id: ::Integer, ?fdb_ext_attrs: ::String, ?flags_ext: ::Integer) -> void
   def do_newneigh(**args)
     exchange_message(:"do", Messages::DoNewneighRequest, nil, args)
   end
   # Remove an existing neighbour entry
   #--
-  # @rbs (?ndm_family: ::Integer, ?ndm_ifindex: ::Integer, ?ndm_state: ::Integer, ?ndm_flags: ::Integer, ?ndm_type: ::Integer, ?dst: untyped, ?ifindex: ::Integer) -> void
+  # @rbs (?ndm_family: ::Integer, ?ndm_ifindex: ::Integer, ?ndm_state: ::Integer, ?ndm_flags: ::Integer, ?ndm_type: ::Integer, ?dst: ::String, ?ifindex: ::Integer) -> void
   def do_delneigh(**args)
     exchange_message(:"do", Messages::DoDelneighRequest, nil, args)
   end
   # Get or dump neighbour entries
   #--
-  # @rbs (?ndm_family: ::Integer, ?ndm_ifindex: ::Integer, ?ndm_state: ::Integer, ?ndm_flags: ::Integer, ?ndm_type: ::Integer, ?dst: untyped) -> Messages::DoGetneighReply
+  # @rbs (?ndm_family: ::Integer, ?ndm_ifindex: ::Integer, ?ndm_state: ::Integer, ?ndm_flags: ::Integer, ?ndm_type: ::Integer, ?dst: ::String) -> Messages::DoGetneighReply
   def do_getneigh(**args)
     exchange_message(:"do", Messages::DoGetneighRequest, Messages::DoGetneighReply, args)
   end
@@ -893,5 +1049,60 @@ class RtNeigh < ::Nl::Family
   def do_setneightbl(**args)
     exchange_message(:"do", Messages::DoSetneightblRequest, nil, args)
   end
+  class AsyncOperations
+    # :nodoc:
+    def initialize(&exchange)
+      @exchange = exchange
+    end
+    # Add new neighbour entry
+    #--
+    # @rbs (?ndm_family: ::Integer, ?ndm_ifindex: ::Integer, ?ndm_state: ::Integer, ?ndm_flags: ::Integer, ?ndm_type: ::Integer, ?dst: ::String, ?lladdr: ::String, ?probes: ::Integer, ?vlan: ::Integer, ?port: ::Integer, ?vni: ::Integer, ?ifindex: ::Integer, ?master: ::Integer, ?protocol: ::Integer, ?nh_id: ::Integer, ?fdb_ext_attrs: ::String, ?flags_ext: ::Integer) -> ::Nl::Async::Future[void]
+    def do_newneigh(**args)
+      @exchange.call(:"do", Messages::DoNewneighRequest, nil, args)
+    end
+    # Remove an existing neighbour entry
+    #--
+    # @rbs (?ndm_family: ::Integer, ?ndm_ifindex: ::Integer, ?ndm_state: ::Integer, ?ndm_flags: ::Integer, ?ndm_type: ::Integer, ?dst: ::String, ?ifindex: ::Integer) -> ::Nl::Async::Future[void]
+    def do_delneigh(**args)
+      @exchange.call(:"do", Messages::DoDelneighRequest, nil, args)
+    end
+    # Get or dump neighbour entries
+    #--
+    # @rbs (?ndm_family: ::Integer, ?ndm_ifindex: ::Integer, ?ndm_state: ::Integer, ?ndm_flags: ::Integer, ?ndm_type: ::Integer, ?dst: ::String) -> ::Nl::Async::Future[Messages::DoGetneighReply]
+    def do_getneigh(**args)
+      @exchange.call(:"do", Messages::DoGetneighRequest, Messages::DoGetneighReply, args)
+    end
+    # Get or dump neighbour entries
+    #--
+    # @rbs (?ndm_family: ::Integer, ?ndm_ifindex: ::Integer, ?ndm_state: ::Integer, ?ndm_flags: ::Integer, ?ndm_type: ::Integer, ?ifindex: ::Integer, ?master: ::Integer) -> ::Nl::Async::Stream[Messages::DumpGetneighReply]
+    def dump_getneigh(**args)
+      @exchange.call(:"dump", Messages::DumpGetneighRequest, Messages::DumpGetneighReply, args)
+    end
+    # Get or dump neighbour tables
+    #--
+    # @rbs (?family: ::Integer) -> ::Nl::Async::Stream[Messages::DumpGetneightblReply]
+    def dump_getneightbl(**args)
+      @exchange.call(:"dump", Messages::DumpGetneightblRequest, Messages::DumpGetneightblReply, args)
+    end
+    # Set neighbour tables
+    #--
+    # @rbs (?family: ::Integer, ?name: ::String, ?thresh1: ::Integer, ?thresh2: ::Integer, ?thresh3: ::Integer, ?parms: AttributeSets::NdtpaAttrs, ?gc_interval: ::Integer) -> ::Nl::Async::Future[void]
+    def do_setneightbl(**args)
+      @exchange.call(:"do", Messages::DoSetneightblRequest, nil, 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_neigh) groups) -> self
+  def subscribe(*groups) = super
+  #--
+  # @rbs (*(:rtnlgrp_neigh) groups) -> self
+  def unsubscribe(*groups) = super
 end
 end; end