Main Page | Modules | Class Hierarchy | Class List | Directories | Class Members | Related Pages | Examples

NullKey Class Reference
[Network Data Structures]

dummy key indicating no key is being used More...

#include <Aggregate.h>

Inheritance diagram for NullKey:

StreamKey List of all members.

Public Member Functions

virtual bool operator== (const StreamKey &rhs) const
virtual bool operator< (const StreamKey &rhs) const
virtual const PacketAttributeValuegetAttrib (const PacketAttribute &attrib) const throw ( UnknownAttributeException )
virtual std::string toString (void) const
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

Static Public Attributes

static const StreamKey *const NULL_KEY = new NullKey()
static const uint32_t DIR_FORWARD = 0
static const uint32_t DIR_REVERSE = 1

Friends

class StreamKey

Detailed Description

dummy key indicating no key is being used


Member Function Documentation

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

operator> provided to support fast searching in a data structure

Implements StreamKey.

uint32_t StreamKey::getDirection const TraceIterator packet  )  const [virtual, inherited]
 

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 in FullIPv4SessionKey, IPv4Key, and TransportKey.

bool NullKey::operator< const StreamKey rhs  )  const [virtual]
 

operator< provided to support fast searching in a data structure

Implements StreamKey.

bool NullKey::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.

const StreamKey *const NullKey::NULL_KEY = new NullKey() [static]
 

The one instance of a NullKey, used to indicate that no key is being used (Gang of four design pattern "Singleton")


The documentation for this class was generated from the following files:
Generated on Thu Apr 5 01:02:38 2007 for ANTARES by  doxygen 1.4.2