rtap::header Struct Reference

Radiotap header format. More...

#include <wipal/phy/rtap_header.hh>

Inheritance diagram for rtap::header:

phy::header< rtap::header > tool::static_base< rtap::header >

List of all members.

Public Types

enum  field {
  tsft = 0x00000001, flags = 0x00000002, rate = 0x00000004, channel = 0x00000008,
  fhss = 0x00000010, dbm_antsignal = 0x00000020, dbm_antnoise = 0x00000040, lock_quality = 0x00000080,
  tx_attenuation = 0x00000100, db_tx_attenuation = 0x00000200, dbm_tx_power = 0x00000400, antenna = 0x00000800,
  db_antsignal = 0x00001000, db_antnoise = 0x00002000, ext = 0x10000000
}
Static hierarchies related types
typedef HIDDEN time_type

Public Member Functions

const void * first_field (size_t caplen) const
void * first_field (size_t caplen)
uint64_t tsft_get (size_t caplen) const
size_t len (size_t caplen, bool swapped) const
const void * decapsulate (size_t caplen, bool swapped) const
time_type time_get (bool swapped) const
void time_set (const time_type &time, bool swapped)
Downcast methods
const exact_typeexact () const
exact_typeexact ()
const exact_typeexact_ptr () const
exact_typeexact_ptr ()

Static Public Member Functions

static bool eq_80211 (const pcapxx::frame_descriptor< D1 > &lhs, const pcapxx::frame_descriptor< D2 > &rhs, tool::endian::endianness phy_end=tool::endian::guess)
static bool eq_time_and_80211 (const pcapxx::frame_descriptor< D1 > &lhs, const pcapxx::frame_descriptor< D2 > &rhs, const unsigned precision, const tool::endian::endianness phy_end=tool::endian::guess)

Public Attributes

uint8_t it_version
uint8_t it_pad
uint16_t it_len
uint32_t it_present

Static hierarchies related types and methods.

typedef rtap::header exact_type
typedef WP_TYPE_ (time_type, exact_type) time_type
size_t len_impl (size_t, bool) const
time_type time_get_impl (bool) const
void time_set_impl (const time_type &, bool)
template<class D1 , class D2 >
static bool eq_time (const pcapxx::frame_descriptor< D1 > &lhs, const pcapxx::frame_descriptor< D2 > &rhs, const unsigned prec, const tool::endian::endianness phy_end)


Detailed Description

Radiotap header format.

Member Typedef Documentation

Exact type for this template instanciation.

See also:
static_base

Reimplemented from phy::header< rtap::header >.


Member Function Documentation

const void* phy::header< rtap::header >::decapsulate ( size_t  caplen,
bool  swapped 
) const [inherited]

Get the embedded IEEE 802.11 frame.

Return 0 if len() > caplen.

This method relies on len(). You should not need to override it if your subclasses define a proper len_impl().

static bool phy::header< rtap::header >::eq_80211 ( const pcapxx::frame_descriptor< D1 > &  lhs,
const pcapxx::frame_descriptor< D2 > &  rhs,
tool::endian::endianness  phy_end = tool::endian::guess 
) [inline, static, inherited]

Compare the IEEE 802.11 bytes beyond the PHY header.

Return whether the two IEEE 802.11 frames embedded inside the PHY headers are equals. This function does not compare the PHY headers.

In case there is not enough bytes to decide whether frames are equal (caplen < sizeof prism::header), consider they are not. This is a conservative approach: when merging two traces, this will lead to both frames having their entry in the merged trace.

This method relies on decapsulate(). You should not need to override it if your subclasses define a proper decapsulate_impl().

static bool phy::header< rtap::header >::eq_time_and_80211 ( const pcapxx::frame_descriptor< D1 > &  lhs,
const pcapxx::frame_descriptor< D2 > &  rhs,
const unsigned  precision,
const tool::endian::endianness  phy_end = tool::endian::guess 
) [inline, static, inherited]

Compare the IEEE 802.11 bytes beyond PHY headers, but also check timestamps.

Return whether the two IEEE 802.11 frames embedded inside the PHY headers are equals. Also compare the timestamps of PHY headers if available (or the PCAP timestamps else). When the time difference between each header's field is less than precision, then consider the field equals.

In case there is not enough bytes to decide whether frames are equal (caplen < sizeof prism::header), consider they are not. This is a conservative approach: when merging two traces, this will lead to both frames having their entry in the merged trace.

This method relies on eq_time(). You should not need to override it if your subclasses define a proper eq_time().

exact_type& tool::static_base< rtap::header >::exact (  )  [inherited]

Safely downcast to the exact type as a non-const reference.

const exact_type& tool::static_base< rtap::header >::exact (  )  const [inherited]

Safely downcast to the exact type as a const reference.

exact_type* tool::static_base< rtap::header >::exact_ptr (  )  [inherited]

Safely downcast to the exact type as a non-const pointer.

const exact_type* tool::static_base< rtap::header >::exact_ptr (  )  const [inherited]

Safely downcast to the exact type as a const pointer.

void * rtap::header::first_field ( size_t  caplen  )  [inline]

Get the Radiotap header's first field address (or 0 if not available).

Non-const version.

Warning:
This function does not check the radiotap header's version.

const void * rtap::header::first_field ( size_t  caplen  )  const [inline]

Get the Radiotap header's first field address (or 0 if not available).

Const version.

Warning:
This function does not check the radiotap header's version.

size_t phy::header< rtap::header >::len ( size_t  caplen,
bool  swapped 
) const [inherited]

Get the PHY header length.

Never override this method. Define len_impl() in subclasses instead.

time_type phy::header< rtap::header >::time_get ( bool  swapped  )  const [inherited]

Extract timing information from the PHY header.

Never override this method. Define time_get_impl() in subclasses instead.

void phy::header< rtap::header >::time_set ( const time_type &  time,
bool  swapped 
) [inherited]

Set the PHY header's timing information.

Never override this method. Define time_set_impl() in subclasses instead.

uint64_t rtap::header::tsft_get ( size_t  caplen  )  const [inline]

Get the Radiotap header TSFT field, or throw std::invalid_argument.


Member Data Documentation

Header's entire length.

Padding; undefined.

Available fields.

Must be zero.


The documentation for this struct was generated from the following files:

Generated on Wed Apr 22 22:52:43 2009 for wipal by  doxygen 1.5.8