PTLib  Version 2.10.10
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PIPSocket::RouteEntry Class Reference

Describe a route table entry. More...

#include <ipsock.h>

Inheritance diagram for PIPSocket::RouteEntry:
PObject

Public Member Functions

 RouteEntry (const Address &addr)
 Create a route table entry from an IP address.
Address GetNetwork () const
 Get the network address associated with the route table entry.
Address GetNetMask () const
 Get the network address mask associated with the route table entry.
Address GetDestination () const
 Get the default gateway address associated with the route table entry.
const PStringGetInterface () const
 Get the network address name associated with the route table entry.
long GetMetric () const
 Get the network metric associated with the route table entry.
- Public Member Functions inherited from PObject
virtual ~PObject ()
virtual PObjectClone () const
 Create a copy of the class on the heap.
virtual PINDEX HashFunction () const
 This function yields a hash value required by the PDictionary class.
virtual Comparison Compare (const PObject &obj) const
 Compare the two objects and return their relative rank.
virtual Comparison CompareObjectMemoryDirect (const PObject &obj) const
 Determine the byte wise comparison of two objects.
bool operator== (const PObject &obj) const
 Compare the two objects.
bool operator!= (const PObject &obj) const
 Compare the two objects.
bool operator< (const PObject &obj) const
 Compare the two objects.
bool operator> (const PObject &obj) const
 Compare the two objects.
bool operator<= (const PObject &obj) const
 Compare the two objects.
bool operator>= (const PObject &obj) const
 Compare the two objects.
virtual const char * GetClass (unsigned ancestor=0) const
 Get the current dynamic type of the object instance.
PBoolean IsClass (const char *cls) const
virtual PBoolean InternalIsDescendant (const char *clsName) const
 Determine if the dynamic type of the current instance is a descendent of the specified class.
virtual void PrintOn (ostream &strm) const
 Output the contents of the object to the stream.
virtual void ReadFrom (istream &strm)
 Input the contents of the object from the stream.

Protected Attributes

Address network
Address net_mask
Address destination
PString interfaceName
long metric

Additional Inherited Members

- Public Types inherited from PObject
enum  Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
 Result of the comparison operation performed by the Compare() function. More...
- Static Public Member Functions inherited from PObject
static Comparison InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
 Internal function caled from CompareObjectMemoryDirect()
static const char * Class ()
 Get the name of the class as a C string.
- Protected Member Functions inherited from PObject
 PObject ()
 Constructor for PObject, made protected so cannot ever create one on its own.
- Friends inherited from PObject

Detailed Description

Describe a route table entry.

Constructor & Destructor Documentation

PIPSocket::RouteEntry::RouteEntry ( const Address addr)
inline

Create a route table entry from an IP address.

Member Function Documentation

Address PIPSocket::RouteEntry::GetDestination ( ) const
inline

Get the default gateway address associated with the route table entry.

References destination.

const PString& PIPSocket::RouteEntry::GetInterface ( ) const
inline

Get the network address name associated with the route table entry.

References interfaceName.

long PIPSocket::RouteEntry::GetMetric ( ) const
inline

Get the network metric associated with the route table entry.

References metric.

Address PIPSocket::RouteEntry::GetNetMask ( ) const
inline

Get the network address mask associated with the route table entry.

References net_mask.

Address PIPSocket::RouteEntry::GetNetwork ( ) const
inline

Get the network address associated with the route table entry.

References network.

Member Data Documentation

Address PIPSocket::RouteEntry::destination
protected

Referenced by GetDestination().

PString PIPSocket::RouteEntry::interfaceName
protected

Referenced by GetInterface().

long PIPSocket::RouteEntry::metric
protected

Referenced by GetMetric().

Address PIPSocket::RouteEntry::net_mask
protected

Referenced by GetNetMask().

Address PIPSocket::RouteEntry::network
protected

Referenced by GetNetwork().


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