TransportKey Class Reference

StreamKey used to decompose an Aggregate by host pair and transport protocol. More...

#include <TransportKey.h>

Inheritance diagram for TransportKey:

List of all members.

Public Member Functions
	TransportKey (const StreamKey &pair, uint32_t proto)
	TransportKey (const TransportKey &toCopy)
virtual TransportKey *	clone (void) const
virtual bool	operator== (const StreamKey &rhs) const
virtual bool	operator< (const StreamKey &rhs) const
virtual bool	isBidirectional (void) const
virtual uint32_t	getDirection (const TraceIterator &packet) const
	determine the direction of a packet relative to a bidirectional StreamKey
virtual const PacketAttributeValue &	getAttrib (const PacketAttribute &attrib) const throw ( UnknownAttributeException )
	Get a packet attribute for the entire stream keyed by the 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 and transport protocol.

Attributes

Available attributes from a TransportKey:

• network.proto - protocol identifier from the network layer (e.g. IPv4 next protocol field)

---

Member Function Documentation

const PacketAttributeValue & TransportKey::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 TransportKey::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 TransportKey::isBidirectional (  void   )  const [virtual]

operator> provided to support fast searching in a data structure Reimplemented from StreamKey.

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

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

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

compare two StreamKeys for equality Implements StreamKey.

---

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/TransportKey.h
• protocols/datatypes/TransportKey.cc

---