packetgen 3.3.3 → 4.1.0

data/lib/packetgen/header/sctp/chunk.rb

@@ -11,7 +11,7 @@ require_relative 'padded32'
 module PacketGen
   module Header
     class SCTP
-      # BaseChunk class, defining SCTP chunk common fields
+      # Base SCTP chunk class, defining SCTP chunk common fields.
       #   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
       #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
@@ -42,32 +42,32 @@ module PacketGen
         # @!attribute type
         #  8-bit SCTP chunk type
         #  @return [Integer]
-        define_field :type, Types::Int8Enum, enum: TYPES
+        define_attr :type, BinStruct::Int8Enum, enum: TYPES
         # @!attribute type
         #  8-bit SCTP chunk flags
         #  @return [Integer]
-        define_field :flags, Types::Int8
+        define_attr :flags, BinStruct::Int8
         # @!attribute length
         #  16-bit SCTP chunk length
         #  @return [Integer]
-        define_field :length, Types::Int16
+        define_attr :length, BinStruct::Int16
 
         # Get human-redable chunk
         # @return [::String]
         def to_human
-          str = +"<chunk:#{human_type}"
+          str = "<chunk:#{human_type}"
           flags_str = flags_to_human
           str << ",flags:#{flags_str}" unless flags_str.empty?
           str << '>'
         end
 
+        # Get human-readable type
         # @return [::String,Integer]
         def human_type
           self[:type].to_human
         end
 
-        # Calculate and set chunk length
-        # @todo do not count last parameter padding
+        # Calculate and set chunk {#length}
         # @return [Integer]
         def calc_length
           self.length = to_s(no_padding: true).size
@@ -91,7 +91,7 @@ module PacketGen
     class SCTP
       # Embed chunks for a given {SCTP} packet.
       # @author Sylvain Daubert
-      class ArrayOfChunk < Types::Array
+      class ArrayOfChunk < BinStruct::Array
         set_of BaseChunk
 
         private
@@ -121,10 +121,10 @@ module PacketGen
         # @!attribute body
         #  SCTP chunk value
         #  @return [String]
-        define_field :body, Types::String, builder: ->(h, t) { t.new(length_from: -> { h.length - 4 }) }
+        define_attr :body, BinStruct::String, builder: ->(h, t) { t.new(length_from: -> { h.length - 4 }) }
       end
 
-      # Data chunk
+      # Data chunk. This SCTP chunk embeds user data.
       #   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
       #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
@@ -143,39 +143,40 @@ module PacketGen
       # @author Sylvain Daubert
       class DataChunk < BaseChunk
         # @!attribute tsn
-        #   32-bit TSN for this DATA chunk
+        #   32-bit Transmission Sequence Number for this DATA chunk
         #   @return [Integer]
-        define_field :tsn, Types::Int32
+        define_attr :tsn, BinStruct::Int32
         # @!attribute stream_id
         #  16-bit stream identifier
         #  @return [Integer]
-        define_field :stream_id, Types::Int16
+        define_attr :stream_id, BinStruct::Int16
         # @!attribute stream_sn
         #  16-bit stream sequence number
         #  @return [Integer]
-        define_field :stream_sn, Types::Int16
+        define_attr :stream_sn, BinStruct::Int16
         # @!attribute ppid
         #  32-bit payload protocol identifier
         #  @return [Integer]
-        define_field :ppid, Types::Int32
+        define_attr :ppid, BinStruct::Int32
         # @!attribute body
-        #  SCTP chunk value
+        #  User data
         #  @return [String]
-        define_field :body, Types::String, builder: ->(h, t) { t.new(length_from: -> { h.length - 4 }) }
+        define_attr :body, BinStruct::String, builder: ->(h, t) { t.new(length_from: -> { h.length - 4 }) }
 
+        remove_attr :flags
         # @!attribute flag_i
         #  IMMEDIATE flag
-        #  @return [Boolean]
+        #  @return [Integer]
         # @!attribute flag_u
-        #  UNORDERED flag
-        #  @return [Boolean]
+        #  UNORDERED flag. If set, no Stream Sequence Number is assigned to this chunk.
+        #  @return [Integer]
         # @!attribute flag_b
-        #  BEGINNING fragment flag
-        #  @return [Boolean]
+        #  BEGINNING fragment flag. If set, indicate the first fragment of a user message.
+        #  @return [Integer]
         # @!attribute flag_e
-        #  ENDING fragment flag
-        #  @return [Boolean]
-        define_bit_fields_on :flags, :flag_res, 4, :flag_i, :flag_u, :flag_b, :flag_e
+        #  ENDING fragment flag. If set, indicate the last fragment of a user message.
+        #  @return [Integer]
+        define_bit_attr_after :type, :flags, flag_res: 4, flag_i: 1, flag_u: 1, flag_b: 1, flag_e: 1
 
         private
 
@@ -189,7 +190,7 @@ module PacketGen
         end
       end
 
-      # Init Chunk
+      # Init Chunk. This chunk is used to initiate an SCTP association.
       #         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
       #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
@@ -212,27 +213,27 @@ module PacketGen
         # @!attribute initiate_tag
         #   32-bit Initiate Tag
         #   @return [Integer]
-        define_field :initiate_tag, Types::Int32
+        define_attr :initiate_tag, BinStruct::Int32
         # @!attribute a_wrnd
         #   32-bit Advertised Receiver Window Credit (a_rwnd)
         #   @return [Integer]
-        define_field :a_rwnd, Types::Int32
+        define_attr :a_rwnd, BinStruct::Int32
         # @!attribute nos
         #   16-bit Number of Outbound Streams
         #   @return [Integer]
-        define_field :nos, Types::Int16
+        define_attr :nos, BinStruct::Int16
         # @!attribute nis
         #   16-bit Number of Inbound Streams
         #   @return [Integer]
-        define_field :nis, Types::Int16
+        define_attr :nis, BinStruct::Int16
         # @!attribute initial_tsn
         #   32-bit Initial TSN
         #   @return [Integer]
-        define_field :initial_tsn, Types::Int32
+        define_attr :initial_tsn, BinStruct::Int32
         # @!attribute parameters
         #  List of parameters
         #  @return [ArrayOfParameter]
-        define_field :parameters, ArrayOfParameter
+        define_attr :parameters, ArrayOfParameter
 
         def initialize(options={})
           options[:type] = BaseChunk::TYPES['INIT'] unless options.key?(:type)
@@ -240,15 +241,16 @@ module PacketGen
         end
 
         # Calculate lengths, including parameters ones.
-        # @return [void]
+        # @return [Integer] chunk length
         def calc_length
           parameters.each(&:calc_length)
           super
         end
 
-        # @return [::String]
+        # Get human-redable description.
+        # @return [String]
         def to_human
-          str = +"<chunk:#{human_type}"
+          str = "<chunk:#{human_type}"
           flags_str = flags_to_human
           str << ",flags:#{flags_str}" unless flags_str.empty?
           str << ",param:#{parameters.map(&:to_human).join(',')}" unless parameters.empty?
@@ -315,28 +317,28 @@ module PacketGen
         # @!attribute ctsn_ack
         #   32-bit Cumulative TSN Ack
         #   @return [Integer]
-        define_field :ctsn_ack, Types::Int32
+        define_attr :ctsn_ack, BinStruct::Int32
         # @!attribute a_rwnd
         #   32-bit Advertised Receiver Window Credit
         #   @return [Integer]
-        define_field :a_rwnd, Types::Int32
+        define_attr :a_rwnd, BinStruct::Int32
         # @!attribute num_gap
         #   16-bit Number of Gap Ack Blocks
         #   @return [Integer]
-        define_field :num_gap, Types::Int32
+        define_attr :num_gap, BinStruct::Int32
         # @!attribute num_dup_tsn
         #   16-bit Number of Duplicate TSNs
         #   @return [Integer]
-        define_field :num_dup_tsn, Types::Int32
+        define_attr :num_dup_tsn, BinStruct::Int32
         # @!attribute gaps
         #   Array of 32-bit Integers, encoding boudaries of a Gap Ack Block.
         #   16 most significant bits encode block start. 16 least significant bits encode block end.
-        #   @return [Types::ArrayOfInt32]
-        define_field :gaps, Types::ArrayOfInt32
+        #   @return [BinStruct::ArrayOfInt32]
+        define_attr :gaps, BinStruct::ArrayOfInt32
         # @!attribute dup_tsns
         #   Array of 32-bit Duplicate TSNs.
-        #   @return [Types::ArrayOfInt32]
-        define_field :dup_tsns, Types::ArrayOfInt32
+        #   @return [BinStruct::ArrayOfInt32]
+        define_attr :dup_tsns, BinStruct::ArrayOfInt32
 
         def initialize(options={})
           options[:type] = BaseChunk::TYPES['SACK'] unless options.key?(:type)
@@ -344,6 +346,17 @@ module PacketGen
         end
       end
 
+      # @!parse
+      #  # Heartbeat Information.
+      #  # @author LemonTree55
+      #  # @since 4.1.0 Replace +HeartbeatInfoParameter+
+      #  class HeartbeatInfo < BinStruct::AbstractTLV; end
+      HearbeatInfo = BinStruct::AbstractTLV.create(type_class: BinStruct::Int16Enum,
+                                                   length_class: BinStruct::Int16,
+                                                   attr_in_length: 'TLV')
+      HearbeatInfo.define_type_enum({ 'HearbeatInfo' => 1 }.freeze)
+      HearbeatInfo.define_type_default('HearbeatInfo')
+
       # Heartbeat Request Chunk
       #         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
@@ -355,11 +368,14 @@ module PacketGen
       #  \                                                               \
       #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       # @author Sylvain Daubert
+      # @author LemonTree55
+      # @since 3.4.0
+      # @since 4.1.0 {#info} is now a {HeartbeatInfo}
       class HeartbeatChunk < BaseChunk
         # @!attribute info
-        #   Array of Heartbeat information TLV.
-        #   @return [Types::ArrayOfInt32]
-        define_field :info, HearbeatInfoParameter
+        #   Heartbeat information TLV.
+        #   @return [HearbeatInfo]
+        define_attr :info, HearbeatInfo
 
         def initialize(options={})
           options[:type] = BaseChunk::TYPES['HEARTBEAT'] unless options.key?(:type)
@@ -378,6 +394,8 @@ module PacketGen
       #  \                                                               \
       #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       # @author Sylvain Daubert
+      # @since 3.4.0
+      # @since 4.1.0 {#info} is now a {HeartbeatInfo}
       class HeartbeatAckChunk < HeartbeatChunk
         def initialize(options={})
           options[:type] = BaseChunk::TYPES['HEARTBEAT_ACK'] unless options.key?(:type)
@@ -398,24 +416,26 @@ module PacketGen
       # @author Sylvain Daubert
       class ErrorChunk < BaseChunk
         # @!attribute error_causes
-        #  @return [ArrayofError]
-        define_field :error_causes, ArrayOfError
+        #  Causes for this error chunk
+        #  @return [ArrayOfError]
+        define_attr :error_causes, ArrayOfError
 
         def initialize(options={})
           options[:type] = BaseChunk::TYPES['ERROR'] unless options.key?(:type)
           super
         end
 
-        # Calculate lengths, including parameters ones.
+        # Calculate lengths, including causes ones.
         # @return [void]
         def calc_length
           error_causes.each(&:calc_length)
           super
         end
 
+        # Get human-readable description
         # @return [::String]
         def to_human
-          str = +"<chunk:#{human_type}"
+          str = "<chunk:#{human_type}"
           flags_str = flags_to_human
           str << ",flags:#{flags_str}" unless flags_str.empty?
           str << ",causes:#{error_causes.map(&:to_human).join(',')}" unless error_causes.empty?
@@ -435,9 +455,11 @@ module PacketGen
       #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       # @author Sylvain Daubert
       class AbortChunk < ErrorChunk
+        remove_attr :flags
         # @!attribute flag_t
-        #  @return [Boolean]
-        define_bit_fields_on :flags, :flag_res, 7, :flag_t
+        #  Reflecting bit
+        #  @return [Integer]
+        define_bit_attr_after :type, :flags, flag_res: 7, flag_t: 1
 
         def initialize(options={})
           options[:type] = BaseChunk::TYPES['ABORT'] unless options.key?(:type)
@@ -464,7 +486,7 @@ module PacketGen
         # @!attribute cstn_ack
         #  32-bit cumulative TSN ack
         #  @return [Integer]
-        define_field :ctsn_ack, Types::Int32
+        define_attr :ctsn_ack, BinStruct::Int32
 
         def initialize(options={})
           options[:type] = BaseChunk::TYPES['SHUTDOWN'] unless options.key?(:type)
@@ -500,8 +522,9 @@ module PacketGen
       # @author Sylvain Daubert
       class CookieEchoChunk < BaseChunk
         # @!attribute cookie
+        #  Cookie value
         #  @return [String]
-        define_field :cookie, Types::String
+        define_attr :cookie, BinStruct::String
 
         def initialize(options={})
           options[:type] = BaseChunk::TYPES['COOKIE_ECHO'] unless options.key?(:type)
@@ -532,9 +555,10 @@ module PacketGen
       #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       # @author Sylvain Daubert
       class ShutdownCompleteChunk < BaseChunk
+        remove_attr :flags
         # @!attribute flag_t
-        #  @return [Boolean]
-        define_bit_fields_on :flags, :flag_res, 7, :flag_t
+        #  @return [Integer]
+        define_bit_attr_after :type, :flags, flag_res: 7, flag_t: 1
 
         def initialize(options={})
           options[:type] = BaseChunk::TYPES['SHUTDOWN_COMPLETE'] unless options.key?(:type)