wscout::gui::AbstractHeader Class Reference

Interface for protocol header widgets. More...

#include <wscout_gui_abstract_header.hh>

Inheritance diagram for wscout::gui::AbstractHeader:

wscout::gui::HeaderFrame wscout::gui::HeaderBase< Exact, Proto > wscout::gui::HeaderBase< wscout::gui::IEEE80211Header, protocol::IEEE802_11 > wscout::gui::HeaderBase< wscout::gui::PrismHeader, protocol::PRISM_HEADER > wscout::gui::IEEE80211Header wscout::gui::PrismHeader

List of all members.

Public Types

typedef std::pair
< protocol::id,
const void * > 
next_header

Public Member Functions

 AbstractHeader (QWidget *parent=0)
virtual next_header setup (const void *packet, size_t caplen)=0
QBoxLayout * layout ()


Detailed Description

Interface for protocol header widgets.

WScout models packets as a list of protocol headers. Each header is a Qt Widget that gets embedded inside the packet widget (Packet). In order to have Packet be independent of protocols, each protocol must satisfy a unified interface. AbstractHeader specify this interface.

To implement a new protocol, subclass HeaderBase and implement setup().

See also:
HeaderBase, Packet, HeaderFrame
Todo:
AbstractHeader inherits HeaderFrame. This is wrong. One should use multiple inheritance here.

Member Typedef Documentation

typedef std::pair<protocol::id, const void*> wscout::gui::AbstractHeader::next_header

Identify this header's next header.

The first element specifies the next header's protocol. The second one points to the next header's beginning of data.

If there is no next protocol, use protocol::NONE. If the next protocol is unknown, use protocol::UNKNOWN.

See also:
protocol::id


Constructor & Destructor Documentation

wscout::gui::AbstractHeader::AbstractHeader ( QWidget *  parent = 0  )  [inline]

Default constructor.

Each protcol header widget must provide a default constructor. Else Packet will no be able to instanciate it.


Member Function Documentation

virtual next_header wscout::gui::AbstractHeader::setup ( const void *  packet,
size_t  caplen 
) [pure virtual]

Setup the widget for a specific packet.

This method is purely abstract. You must define it when subclassing.

Parameters:
[in] packet Pointer to the packet's begining.
[in] caplen Number of availabe bytes for this packet.
Returns:
The next header's type and address.
See also:
next_header

Implemented in wscout::gui::IEEE80211Header, and wscout::gui::PrismHeader.

QBoxLayout * wscout::gui::HeaderFrame::layout (  )  [inherited]

This protocol header widget's layout.


The documentation for this class was generated from the following files:
Generated on Wed Sep 12 16:02:50 2007 for WScout by  doxygen 1.5.3