packetgen 3.3.3 → 4.1.0

data/lib/packetgen/header/ospfv2/lsa_header.rb

@@ -29,8 +29,8 @@ module PacketGen
       # LSA headers are used as-is in {DbDescription} payload. But this class
       # is also a base class for different LSA class, as {LSARouter}.
       # @author Sylvain Daubert
-      class LSAHeader < Types::Fields
-        include Types::Fieldable
+      class LSAHeader < BinStruct::Struct
+        include BinStruct::Structable
 
         # LSA Types
         TYPES = {
@@ -44,38 +44,38 @@ module PacketGen
         # @!attribute age
         #  The time in seconds since the LSA was originated.
         #  @return [Integer]
-        define_field :age, Types::Int16
+        define_attr :age, BinStruct::Int16
         # @!macro define_options
         OSPFv2.define_options(self)
         # @!attribute type
         #  The type of the LSA.
         #  @return [Integer]
-        define_field :type, Types::Int8Enum, enum: TYPES
+        define_attr :type, BinStruct::Int8Enum, enum: TYPES
         # @!attribute link_state_id
         #  This field identifies the portion of the internet environment
         #  that is being described by the LSA.
         #  @return [String]
-        define_field :link_state_id, IP::Addr
+        define_attr :link_state_id, IP::Addr
         # @!attribute advertising_router
         #  The Router ID of the router that originated the LSA.
         #  @return [String]
-        define_field :advertising_router, IP::Addr
+        define_attr :advertising_router, IP::Addr
         # @!attribute sequence_number
         #  @return [Integer]
-        define_field :sequence_number, Types::Int32
+        define_attr :sequence_number, BinStruct::Int32
         alias seqnum sequence_number
         alias seqnum= sequence_number=
         # @!attribute checksum
         #  The Fletcher checksum of the complete contents of the LSA,
         #  including the LSA header but excluding the LS age field.
         #  @return [Integer]
-        define_field :checksum, Types::Int16
+        define_attr :checksum, BinStruct::Int16
         # @!attribute length
         #  Length of the LSA, including the header.
         #  @return [Integer]
-        define_field :length, Types::Int16
+        define_attr :length, BinStruct::Int16
 
-        # Compute and set Fletcher-16 checksum on LSA
+        # Compute and set Fletcher-16 {#checksum} on LSA
         # @return [Integer]
         def calc_checksum
           c0 = c1 = 0
@@ -93,7 +93,7 @@ module PacketGen
           self.checksum = (x << 8) | y
         end
 
-        # Compute length and set +length+ field
+        # Compute length and set {#length} field
         # @return [Integer]
         def calc_length
           self.length = Base.calculate_and_set_length(self)
@@ -105,6 +105,7 @@ module PacketGen
           self[:type].to_human
         end
 
+        # Get human-readable description
         # @return [String]
         def to_human
           "LSA<#{human_type},#{link_state_id},#{advertising_router}>"

data/lib/packetgen/header/ospfv2.rb

@@ -9,7 +9,7 @@
 module PacketGen
   module Header
     # This class supports OSPFv2 (RFC 2328).
-    # A OSPFv2 header has the following format:
+    # An OSPFv2 header has the following format:
     #
     #    0                   1                   2                   3
     #    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
@@ -28,37 +28,38 @@ module PacketGen
     #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     #
     # An OSPFv2 header consists of:
-    # * a {#version} field ({Types::Int8}),
-    # * a {#type} field ({Types::Int8Enum}),
-    # * a {#length} field ({Types::Int16}). The length includes the header,
-    # * a {#router_id} field ({Types::Int32}),
-    # * an {#area_id} field ({Types::Int32}),
-    # * a {#checksum} field ({Types::Int16}),
-    # * an {#au_type} field ({Types::Int16Enum}),
-    # * an {#authentication} field ({Types::Int64}),
-    # * and a {#body} ({Types::String}).
+    # * a {#version} field (+BinStruct::Int8+),
+    # * a {#type} field (+BinStruct::Int8Enum+),
+    # * a {#length} field (+BinStruct::Int16+). The length includes the header,
+    # * a {#router_id} field (+BinStruct::Int32+),
+    # * an {#area_id} field (+BinStruct::Int32+),
+    # * a {#checksum} field (+BinStruct::Int16+),
+    # * an {#au_type} field (+BinStruct::Int16Enum+),
+    # * an {#authentication} field (+BinStruct::Int64+),
+    # * and a {#body} (+BinStruct::String+ or {Headerable}).
     #
-    # == Create an OSPFv2 header
+    # @example Create an OSPFv2 header
     #   # standalone
     #   ospf = PacketGen::Header::OSPFv2.new
     #   # in a packet
-    #   pkt = PacketGen.gen('IP', src: source_ip).add('OSPFv2')
+    #   pkt = PacketGen.gen('IP').add('OSPFv2')
     #   # make IP header correct for OSPF
     #   pkt.ospfize
     #   # or make it correct with specific destination address
     #   pkt.ospfize(dst: :all_spf_routers)
     #   # access to OSPF header
-    #   pkt.ospfv2    # => PacketGen::Header::OSPFv2
+    #   pkt.ospfv2.class    # => PacketGen::Header::OSPFv2
     #
-    # == OSPFv2 attributes
-    #  ospf.version              # => 2
-    #  ospf.type = 'LS_ACK'      # or 5
-    #  ospf.length = 154
-    #  ospf.router_id = 0xc0a80001
-    #  ospf.area_id = 1
-    #  ospf.checksum = 0xabcd
-    #  ospf.au_type = 'NO_AUTH'  # or 0
-    #  ospf.authentication = 0
+    # @example OSPFv2 attributes
+    #   ospf = PacketGen::Header::OSPFv2.new
+    #   ospf.version              # => 2
+    #   ospf.type = 'LS_ACK'      # or 5
+    #   ospf.length = 154
+    #   ospf.router_id = 0xc0a80001
+    #   ospf.area_id = 1
+    #   ospf.checksum = 0xabcd
+    #   ospf.au_type = 'NO_AUTH'  # or 0
+    #   ospf.authentication = 0
     #
     # == OSPFv2 body
     # OSPFv2 {#body} should contain OSPF payload for given {#type}:
@@ -94,38 +95,39 @@ module PacketGen
       # @!attribute version
       #  8-bit OSPF version
       #  @return [Integer]
-      define_field :version, Types::Int8, default: 2
+      define_attr :version, BinStruct::Int8, default: 2
       # @!attribute type
       #  8-bit OSPF packet type. Types are defined in {TYPES}.
       #  @return [Integer]
-      define_field :type, Types::Int8Enum, enum: TYPES
+      define_attr :type, BinStruct::Int8Enum, enum: TYPES
       # @!attribute length
       #  16-bit OSPF packet length
       #  @return [Integer]
-      define_field :length, Types::Int16
+      define_attr :length, BinStruct::Int16
       # @!attribute router_id
       #  32-bit router ID
       #  @return [Integer]
-      define_field :router_id, Types::Int32
+      define_attr :router_id, BinStruct::Int32
       # @!attribute area_id
       #  32-bit area ID
       #  @return [Integer]
-      define_field :area_id, Types::Int32
+      define_attr :area_id, BinStruct::Int32
       # @!attribute checksum
       #  16-bit OSPF packet checksum
       #  @return [Integer]
-      define_field :checksum, Types::Int16
+      define_attr :checksum, BinStruct::Int16
       # @!attribute au_type
       #  16-bit authentication type. Types are defined in {AU_TYPES}.
       #  @return [Integer]
-      define_field :au_type, Types::Int16Enum, enum: AU_TYPES
+      define_attr :au_type, BinStruct::Int16Enum, enum: AU_TYPES
       # @!attribute authentication
       #  64-bit authentication data
       #  @return [Integer]
-      define_field :authentication, Types::Int64
+      define_attr :authentication, BinStruct::Int64
       # @!attribute body
-      #  @return [String,Base]
-      define_field :body, Types::String
+      #  OSPF body
+      #  @return [String,Headerable]
+      define_attr :body, BinStruct::String
 
       # @api private
       # Helper class method to define an OSPFv2 options field.
@@ -137,41 +139,42 @@ module PacketGen
       #    {#n_opt}, {#l_opt}, {#dc_opt}, {#o_opt} and {#dn_opt}.
       #    @return [Integer]
       #  @!attribute dn_opt
-      #    @return [Boolean]
+      #    @return [Integer]
       #  @!attribute o_opt
-      #    @return [Boolean]
+      #    @return [Integer]
       #  @!attribute dc_opt
       #    This bit describes the router's handling of demand circuits.
-      #    @return [Boolean]
+      #    @return [Integer]
       #  @!attribute l_opt
       #    This specifies if a LLS Data block is present.
-      #    @return [Boolean]
+      #    @return [Integer]
       #  @!attribute n_opt
       #    This bit specifies if NSSA is supported.
-      #    @return [Boolean]
+      #    @return [Integer]
       #  @!attribute mc_opt
       #    This bit describes whether IP multicast datagrams are forwarded.
-      #    @return [Boolean]
+      #    @return [Integer]
       #  @!attribute e_opt
       #    This bit describes the way AS-external-LSAs are flooded.
-      #    @return [Boolean]
+      #    @return [Integer]
       #  @!attribute mt_opt
-      #    @return [Boolean]
+      #    @return [Integer]
       def self.define_options(hdr)
-        hdr.define_field :options, Types::Int8
-        hdr.define_bit_fields_on :options, :dn_opt, :o_opt, :dc_opt, :l_opt,
-                                 :n_opt, :mc_opt, :e_opt, :mt_opt
+        hdr.define_bit_attr :options, dn_opt: 1, o_opt: 1, dc_opt: 1, l_opt: 1, n_opt: 1, mc_opt: 1, e_opt: 1, mt_opt: 1
       end
 
       # @api private
       # @note This method is used internally by PacketGen and should not be
       #       directly called
+      # @param [Packet] packet
+      # @return [void]
+      # Add +#ospfize+ method to +packet+. This method calls {#ospfize}.
       def added_to_packet(packet)
         ospf_idx = packet.headers.size
         packet.instance_eval "def ospfize(**kwargs) @headers[#{ospf_idx}].ospfize(**kwargs); end" # def ospfize(**kwargs) @headers[2].ospfize(**kwargs); end
       end
 
-      # Compute checksum and set +checksum+ field
+      # Compute checksum and set {#checksum} attribute
       # @return [Integer]
       def calc_checksum
         # #authentication field is not used in checksum calculation,
@@ -200,7 +203,7 @@ module PacketGen
         self[:au_type].to_human
       end
 
-      # Compute length and set +length+ field
+      # Compute length and set {#length} attribute
       # @return [Integer]
       def calc_length
         self[:length].value = Base.calculate_and_set_length(self)
@@ -215,7 +218,7 @@ module PacketGen
       #    pkt.ospfv2.ospfize
       #    # second way
       #    pkt.ospfize
-      # @param [String,Symbol,nil] dst destination address. May be a dotted IP
+      # @param [String,Symbolnil] dst destination address. May be a dotted IP
       #   address (by example '224.0.0.5') or a Symbol (+:all_spf_routers+ or
       #   +:all_d_routers+)
       # @return [void]

data/lib/packetgen/header/ospfv3/db_description.rb

@@ -33,25 +33,26 @@ module PacketGen
       #   |                              ...                               |
       #
       # A DB description payload is composed of:
-      # * a 8-bit {#reserved} field ({Types::Int8}),
-      # * a 24-bit {#options} field ({Types::Int24}),
-      # * a 16-bit {#mtu} field ({Types::Int16}),
-      # * a 16-bit {#flags} field ({Types::Int16}). Supported flags are:
+      # * a 8-bit {#reserved} field (+BinStruct::Int8+),
+      # * a 24-bit {#options} field (+BinStruct::Int24+),
+      # * a 16-bit {#mtu} field (+BinStruct::Int16+),
+      # * a 16-bit {#flags} field (+BinStruct::Int16+). Supported flags are:
       #   * {i_flag},
       #   * {m_flag},
       #   * {ms_flag},
-      # * a 32-bit {#sequence_number} field ({Types::Int32}),
+      # * a 32-bit {#sequence_number} field (+BinStruct::Int32+),
       # * and an array of {LSAHeader LSAHeaders} ({#lsas}, {ArrayOfLSA}).
       #
-      # == Create a DbDescription payload
+      # @example Create a DbDescription payload
       #   # standalone
       #   dbd = PacketGen::Header::OSPFv3::DbDescription.new
       #   # in a packet
-      #   pkt = PacketGen.gen('IPv6', src: source_ip).add('OSPFv3').add('OSPFv3::DbDescription')
+      #   pkt = PacketGen.gen('IPv6').add('OSPFv3').add('OSPFv3::DbDescription')
       #   # access to DbDescription payload
-      #   pkt.ospfv3_dbdescription    # => PacketGen::Header::OSPFv3::DbDescription
+      #   pkt.ospfv3_dbdescription.class    # => PacketGen::Header::OSPFv3::DbDescription
       #
-      # == DbDescription attributes
+      # @example DbDescription attributes
+      #   dbd = PacketGen::Header::OSPFv3::DbDescription.new
       #   dbd.reserved = 0
       #   # set options. Options may also be set one by one with #v6_opt, #e_opt,
       #   # #n_opt, #r_opt and #dc_opt
@@ -61,49 +62,46 @@ module PacketGen
       #   dbd.seqnum = 0x800001
       #   # add a LSA Router header
       #   dbd.lsas << { type: 'Router', age: 40, link_state_id: '0.0.0.1', advertising_router: '1.1.1.1', sequence_number: 42, checksum: 0x1234, length: 56 }
-      #   # a header may also be set from an existing lsa
-      #   dbd.lsas << existing_lsa.to_lsa_header
       # @author Sylvain Daubert
       class DbDescription < Base
         # @!attribute reserved
         #  8-bit zero field before {#options} one
         #  @return [Integer]
-        define_field :reserved, Types::Int8, default: 0
+        define_attr :reserved, BinStruct::Int8, default: 0
 
-        # @!macro define_options
+        # @!macro define_ospfv3_options
         OSPFv3.define_options(self)
 
         # @!attribute mtu
         #  16-bit interface MTU
         #  @return [Integer]
-        define_field :mtu, Types::Int16
+        define_attr :mtu, BinStruct::Int16
         # @!attribute flags
         #  16-bit interface flags ({#i_flag}, {#m_flag} and {#ms_flag})
         #  @return [Integer]
-        define_field :flags, Types::Int16
         # @!attribute i_flag
         #  Init bit from {#flags} field
-        #  @return [Boolean]
+        #  @return [Integer]
         # @!attribute m_flag
         #  More bit from {#flags} field
-        #  @return [Boolean]
+        #  @return [Integer]
         # @!attribute ms_flag
         #  Master/Slave bit from {#flags} field
-        #  @return [Boolean]
-        define_bit_fields_on :flags, :zz, 13, :i_flag, :m_flag, :ms_flag
+        #  @return [Integer]
+        define_bit_attr :flags, zz: 13, i_flag: 1, m_flag: 1, ms_flag: 1
 
         # @!attribute sequence_number
         #  32-bit DD sequence number, used to sequence the collection of Database
         #  Description Packets.
         #  @return [Integer]
-        define_field :sequence_number, Types::Int32
+        define_attr :sequence_number, BinStruct::Int32
         alias seqnum sequence_number
         alias seqnum= sequence_number=
 
         # @!attribute lsas
         #  Array of LSA headers
-        #  @return [ArrayOfLSAHeader]
-        define_field :lsas, ArrayOfLSA, builder: ->(_h, t) { t.new(only_headers: true) }
+        #  @return [ArrayOfLSA]
+        define_attr :lsas, ArrayOfLSA, builder: ->(_h, t) { t.new(only_headers: true) }
       end
     end
 

data/lib/packetgen/header/ospfv3/hello.rb

@@ -28,26 +28,27 @@ module PacketGen
       #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       #   |                        ...                                    |
       # A HELLO payload consists of:
-      # * a {#interface_id} field ({Types::Int32}),
-      # * a {#priority} field ({Types::Int8}),
-      # * an {#options} field ({Types::Int24}),
-      # * a {#hello_interval} field ({Types::Int16}),
-      # * a {#dead_interval} field ({Types::Int16}),
+      # * a {#interface_id} field (+BinStruct::Int32+),
+      # * a {#priority} field (+BinStruct::Int8+),
+      # * an {#options} field (+BinStruct::Int24+),
+      # * a {#hello_interval} field (+BinStruct::Int16+),
+      # * a {#dead_interval} field (+BinStruct::Int16+),
       # * a {#designated_router} field ({IP::Addr}),
       # * a {#backup_designated_router} field ({IP::Addr}),
       # * a {#neighbors} array containing neighbors as {IP::Addr}.
       #
-      # == Create a HELLO payload
+      # @example Create a HELLO payload
       #   # standalone
       #   hello = PacketGen::Header::OSPFv3::Hello.new
       #   # in a packet
-      #   pkt = PacketGen.gen('IPv6', src: source_ip).add('OSPFv3').add('OSPFv3::Hello')
+      #   pkt = PacketGen.gen('IPv6').add('OSPFv3').add('OSPFv3::Hello')
       #   # make IPv6 header correct for OSPF
       #   pkt.ospfize
       #   # access to Hello payload
-      #   pkt.ospfv3_hello    # => PacketGen::Header::OSPFv3::Hello
+      #   pkt.ospfv3_hello.class    # => PacketGen::Header::OSPFv3::Hello
       #
-      # == HELLO attributes
+      # @example HELLO attributes
+      #   hello = PacketGen::Header::OSPFv3::Hello.new
       #   hello.interface_id = 1
       #   hello.priority = 1
       #   # set options. Options may also be set one by one with #v6_opt, #e_opt,
@@ -65,36 +66,36 @@ module PacketGen
         # @!attribute interface_id
         #  The network mask associated with this interface.
         #  @return [String]
-        define_field :interface_id, Types::Int32
+        define_attr :interface_id, BinStruct::Int32
         # @!attribute priority
         #  This router's Router Priority.  Used in (Backup) Designated
         #  Router election.
         #  @return [Integer]
-        define_field :priority, Types::Int8
+        define_attr :priority, BinStruct::Int8
         # @!macro define_ospfv3_options
         OSPFv3.define_options(self)
         # @!attribute hello_interval
         #  The number of seconds between this router's Hello packets.
         #  @return [Integer]
-        define_field :hello_interval, Types::Int16
+        define_attr :hello_interval, BinStruct::Int16
         # @!attribute dead_interval
         #  The number of seconds before declaring a silent router down.
         #  @return [Integer]
-        define_field :dead_interval, Types::Int16
+        define_attr :dead_interval, BinStruct::Int16
         # @!attribute designated_router
         #  The identity of the Designated Router for this network, in the
         #  view of the sending router.
         #  @return [String]
-        define_field :designated_router, IP::Addr
+        define_attr :designated_router, IP::Addr
         # @!attribute backup_designated_router
         #  The identity of the Backup Designated Router for this network,
         #  in the view of the sending router.
         #  @return [String]
-        define_field :backup_designated_router, IP::Addr
+        define_attr :backup_designated_router, IP::Addr
         # @!attribute neighbors
         #  Array of neighbors
         #  @return [IP::ArrayOfAddr]
-        define_field :neighbors, IP::ArrayOfAddr
+        define_attr :neighbors, IP::ArrayOfAddr
       end
     end
 

data/lib/packetgen/header/ospfv3/ipv6_prefix.rb

@@ -17,44 +17,42 @@ module PacketGen
       # * and an array of 32-bit words to encode prefix itself ({#prefix}). This
       #   array consumes ((PrefixLength + 31) / 32) 32-bit words.
       # @author Sylvain Daubert
-      class IPv6Prefix < Types::Fields
-        include Types::Fieldable
+      class IPv6Prefix < BinStruct::Struct
+        include BinStruct::Structable
 
         # @!attribute length
         #  Prefix length, in bits
         #  @return [Integer]
-        define_field :length, Types::Int8
+        define_attr :length, BinStruct::Int8
         # @!attribute options
         #  Prefix capabilities. See also capability bits: {#dn_opt}, {#p_opt},
         #  {#la_opt} and {#nu_opt}.
         #  @return [Options]
-        define_field :options, Types::Int8
-        # @!attribute reserved
-        #  Reserved field in most of LSA types.
-        #  @return [Integer]
-        define_field :reserved, Types::Int16
-        # @!attribute prefix
-        #  IPv6 Prefix as an array of 32-bit words
-        #  @return [Prefix]
-        define_field :prefix, Types::ArrayOfInt32, builder: ->(h, t) { t.new(length_from: -> { h.length / 8 }) }
-
         # @!attribute dn_opt
         #  This bit controls an inter-area-prefix-LSAs or AS-external-LSAs
         #  re-advertisement in a VPN environment.
-        #  @return [Boolean]
+        #  @return [Integer]
         # @!attribute p_opt
         #  The "propagate" bit.  Set on NSSA area prefixes that should be
         #  readvertised by the translating NSSA area border.
-        #  @return [Boolean]
+        #  @return [Integer]
         # @!attribute la_opt
         #  The "local address" capability bit.  If set, the prefix is
         #  actually an IPv6 interface address of the Advertising Router.
-        #  @return [Boolean]
+        #  @return [Integer]
         # @!attribute nu_opt
         #  The "no unicast" capability bit.  If set, the prefix should be
         #  excluded from IPv6 unicast calculations.
-        #  @return [Boolean]
-        define_bit_fields_on :options, :zz, 3, :dn_opt, :p_opt, :z, :la_opt, :nu_opt
+        #  @return [Integer]
+        define_bit_attr :options, zz: 3, dn_opt: 1, p_opt: 1, z: 1, la_opt: 1, nu_opt: 1
+        # @!attribute reserved
+        #  Reserved field in most of LSA types.
+        #  @return [Integer]
+        define_attr :reserved, BinStruct::Int16
+        # @!attribute prefix
+        #  IPv6 Prefix as an array of 32-bit words
+        #  @return [BinStruct::ArrayOfInt32]
+        define_attr :prefix, BinStruct::ArrayOfInt32, builder: ->(h, t) { t.new(length_from: -> { h.length / 8 }) }
 
         # Get human-readable prefix
         # @return [String]
@@ -70,7 +68,10 @@ module PacketGen
         # Set prefix from a human-readable string. This method cannot set
         # {#options} field.
         # @param [String] str
-        # @return [void]
+        # @return [self]
+        # @example
+        #   prefix = PacketGen::Header::OSPFv3::IPv6Prefix.new.from_human("2000::/64")
+        #   prefix.to_human #=> "2000::/64"
         def from_human(str)
           ary, len = ary_and_prefix_len_from_str(str)
 
@@ -83,6 +84,7 @@ module PacketGen
             end
           end
           self.length = len
+          self
         end
 
         private
@@ -100,7 +102,7 @@ module PacketGen
 
       # Array of {IPv6Prefix}
       # @author Sylvain Daubert
-      class ArrayOfIPv6Prefix < Types::Array
+      class ArrayOfIPv6Prefix < BinStruct::Array
         set_of IPv6Prefix
       end
     end

data/lib/packetgen/header/ospfv3/ls_ack.rb

@@ -23,25 +23,24 @@ module PacketGen
       # This paylod is implemented with only one field:
       # * {#lsas}, an {ArrayOfLSA} object.
       #
-      # == Create a LSAck payload
+      # @example Create a LSAck payload
       #   # standalone
       #   lsack = PacketGen::Header::OSPFv3::LSAck.new
       #   # in a packet
-      #   pkt = PacketGen.gen('IPv6', src: source_ip).add('OSPFv3').add('OSPFv3::LSAck')
+      #   pkt = PacketGen.gen('IPv6').add('OSPFv3').add('OSPFv3::LSAck')
       #   # access to LSAck payload
-      #   lasck = pkt.ospfv3_lsack    # => PacketGen::Header::OSPFv3::LSAck
+      #   lasck = pkt.ospfv3_lsack.class    # => PacketGen::Header::OSPFv3::LSAck
       #
-      # == Adding LSA headers to a LSAck payload
+      # @example Adding LSA headers to a LSAck payload
+      #   lsack = PacketGen::Header::OSPFv3::LSAck.new
       #   lsack.lsas << { type: 'Router', age: 40, link_state_id: '0.0.0.1', advertising_router: '1.1.1.1', sequence_number: 42, checksum: 0x1234, length: 56 }
-      #   # a header may also be set from an existing lsa
-      #   lasck.lsas << existing_lsa.to_lsa_header
       # @author Sylvain Daubert
       class LSAck < Base
         # @!attribute lsas
         #  Array of {LSA LSAs}
         #  @return [ArrayOfLSA]
-        define_field :lsas, ArrayOfLSA,
-                     builder: ->(_h, t) { t.new(only_headers: true) }
+        define_attr :lsas, ArrayOfLSA,
+                    builder: ->(_h, t) { t.new(only_headers: true) }
       end
     end
 

data/lib/packetgen/header/ospfv3/ls_request.rb

@@ -22,31 +22,31 @@ module PacketGen
       #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       #
       # It is composed of:
-      # * a 16-bit {#reserved} field,
-      # * a 16-bit {#type} field,
-      # * a 32-bit {#link_state_id} field,
-      # * and a 32-bit {#advertising_router} field.
+      # * a 16-bit {#reserved} field (+BinStruct::Int16+),
+      # * a 16-bit {#type} field (+BinStruct::Int16+),
+      # * a 32-bit {#link_state_id} field ({IP::Addr}),
+      # * and a 32-bit {#advertising_router} field ({IP::Addr}).
       # @author Sylvain Daubert
-      class LSR < Types::Fields
-        include Types::Fieldable
+      class LSR < BinStruct::Struct
+        include BinStruct::Structable
 
         # @!attribute reserved
         #  reserved field.
         #  @return [Integer]
-        define_field :reserved, Types::Int16, default: 0
+        define_attr :reserved, BinStruct::Int16, default: 0
         # @!attribute type
         #  The type of the LSA to request.
         #  @return [Integer]
-        define_field :type, Types::Int16Enum, enum: LSAHeader::TYPES
+        define_attr :type, BinStruct::Int16Enum, enum: LSAHeader::TYPES
         # @!attribute link_state_id
         #  This field identifies the portion of the internet environment
         #  that is being described by the LSA to request.
         #  @return [String]
-        define_field :link_state_id, IP::Addr
+        define_attr :link_state_id, IP::Addr
         # @!attribute advertising_router
         #  The Router ID of the requested LSA.
         #  @return [String]
-        define_field :advertising_router, IP::Addr
+        define_attr :advertising_router, IP::Addr
 
         # Get human-readable type
         # @return [String]
@@ -60,10 +60,9 @@ module PacketGen
         end
       end
 
-      # This class defines a specialized {Types::Array array} to handle series
-      # of {LSR LSRs}.
+      # This class defines a specialized array to handle series of {LSR LSRs}.
       # @author Sylvain Daubert
-      class ArrayOfLSR < Types::Array
+      class ArrayOfLSR < BinStruct::Array
         set_of LSR
       end
 
@@ -83,24 +82,25 @@ module PacketGen
       # This paylod is implemented as a unique field: {#lsrs}, which is an
       # {ArrayOfLSR} object.
       #
-      # == Create a LSRequest payload
+      # @example Create a LSRequest payload
       #   # standalone
       #   lsr = PacketGen::Header::OSPFv3::LSRequest.new
       #   # in a packet
-      #   pkt = PacketGen.gen('IPv6', src: source_ip).add('OSPFv3').add('OSPFv3::LSRequest')
+      #   pkt = PacketGen.gen('IPv6').add('OSPFv3').add('OSPFv3::LSRequest')
       #   # make IPv6 header correct for OSPF
       #   pkt.ospfize
       #   # access to LSRequest payload
-      #   pkt.ospfv3_lsrequest    # => PacketGen::Header::OSPFv3::LSRequest
+      #   pkt.ospfv3_lsrequest.class    # => PacketGen::Header::OSPFv3::LSRequest
       #
-      # == Add LSA requests to a LSRequest
+      # @example Add LSA requests to a LSRequest
+      #   lsr = PacketGen::Header::OSPFv3::LSRequest.new
       #   lsr.lsrs << { type: 'Router', link_state_id: '0.0.0.1', advertising_router: '1.1.1.1'}
       # @author Sylvain Daubert
       class LSRequest < Base
         # @!attribute lsrs
         #  Array of {LSR}
         #  @return [ArrayOfLSR]
-        define_field :lsrs, ArrayOfLSR
+        define_attr :lsrs, ArrayOfLSR
       end
     end