Class: PacketGen::Header::PPI

Inherits:

Base

• Object
• Types::Fields
• Base
• PacketGen::Header::PPI

Defined in:

lib/packetgen/header/dot11.rb

Overview

PPI (Per-Packet Information) packet

Author:

• Sylvain Daubert

Since:

• 1.4.0

Instance Attribute Summary

• #align ⇒ Boolean

  Align flag from #flags attribute.

• #body ⇒ Type::String
• #dlt ⇒ Integer

  32-bit PPI data link type.

• #flags ⇒ Integer

  8-bit PPI flags.

• #length ⇒ Integer

  16-bit PPI header length.

• #ppi_fields ⇒ Type::String

  Concatenation of PPI fields.

• #version ⇒ Integer

  8-bit PPI version.

Instance Method Summary

• #calc_length ⇒ Integer

  Calculate header length.

• #parse? ⇒ Boolean

  Check version field.

• #to_w(iface) ⇒ void

  send PPI packet on wire.

Methods inherited from Base

bind, calculate_and_set_length, #header_id, inherited, #initialize, #ip_header, #ll_header

Methods included from PacketGen::Headerable

#added_to_packet, included, #method_name, #packet, #packet=, #protocol_name, #read

Methods inherited from Types::Fields

#[], #[]=, #bits_on, define_bit_fields_on, define_field, define_field_after, define_field_before, #fields, fields, inherited, #initialize, #inspect, #offset_of, #optional?, #optional_fields, #present?, #read, remove_bit_fields_on, remove_field, #sz, #to_h, #to_s, update_field

Constructor Details

This class inherits a constructor from PacketGen::Header::Base

Instance Attribute Details

#align ⇒ Boolean

Returns align flag from #flags attribute.

Returns:

• (Boolean) —

  align flag from #flags attribute

# File 'lib/packetgen/header/dot11.rb', line 37

define_bit_fields_on :flags, :reserved, 7, :align

#body ⇒ Type::String

Returns:

• (Type::String)

# File 'lib/packetgen/header/dot11.rb', line 34

define_field :body, Types::String

#dlt ⇒ Integer

Returns 32-bit PPI data link type.

Returns:

• (Integer) —

  32-bit PPI data link type

# File 'lib/packetgen/header/dot11.rb', line 28

define_field :dlt, Types::Int32le

#flags ⇒ Integer

Returns 8-bit PPI flags.

Returns:

• (Integer) —

  8-bit PPI flags

# File 'lib/packetgen/header/dot11.rb', line 22

define_field :flags, Types::Int8

#length ⇒ Integer

Returns 16-bit PPI header length.

Returns:

• (Integer) —

  16-bit PPI header length

# File 'lib/packetgen/header/dot11.rb', line 25

define_field :length, Types::Int16le, default: 8

#ppi_fields ⇒ Type::String

Returns concatenation of PPI fields.

Returns:

• (Type::String) —

  concatenation of PPI fields

# File 'lib/packetgen/header/dot11.rb', line 31

define_field :ppi_fields, Types::String, builder: ->(h, t) { t.new(length_from: -> { h.length - 8 }) }

#version ⇒ Integer

Returns 8-bit PPI version.

Returns:

• (Integer) —

  8-bit PPI version

# File 'lib/packetgen/header/dot11.rb', line 19

define_field :version, Types::Int8, default: 0

Instance Method Details

#calc_length ⇒ Integer

Calculate header length

Returns:

• (Integer) —

  calculated length

Since:

• 2.1.3

# File 'lib/packetgen/header/dot11.rb', line 48

def calc_length
  self[:length].value = self.sz - self[:body].sz
end

#parse? ⇒ Boolean

Check version field

Returns:

• (Boolean)

See Also:

• PacketGen::Header::PPI.[Base[Base#parse?]

Since:

• 1.4.0

# File 'lib/packetgen/header/dot11.rb', line 41

def parse?
  version.zero? && (length >= 8)
end

#to_w(iface) ⇒ void

This method returns an undefined value.

send PPI packet on wire. Dot11 FCS trailer should be set.

Parameters:

• iface (String) —

  interface name

Since:

• 1.4.0

# File 'lib/packetgen/header/dot11.rb', line 55

def to_w(iface)
  Inject.inject(iface: iface, data: self)
end