ArtsIpPathData

[ libArts | Source | Keywords | Summary | Ancestors | All Members | Descendants ]

Quick Index

DESCRIPTION

Class Summary

class ArtsIpPathData

{

public:
ArtsIpPathData(ipv4addr_t src, ipv4addr_t dst);
ArtsIpPathData(const ArtsIpPathData & artsIpPathData);
ArtsIpPathData();
~ArtsIpPathData();
ostream& write(ostream& os, uint8_t version );
int write(int fd, uint8_t version );
istream& read(istream& is, uint8_t version );
int read(int fd, uint8_t version );
ipv4addr_t Src() const ;
ipv4addr_t Src(ipv4addr_t src) ;
ipv4addr_t Dst() const ;
ipv4addr_t Dst(ipv4addr_t dst) ;
const struct timeval & Rtt() const ;
const struct timeval & Rtt(const struct timeval & rtt) ;
uint8_t HopDistance() const ;
uint8_t HopDistance(uint8_t hopDistance) ;
uint8_t IsComplete() const ;
uint8_t IsComplete(uint8_t isComplete) ;
uint8_t NumHops() const ;
uint8_t NumHops(uint8_t numHops) ;
vector<ArtsIpPathEntry> & Path() const ;
void AddHop(ipv4addr_t ipAddr, uint8_t hopNum);
uint32_t Length(uint8_t version ) const ;
ArtsIpPathData & operator = (const ArtsIpPathData & artsIpPathData);
friend ostream& operator << (ostream& os, const ArtsIpPathData & artsIpPathData);
protected:
}; // ArtsIpPathData

Back to the top of ArtsIpPathData

DESCRIPTION


++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
class ArtsIpPathData
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

Back to the top of ArtsIpPathData

ArtsIpPathData(ipv4addr_t src, ipv4addr_t dst);


------------------------------------------------------------------------
ArtsIpPathData(ipv4addr_t src, ipv4addr_t dst)
........................................................................
constructor
------------------------------------------------------------------------

  ArtsIpPathData(ipv4addr_t src, ipv4addr_t dst);

Back to the top of ArtsIpPathData

ArtsIpPathData(const ArtsIpPathData & artsIpPathData);


-------------------------------------------------------------------------
ArtsIpPathData(const ArtsIpPathData & artsIpPathData)
.........................................................................
copy constructor
-------------------------------------------------------------------------

  ArtsIpPathData(const ArtsIpPathData & artsIpPathData);

Back to the top of ArtsIpPathData

ArtsIpPathData();


------------------------------------------------------------------------
ArtsIpPathData()
........................................................................
default constructor
------------------------------------------------------------------------

  ArtsIpPathData();

Back to the top of ArtsIpPathData

~ArtsIpPathData();


------------------------------------------------------------------------
~ArtsIpPathData()
........................................................................
destructor
------------------------------------------------------------------------

  ~ArtsIpPathData();

Back to the top of ArtsIpPathData

ostream& write(ostream& os, uint8_t version );


-------------------------------------------------------------------------
ostream& write(ostream& os, uint8_t version = 0)
.........................................................................
Writes IP path data to an ostream.
-------------------------------------------------------------------------

  ostream& write(ostream& os, uint8_t version = 0);

Back to the top of ArtsIpPathData

int write(int fd, uint8_t version );


-------------------------------------------------------------------------
int write(int fd, uint8_t version = 0)
.........................................................................
Writes IP path data to a file descriptor. Returns the number of bytes written on success, -1 on failure.
-------------------------------------------------------------------------

  int write(int fd, uint8_t version = 0);

Back to the top of ArtsIpPathData

istream& read(istream& is, uint8_t version );


-------------------------------------------------------------------------
istream& read(istream& is, uint8_t version = 0)
.........................................................................
Reads IP path data from an istream.
-------------------------------------------------------------------------

  istream& read(istream& is, uint8_t version = 0);

Back to the top of ArtsIpPathData

int read(int fd, uint8_t version );


-------------------------------------------------------------------------
int read(int fd, uint8_t version = 0)
.........................................................................
UNTESTED
-------------------------------------------------------------------------

  int read(int fd, uint8_t version = 0);  // UNTESTED

Back to the top of ArtsIpPathData

ipv4addr_t Src() const ;


-------------------------------------------------------------------------
inline ipv4addr_t Src() const
.........................................................................
Returns the source address of the IP path.
-------------------------------------------------------------------------

  inline ipv4addr_t Src() const
                               
;

Function is currently defined inline.


Back to the top of ArtsIpPathData

ipv4addr_t Src(ipv4addr_t src) ;


-------------------------------------------------------------------------
inline ipv4addr_t Src(ipv4addr_t src)
.........................................................................
Sets and returns the source address of the IP path.
-------------------------------------------------------------------------

  inline ipv4addr_t Src(ipv4addr_t src)
                                                     
;

Function is currently defined inline.


Back to the top of ArtsIpPathData

ipv4addr_t Dst() const ;


-------------------------------------------------------------------------
inline ipv4addr_t Dst() const
.........................................................................
Returns the path destination IP address.
-------------------------------------------------------------------------

  inline ipv4addr_t Dst() const
                               
;

Function is currently defined inline.


Back to the top of ArtsIpPathData

ipv4addr_t Dst(ipv4addr_t dst) ;


-------------------------------------------------------------------------
inline ipv4addr_t Dst(ipv4addr_t dst)
.........................................................................
Sets and returns the path destination IP address.
-------------------------------------------------------------------------

  inline ipv4addr_t Dst(ipv4addr_t dst)
                                                     
;

Function is currently defined inline.


Back to the top of ArtsIpPathData

const struct timeval & Rtt() const ;


-------------------------------------------------------------------------
inline const struct timeval & Rtt() const
.........................................................................
Returns the round-trip time from the source to the destination and back.
-------------------------------------------------------------------------

  inline const struct timeval & Rtt() const
                               
;

Function is currently defined inline.


Back to the top of ArtsIpPathData

const struct timeval & Rtt(const struct timeval & rtt) ;


-------------------------------------------------------------------------
inline const struct timeval & Rtt(const struct timeval & rtt)
.........................................................................
Sets and returns the round-trip time from the source to the destination and back.
-------------------------------------------------------------------------

  inline const struct timeval & Rtt(const struct timeval & rtt)
                                                                                                         
;

Function is currently defined inline.


Back to the top of ArtsIpPathData

uint8_t HopDistance() const ;


-------------------------------------------------------------------------
inline uint8_t HopDistance() const
.........................................................................
Returns the hop distance from the source to the destination.
-------------------------------------------------------------------------

  inline uint8_t HopDistance() const
                                       
;

Function is currently defined inline.


Back to the top of ArtsIpPathData

uint8_t HopDistance(uint8_t hopDistance) ;


-------------------------------------------------------------------------
inline uint8_t HopDistance(uint8_t hopDistance)
.........................................................................
Sets and returns the hop distance from the source to the destination.
-------------------------------------------------------------------------

  inline uint8_t HopDistance(uint8_t hopDistance)
                                                                             
;

Function is currently defined inline.


Back to the top of ArtsIpPathData

uint8_t IsComplete() const ;


-------------------------------------------------------------------------
inline uint8_t IsComplete() const
.........................................................................
Returns 1 if path is complete (destination reached), else returns 0.
-------------------------------------------------------------------------

  inline uint8_t IsComplete() const
                                      
;

Function is currently defined inline.


Back to the top of ArtsIpPathData

uint8_t IsComplete(uint8_t isComplete) ;


-------------------------------------------------------------------------
inline uint8_t IsComplete(uint8_t isComplete)
.........................................................................
Sets and returns path complete indicator.
-------------------------------------------------------------------------

  inline uint8_t IsComplete(uint8_t isComplete)
                                                                          
;

Function is currently defined inline.


Back to the top of ArtsIpPathData

uint8_t NumHops() const ;


-------------------------------------------------------------------------
inline uint8_t NumHops() const
.........................................................................
Returns the number of hops stored in the path vector.
-------------------------------------------------------------------------

  inline uint8_t NumHops() const
                                   
;

Function is currently defined inline.


Back to the top of ArtsIpPathData

uint8_t NumHops(uint8_t numHops) ;


-------------------------------------------------------------------------
inline uint8_t NumHops(uint8_t numHops)
.........................................................................
Sets and returns the number of hops stored in the path vector.
-------------------------------------------------------------------------

  inline uint8_t NumHops(uint8_t numHops)
                                                                 
;

Function is currently defined inline.


Back to the top of ArtsIpPathData

vector<ArtsIpPathEntry> & Path() const ;


-------------------------------------------------------------------------
inline vector<ArtsIpPathEntry> & Path() const
.........................................................................
Returns a reference to the path vector.
-------------------------------------------------------------------------

  inline vector<ArtsIpPathEntry> & Path() const
                                
;

Function is currently defined inline.


Back to the top of ArtsIpPathData

void AddHop(ipv4addr_t ipAddr, uint8_t hopNum);


-------------------------------------------------------------------------
void AddHop(ipv4addr_t ipAddr, uint8_t hopNum)
.........................................................................
Appends a hop to the path. Assigns an IP address of ipAddr and a hop number of hopNum to the new hop. Note we *always* tack the new hop on the end of the path, and do *not* use hopNum to determine the location.
-------------------------------------------------------------------------

  void AddHop(ipv4addr_t ipAddr, uint8_t hopNum);

Back to the top of ArtsIpPathData

uint32_t Length(uint8_t version ) const ;


-------------------------------------------------------------------------
uint32_t Length(uint8_t version = 0) const
.........................................................................
Returns the number of bytes required to store object contents on disk.
-------------------------------------------------------------------------

  uint32_t Length(uint8_t version = 0) const
                                 
;

Function is currently defined inline.


Back to the top of ArtsIpPathData

ArtsIpPathData & operator = (const ArtsIpPathData & artsIpPathData);


-------------------------------------------------------------------------
ArtsIpPathData & operator = (const ArtsIpPathData & artsIpPathData)
.........................................................................
Overloaded '=' operator for assigning the value of one ArtsIpPathData object to another.
-------------------------------------------------------------------------

  ArtsIpPathData & operator = (const ArtsIpPathData & artsIpPathData);

Back to the top of ArtsIpPathData

friend ostream& operator << (ostream& os, const ArtsIpPathData & artsIpPathData);


-------------------------------------------------------------------------
friend ostream& operator << (ostream& os, const ArtsIpPathData & artsIpPathData)
.........................................................................
Overloaded ostream '<<' operator to print contents of object.
-------------------------------------------------------------------------

  friend ostream& operator << (ostream& os,
                               const ArtsIpPathData & artsIpPathData);

Back to the top of ArtsIpPathData

All Members

public:
ostream& write(ostream& os, uint8_t version );
int write(int fd, uint8_t version );
istream& read(istream& is, uint8_t version );
int read(int fd, uint8_t version );
ipv4addr_t Src() const ;
ipv4addr_t Src(ipv4addr_t src) ;
ipv4addr_t Dst() const ;
ipv4addr_t Dst(ipv4addr_t dst) ;
const struct timeval & Rtt() const ;
const struct timeval & Rtt(const struct timeval & rtt) ;
uint8_t HopDistance() const ;
uint8_t HopDistance(uint8_t hopDistance) ;
uint8_t IsComplete() const ;
uint8_t IsComplete(uint8_t isComplete) ;
uint8_t NumHops() const ;
uint8_t NumHops(uint8_t numHops) ;
vector<ArtsIpPathEntry> & Path() const ;
void AddHop(ipv4addr_t ipAddr, uint8_t hopNum);
uint32_t Length(uint8_t version ) const ;
ArtsIpPathData & operator = (const ArtsIpPathData & artsIpPathData);
friend ostream& operator << (ostream& os, const ArtsIpPathData & artsIpPathData);
protected:

Back to the top of ArtsIpPathData

Ancestors

Class does not inherit from any other class.

Back to the top of ArtsIpPathData

Descendants

Class is not inherited by any others.

Back to the top of ArtsIpPathData

Generated from source by the Cocoon utilities on Sat Oct 17 14:39:57 1998 .

Report problems to jkotula@unimax.com