ArtsIpPathEntry

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

Quick Index

No documentation available.

Class Summary

class ArtsIpPathEntry

{

public:
ArtsIpPathEntry(ipv4addr_t ipAddr);
ArtsIpPathEntry(ipv4addr_t ipAddr, uint8_t hopNum);
ArtsIpPathEntry & operator = (const ArtsIpPathEntry& artsIpPathEntry);
ArtsIpPathEntry();
~ArtsIpPathEntry();
void IpAddr(ipv4addr_t ipAddr) ;
ipv4addr_t IpAddr() const ;
uint32_t Length(uint8_t version ) const ;
operator < (const ArtsIpPathEntry& artsIpPathEntry) const ;
operator > (const ArtsIpPathEntry& artsIpPathEntry) const ;
operator == (const ArtsIpPathEntry& artsIpPathEntry) const ;
istream& read(istream& is, uint8_t version );
int read(int fd, uint8_t version );
ostream& write(ostream& os, uint8_t version ) const;
int write(int fd, uint8_t version ) const;
uint8_t HopNum() const ;
void HopNum(uint8_t hopNum) ;
friend ostream& operator << (ostream& os, const ArtsIpPathEntry& artsIpPathEntry);
protected:
}; // ArtsIpPathEntry

Back to the top of ArtsIpPathEntry

ArtsIpPathEntry(ipv4addr_t ipAddr);


-------------------------------------------------------------------------
ArtsIpPathEntry(ipv4addr_t ipAddr)
.........................................................................
constructor accepting an IP address.
-------------------------------------------------------------------------

  ArtsIpPathEntry(ipv4addr_t ipAddr);

Back to the top of ArtsIpPathEntry

ArtsIpPathEntry(ipv4addr_t ipAddr, uint8_t hopNum);


-------------------------------------------------------------------------
ArtsIpPathEntry(ipv4addr_t ipAddr, uint8_t hopNum)
.........................................................................
constructor accepting an IP address and hop number.
-------------------------------------------------------------------------

  ArtsIpPathEntry(ipv4addr_t ipAddr, uint8_t hopNum);

Back to the top of ArtsIpPathEntry

ArtsIpPathEntry & operator = (const ArtsIpPathEntry& artsIpPathEntry);


-------------------------------------------------------------------------
operator = (const ArtsIpPathEntry& artsIpPathEntry)
.........................................................................
overloaded '=' operator for deep-copying an ArtsIpPathEntry.
-------------------------------------------------------------------------

  ArtsIpPathEntry & operator = (const ArtsIpPathEntry& artsIpPathEntry);

Back to the top of ArtsIpPathEntry

ArtsIpPathEntry();


-------------------------------------------------------------------------
ArtsIpPathEntry()
.........................................................................
default constructor
-------------------------------------------------------------------------

  ArtsIpPathEntry();

Back to the top of ArtsIpPathEntry

~ArtsIpPathEntry();


-------------------------------------------------------------------------
~ArtsIpPathEntry()
.........................................................................
destructor
-------------------------------------------------------------------------

  ~ArtsIpPathEntry();

Back to the top of ArtsIpPathEntry

void IpAddr(ipv4addr_t ipAddr) ;


-------------------------------------------------------------------------
inline void IpAddr(ipv4addr_t ipAddr)
.........................................................................
Sets and returns the IP address of an IP path entry.
-------------------------------------------------------------------------

  inline void IpAddr(ipv4addr_t ipAddr)
                                         
;

Function is currently defined inline.


Back to the top of ArtsIpPathEntry

ipv4addr_t IpAddr() const ;


-------------------------------------------------------------------------
inline ipv4addr_t IpAddr() const
.........................................................................
Returns the IP address of an IP path entry.
-------------------------------------------------------------------------

  inline ipv4addr_t IpAddr() const
                            
;

Function is currently defined inline.


Back to the top of ArtsIpPathEntry

uint32_t Length(uint8_t version ) const ;


-------------------------------------------------------------------------
inline uint32_t Length(uint8_t version = 0) const
.........................................................................
Returns the bytes required to store the IP path entry in a file in ARTS format.
-------------------------------------------------------------------------

  inline uint32_t Length(uint8_t version = 0) const
                           
;

Function is currently defined inline.


Back to the top of ArtsIpPathEntry

operator < (const ArtsIpPathEntry& artsIpPathEntry) const ;


-------------------------------------------------------------------------
inline operator < (const ArtsIpPathEntry& artsIpPathEntry) const
.........................................................................
Overloaded '<' operator. Compares by hop number, can be used for sorting path into ascending hop numbers.
-------------------------------------------------------------------------

  inline operator < (const ArtsIpPathEntry& artsIpPathEntry) const
                                                             
;

Function is currently defined inline.


Back to the top of ArtsIpPathEntry

operator > (const ArtsIpPathEntry& artsIpPathEntry) const ;


-------------------------------------------------------------------------
inline operator > (const ArtsIpPathEntry& artsIpPathEntry) const
.........................................................................
Overloaded '>' operator. Compares by hop number, can be used for sorting path into ascending hop numbers.
-------------------------------------------------------------------------

  inline operator > (const ArtsIpPathEntry& artsIpPathEntry) const
                                                             
;

Function is currently defined inline.


Back to the top of ArtsIpPathEntry

operator == (const ArtsIpPathEntry& artsIpPathEntry) const ;


-------------------------------------------------------------------------
inline operator == (const ArtsIpPathEntry& artsIpPathEntry) const
.........................................................................
Overloaded '==' operator. Compares by hop IP address only (does not use hop number in comparison).
-------------------------------------------------------------------------

  inline operator == (const ArtsIpPathEntry& artsIpPathEntry) const
                                                              
;

Function is currently defined inline.


Back to the top of ArtsIpPathEntry

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


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

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

Back to the top of ArtsIpPathEntry

int read(int fd, uint8_t version );


-------------------------------------------------------------------------
int read(int fd, uint8_t version = 0)
.........................................................................
Reads an IP path entry from a file descriptor.
-------------------------------------------------------------------------

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

Back to the top of ArtsIpPathEntry

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


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

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

Back to the top of ArtsIpPathEntry

int write(int fd, uint8_t version ) const;


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

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

Back to the top of ArtsIpPathEntry

uint8_t HopNum() const ;


-------------------------------------------------------------------------
inline uint8_t HopNum()
.........................................................................
Returns the hop number of the IP path entry.
-------------------------------------------------------------------------

  inline uint8_t HopNum() const
                            
;

Function is currently defined inline.


Back to the top of ArtsIpPathEntry

void HopNum(uint8_t hopNum) ;


-------------------------------------------------------------------------
inline void HopNum(uint8_t hopNum)
.........................................................................
Sets the hop number of the IP path entry.
-------------------------------------------------------------------------

  inline void HopNum(uint8_t hopNum)
                                         
;

Function is currently defined inline.


Back to the top of ArtsIpPathEntry

friend ostream& operator << (ostream& os, const ArtsIpPathEntry& artsIpPathEntry);


-------------------------------------------------------------------------
friend ostream& operator << (ostream& os, const ArtsIpPathEntry& artsIpPathEntry)
.........................................................................
overloaded '<<' operator for dumping human-readable version of IP path entry to an ostream.
-------------------------------------------------------------------------

  friend ostream& operator << (ostream& os,
                               const ArtsIpPathEntry& artsIpPathEntry);

Back to the top of ArtsIpPathEntry

All Members

public:
ArtsIpPathEntry & operator = (const ArtsIpPathEntry& artsIpPathEntry);
void IpAddr(ipv4addr_t ipAddr) ;
ipv4addr_t IpAddr() const ;
uint32_t Length(uint8_t version ) const ;
operator < (const ArtsIpPathEntry& artsIpPathEntry) const ;
operator > (const ArtsIpPathEntry& artsIpPathEntry) const ;
operator == (const ArtsIpPathEntry& artsIpPathEntry) const ;
istream& read(istream& is, uint8_t version );
int read(int fd, uint8_t version );
ostream& write(ostream& os, uint8_t version ) const;
int write(int fd, uint8_t version ) const;
uint8_t HopNum() const ;
void HopNum(uint8_t hopNum) ;
friend ostream& operator << (ostream& os, const ArtsIpPathEntry& artsIpPathEntry);
protected:

Back to the top of ArtsIpPathEntry

Ancestors

Class does not inherit from any other class.

Back to the top of ArtsIpPathEntry

Descendants

Class is not inherited by any others.

Back to the top of ArtsIpPathEntry

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

Report problems to jkotula@unimax.com