PIPSocket::RouteEntry Class Reference

Describe a route table entry. More...

#include <ipsock.h>

Inheritance diagram for PIPSocket::RouteEntry:

Collaboration diagram for PIPSocket::RouteEntry:

Public Member Functions
	RouteEntry (const Address &addr)
	Create a route table entry from an IP address. More...
Address	GetNetwork () const
	Get the network address associated with the route table entry. More...
Address	GetNetMask () const
	Get the network address mask associated with the route table entry. More...
Address	GetDestination () const
	Get the default gateway address associated with the route table entry. More...
const PString &	GetInterface () const
	Get the network address name associated with the route table entry. More...
long	GetMetric () const
	Get the network metric associated with the route table entry. More...
void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream. More...
Public Member Functions inherited from PObject
__inline unsigned	GetTraceContextIdentifier () const
	Get PTRACE context identifier. More...
__inline void	SetTraceContextIdentifier (unsigned id)
__inline void	SetTraceContextIdentifier (const PObject &obj)
__inline void	SetTraceContextIdentifier (const PObject *obj)
__inline void	CopyTraceContextIdentifier (PObject &obj) const
__inline void	CopyTraceContextIdentifier (PObject *obj) const
virtual	~PObject ()
__inline const char *	GetClass () const
__inline bool	IsClass (const char *name) const
__inline const PObject *	PTraceObjectInstance () const
virtual PObject *	Clone () const
	Create a copy of the class on the heap. More...
template<class CLS >
CLS *	CloneAs () const
	As for Clone() but converts to specified type. More...
virtual PINDEX	HashFunction () const
	This function yields a hash value required by the PDictionary class. More...
virtual Comparison	Compare (const PObject &obj) const
	Compare the two objects and return their relative rank. More...
virtual Comparison	CompareObjectMemoryDirect (const PObject &obj) const
	Determine the byte wise comparison of two objects. More...
bool	operator== (const PObject &obj) const
	Compare the two objects. More...
bool	operator!= (const PObject &obj) const
	Compare the two objects. More...
bool	operator< (const PObject &obj) const
	Compare the two objects. More...
bool	operator> (const PObject &obj) const
	Compare the two objects. More...
bool	operator<= (const PObject &obj) const
	Compare the two objects. More...
bool	operator>= (const PObject &obj) const
	Compare the two objects. More...
virtual void	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

Protected Attributes
Address	network
Address	net_mask
Address	destination
PString	interfaceName
long	metric
Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

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 __inline void	CopyTraceContextIdentifier (PObject &to, const PObject &from)
static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject *from)
static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject &from)
static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject *from)
static __inline const char *	Class ()
static __inline const PObject *	PTraceObjectInstance (const char *)
static __inline const PObject *	PTraceObjectInstance (const PObject *obj)
template<typename T >
static Comparison	Compare2 (T v1, T v2)
	Compare two types, returning Comparison type. More...
static Comparison	InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...
Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

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.

Print 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.

void PIPSocket::RouteEntry::PrintOn ( ostream &  strm ) const

virtual

Output the contents of the object to the stream.

The exact output is dependent on the exact semantics of the descendent class. This is primarily used by the standard operator<< function.

The default behaviour is to print the class name.

Reimplemented from PObject.

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:

• ipsock.h