ns-3
ns3::Ipv4RoutingTableEntry Class Reference

#include <ipv4-routing-table-entry.h>

List of all members.

Public Member Functions

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

Static Public Member Functions

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

Detailed Description

A record of an IPv4 routing table entry for Ipv4GlobalRouting and Ipv4StaticRouting. This is not a reference counted object.


Constructor & Destructor Documentation

ns3::Ipv4RoutingTableEntry::Ipv4RoutingTableEntry ( Ipv4RoutingTableEntry const &  route)

Copy Constructor.

Parameters:
routeThe route to copy
ns3::Ipv4RoutingTableEntry::Ipv4RoutingTableEntry ( Ipv4RoutingTableEntry const *  route)

Copy Constructor.

Parameters:
routeThe route to copy

Member Function Documentation

Ipv4RoutingTableEntry ns3::Ipv4RoutingTableEntry::CreateDefaultRoute ( Ipv4Address  nextHop,
uint32_t  interface 
)
static
Returns:
An Ipv4RoutingTableEntry object corresponding to the input parameters. This route is distinguished; it will match any destination for which a more specific route does not exist.
Parameters:
nextHopIpv4Address of the next hop
interfaceOutgoing interface

References ns3::Ipv4Address::GetZero(), and Ipv4RoutingTableEntry().

Ipv4RoutingTableEntry ns3::Ipv4RoutingTableEntry::CreateHostRouteTo ( Ipv4Address  dest,
Ipv4Address  nextHop,
uint32_t  interface 
)
static
Returns:
An Ipv4RoutingTableEntry object corresponding to the input parameters.
Parameters:
destIpv4Address of the destination
nextHopIpv4Address of the next hop
interfaceOutgoing interface

References Ipv4RoutingTableEntry().

Referenced by ns3::Ipv4GlobalRouting::AddHostRouteTo().

Ipv4RoutingTableEntry ns3::Ipv4RoutingTableEntry::CreateHostRouteTo ( Ipv4Address  dest,
uint32_t  interface 
)
static
Returns:
An Ipv4RoutingTableEntry object corresponding to the input parameters.
Parameters:
destIpv4Address of the destination
interfaceOutgoing interface

References Ipv4RoutingTableEntry().

Ipv4RoutingTableEntry ns3::Ipv4RoutingTableEntry::CreateNetworkRouteTo ( Ipv4Address  network,
Ipv4Mask  networkMask,
Ipv4Address  nextHop,
uint32_t  interface 
)
static
Returns:
An Ipv4RoutingTableEntry object corresponding to the input parameters.
Parameters:
networkIpv4Address of the destination network
networkMaskIpv4Mask of the destination network mask
nextHopIpv4Address of the next hop
interfaceOutgoing interface

References Ipv4RoutingTableEntry().

Referenced by ns3::Ipv4GlobalRouting::AddASExternalRouteTo(), ns3::Ipv4StaticRouting::AddNetworkRouteTo(), ns3::Ipv4GlobalRouting::AddNetworkRouteTo(), ns3::GlobalRouter::InjectRoute(), and ns3::Ipv4StaticRouting::SetDefaultMulticastRoute().

Ipv4RoutingTableEntry ns3::Ipv4RoutingTableEntry::CreateNetworkRouteTo ( Ipv4Address  network,
Ipv4Mask  networkMask,
uint32_t  interface 
)
static
Returns:
An Ipv4RoutingTableEntry object corresponding to the input parameters.
Parameters:
networkIpv4Address of the destination network
networkMaskIpv4Mask of the destination network mask
interfaceOutgoing interface

References Ipv4RoutingTableEntry().

Ipv4Address ns3::Ipv4RoutingTableEntry::GetDest ( void  ) const
Returns:
The IPv4 address of the destination of this route

Referenced by ns3::Ipv4StaticRouting::PrintRoutingTable(), and ns3::Ipv4GlobalRouting::PrintRoutingTable().

Ipv4Address ns3::Ipv4RoutingTableEntry::GetDestNetwork ( void  ) const
Returns:
The IPv4 network number of the destination of this route

Referenced by ns3::Ipv4StaticRouting::NotifyRemoveAddress(), and ns3::olsr::RoutingProtocol::SetRoutingTableAssociation().

Ipv4Mask ns3::Ipv4RoutingTableEntry::GetDestNetworkMask ( void  ) const
Ipv4Address ns3::Ipv4RoutingTableEntry::GetGateway ( void  ) const
Returns:
address of the gateway stored in this entry

Referenced by ns3::Ipv4StaticRouting::PrintRoutingTable(), and ns3::Ipv4GlobalRouting::PrintRoutingTable().

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

References ns3::Ipv4Address::GetZero(), and ns3::Ipv4Address::IsEqual().

bool ns3::Ipv4RoutingTableEntry::IsGateway ( void  ) const
Returns:
True if this route is a gateway route; false otherwise

References ns3::Ipv4Address::GetZero(), and ns3::Ipv4Address::IsEqual().

Referenced by ns3::Ipv4StaticRouting::PrintRoutingTable(), and ns3::Ipv4GlobalRouting::PrintRoutingTable().

bool ns3::Ipv4RoutingTableEntry::IsHost ( void  ) const
Returns:
True if this route is a host route (mask of all ones); false otherwise

References ns3::Ipv4Mask::GetOnes(), and ns3::Ipv4Mask::IsEqual().

Referenced by IsNetwork(), ns3::Ipv4StaticRouting::PrintRoutingTable(), and ns3::Ipv4GlobalRouting::PrintRoutingTable().

bool ns3::Ipv4RoutingTableEntry::IsNetwork ( void  ) const
Returns:
True if this route is not a host route (mask is not all ones); false otherwise

This method is implemented as !IsHost ().

References IsHost().

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


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