wpl::prism::header Struct Reference

Prism header format. More...

#include <wipal/phy/prism_header.hh>

Inheritance diagram for wpl::prism::header:

List of all members.

Public Types
enum	{ devnamelen_max = 16 }
typedef prism::header	exact_type
typedef HIDDEN	time_type
Public Member Functions
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)
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_type &	exact () const
exact_type &	exact ()
const exact_type *	exact_ptr () const
exact_type *	exact_ptr ()
Static Public Member Functions
template<class S1 , class S2 >
static bool	eq_time (const pkt::packet< S1 > &lhs, const pkt::packet< S2 > &rhs, const unsigned prec, const tool::end::endianness phy_end)
static bool	eq_80211 (const pkt::packet< S1 > &lhs, const pkt::packet< S2 > &rhs, tool::end::endianness phy_end=tool::end::guess)
static bool	eq_time_and_80211 (const pkt::packet< S1 > &lhs, const pkt::packet< S2 > &rhs, const unsigned precision, const tool::end::endianness phy_end=tool::end::guess)
Public Attributes
uint32_t	msgcode
uint32_t	msglen
uint8_t	devname [devnamelen_max]
item	hosttime
item	mactime
item	channel
item	rssi
item	sq
item	signal
item	noise
item	rate
item	istx
item	frmlen

---

Detailed Description

Prism header format.

---

Member Typedef Documentation

typedef prism::header wpl::prism::header::exact_type

Exact type for this template instanciation.

See also:

static_base

Reimplemented from wpl::phy::header< prism::header >.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

devnamelen_max

devname 's maximum length.

---

Member Function Documentation

const void* wpl::phy::header< prism::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 wpl::phy::header< prism::header >::eq_80211	(	const pkt::packet< S1 > &	lhs,
		const pkt::packet< S2 > &	rhs,
		tool::end::endianness	phy_end = tool::end::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 wpl::phy::header< prism::header >::eq_time_and_80211	(	const pkt::packet< S1 > &	lhs,
		const pkt::packet< S2 > &	rhs,
		const unsigned	precision,
		const tool::end::endianness	phy_end = tool::end::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().

size_t wpl::phy::header< prism::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 wpl::phy::header< prism::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 wpl::phy::header< prism::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.

---

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

• include/wipal/phy/prism_header.hh
• include/wipal/phy/prism_header.hxx