IPv4Key Class Reference

StreamKey used to decompose an Aggregate by host pair. More...

#include <IPv4Key.h>

Inheritance diagram for IPv4Key:

List of all members.

Public Member Functions
	IPv4Key (IPv4Addr source, IPv4Addr dest, bool bi=true)
	IPv4Key (const IPv4Key &toCopy)
virtual IPv4Key *	clone (void) const
virtual bool	operator== (const StreamKey &rhs) const
virtual bool	operator< (const StreamKey &rhs) const
virtual void	setBidirectional (bool bi)
virtual const PacketAttributeValue &	getAttrib (const PacketAttribute &attrib) const throw ( UnknownAttributeException )
	Get a packet attribute for the entire stream keyed by the StreamKey.
virtual bool	isBidirectional (void) const
	Does the stream represent both sides of a bidirectional flow?
virtual uint32_t	getDirection (const TraceIterator &packet) const
	determine the direction of a packet relative to a bidirectional StreamKey
virtual std::string	toString (void) const
Static Public Attributes
static const uint32_t	DIR_FORWARD = 0
static const uint32_t	DIR_REVERSE = 1

---

Detailed Description

StreamKey used to decompose an Aggregate by host pair.

Attributes

Attributes available from an IPv4Key

• ipv4.src - IPv4 source address
• ipv4.dst - IPv4 destination address

---

Member Function Documentation

const PacketAttributeValue & IPv4Key::getAttrib (  const PacketAttribute &  attrib  )  const throw ( UnknownAttributeException ) [virtual]

Get a packet attribute for the entire stream keyed by the StreamKey. Exceptions: UnknownAttributeException  The StreamKey does not deal with this PacketAttribute, so packets may or may not meet the criterion. Implements StreamKey.

uint32_t IPv4Key::getDirection (  const TraceIterator &  packet  )  const [virtual]

determine the direction of a packet relative to a bidirectional StreamKey Returns: StreamKey::DIR_FORWARD if the packet is in the forward direction (always true for a unidirectional StreamKey), StreamKey::DIR_REVERSE if it is in the reverse direction Todo: Possible support for StreamKeys with more than two directions? Reimplemented from StreamKey.

bool IPv4Key::operator< (  const StreamKey &  rhs  )  const [virtual]

operator< provided to support fast searching in a data structure Implements StreamKey.

bool IPv4Key::operator== (  const StreamKey &  rhs  )  const [virtual]

compare two StreamKeys for equality Implements StreamKey.

void IPv4Key::setBidirectional (  bool  bi  )  [virtual]

operator> provided to support fast searching in a data structure

---

Member Data Documentation

const uint32_t StreamKey::DIR_FORWARD = 0 [static, inherited]

Last type identifier used by a StreamKey subclass; a new StreamKey should use a type identifier one greater than this.

---

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

• protocols/datatypes/IPv4Key.h
• protocols/datatypes/IPv4Key.cc

---