ns3::Ipv4Route Class Reference
[Ipv4]

A record of an IPv4 route. More...

#include <ipv4-route.h>

Collaboration diagram for ns3::Ipv4Route:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 Ipv4Route ()
 This constructor does nothing.
 Ipv4Route (Ipv4Route const &route)
 Copy Constructor.
 Ipv4Route (Ipv4Route const *route)
 Copy Constructor.
bool IsHost (void) const
Ipv4Address GetDest (void) const
bool IsNetwork (void) const
Ipv4Address GetDestNetwork (void) const
Ipv4Mask GetDestNetworkMask (void) const
bool IsDefault (void) const
bool IsGateway (void) const
Ipv4Address GetGateway (void) const
uint32_t GetInterface (void) const

Static Public Member Functions

static Ipv4Route CreateHostRouteTo (Ipv4Address dest, Ipv4Address nextHop, uint32_t interface)
static Ipv4Route CreateHostRouteTo (Ipv4Address dest, uint32_t interface)
static Ipv4Route CreateNetworkRouteTo (Ipv4Address network, Ipv4Mask networkMask, Ipv4Address nextHop, uint32_t interface)
static Ipv4Route CreateNetworkRouteTo (Ipv4Address network, Ipv4Mask networkMask, uint32_t interface)
static Ipv4Route CreateDefaultRoute (Ipv4Address nextHop, uint32_t interface)

Private Member Functions

 Ipv4Route (Ipv4Address network, Ipv4Mask mask, Ipv4Address gateway, uint32_t interface)
 Ipv4Route (Ipv4Address dest, Ipv4Mask mask, uint32_t interface)
 Ipv4Route (Ipv4Address dest, Ipv4Address gateway, uint32_t interface)
 Ipv4Route (Ipv4Address dest, uint32_t interface)

Private Attributes

Ipv4Address m_dest
Ipv4Mask m_destNetworkMask
Ipv4Address m_gateway
uint32_t m_interface

Detailed Description

A record of an IPv4 route.

Definition at line 34 of file ipv4-route.h.


Constructor & Destructor Documentation

ns3::Ipv4Route::Ipv4Route (  ) 

This constructor does nothing.

Definition at line 28 of file ipv4-route.cc.

Referenced by CreateHostRouteTo().

ns3::Ipv4Route::Ipv4Route ( Ipv4Route const &  route  ) 

Copy Constructor.

Parameters:
route The route to copy

Definition at line 31 of file ipv4-route.cc.

ns3::Ipv4Route::Ipv4Route ( Ipv4Route const *  route  ) 

Copy Constructor.

Parameters:
route The route to copy

Definition at line 38 of file ipv4-route.cc.

ns3::Ipv4Route::Ipv4Route ( Ipv4Address  network,
Ipv4Mask  mask,
Ipv4Address  gateway,
uint32_t  interface 
) [private]

Definition at line 60 of file ipv4-route.cc.

ns3::Ipv4Route::Ipv4Route ( Ipv4Address  dest,
Ipv4Mask  mask,
uint32_t  interface 
) [private]

Definition at line 69 of file ipv4-route.cc.

ns3::Ipv4Route::Ipv4Route ( Ipv4Address  dest,
Ipv4Address  gateway,
uint32_t  interface 
) [private]

Definition at line 45 of file ipv4-route.cc.

ns3::Ipv4Route::Ipv4Route ( Ipv4Address  dest,
uint32_t  interface 
) [private]

Definition at line 53 of file ipv4-route.cc.


Member Function Documentation

Ipv4Route ns3::Ipv4Route::CreateDefaultRoute ( Ipv4Address  nextHop,
uint32_t  interface 
) [static]

Definition at line 176 of file ipv4-route.cc.

Referenced by ns3::Ipv4StaticRouting::SetDefaultRoute().

Ipv4Route ns3::Ipv4Route::CreateHostRouteTo ( Ipv4Address  dest,
uint32_t  interface 
) [static]

Definition at line 153 of file ipv4-route.cc.

Ipv4Route ns3::Ipv4Route::CreateHostRouteTo ( Ipv4Address  dest,
Ipv4Address  nextHop,
uint32_t  interface 
) [static]
Ipv4Route ns3::Ipv4Route::CreateNetworkRouteTo ( Ipv4Address  network,
Ipv4Mask  networkMask,
uint32_t  interface 
) [static]

Definition at line 168 of file ipv4-route.cc.

Ipv4Route ns3::Ipv4Route::CreateNetworkRouteTo ( Ipv4Address  network,
Ipv4Mask  networkMask,
Ipv4Address  nextHop,
uint32_t  interface 
) [static]
Ipv4Address ns3::Ipv4Route::GetDest ( void   )  const
Returns:
The IPv4 address of the destination of this route

Definition at line 91 of file ipv4-route.cc.

Ipv4Address ns3::Ipv4Route::GetDestNetwork ( void   )  const

Definition at line 113 of file ipv4-route.cc.

Ipv4Mask ns3::Ipv4Route::GetDestNetworkMask ( void   )  const

Definition at line 118 of file ipv4-route.cc.

Ipv4Address ns3::Ipv4Route::GetGateway ( void   )  const

Definition at line 135 of file ipv4-route.cc.

Referenced by ns3::Ipv4L3Protocol::SendRealOut().

uint32_t ns3::Ipv4Route::GetInterface ( void   )  const
bool ns3::Ipv4Route::IsDefault ( void   )  const
Returns:
True if this route is a default route; false otherwise

Definition at line 101 of file ipv4-route.cc.

Referenced by ns3::Ipv4StaticRouting::LookupStatic().

bool ns3::Ipv4Route::IsGateway ( void   )  const

Definition at line 123 of file ipv4-route.cc.

Referenced by ns3::Ipv4L3Protocol::SendRealOut().

bool ns3::Ipv4Route::IsHost ( void   )  const
bool ns3::Ipv4Route::IsNetwork ( void   )  const

Definition at line 96 of file ipv4-route.cc.


Member Data Documentation

Definition at line 101 of file ipv4-route.h.

Definition at line 102 of file ipv4-route.h.

Referenced by IsHost().

Definition at line 103 of file ipv4-route.h.

uint32_t ns3::Ipv4Route::m_interface [private]

Definition at line 104 of file ipv4-route.h.


The documentation for this class was generated from the following files:
Generated on Thu Dec 3 14:12:02 2009 for NS-3 by  doxygen 1.6.3