A Discrete-Event Network Simulator
API
ns3::Ipv4RoutingTableEntry Class Reference

A record of an IPv4 routing table entry for Ipv4GlobalRouting and Ipv4StaticRouting. More...

#include "ipv4-routing-table-entry.h"

+ Inheritance diagram for ns3::Ipv4RoutingTableEntry:
+ Collaboration diagram for ns3::Ipv4RoutingTableEntry:

Public Member Functions

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

Static Public Member Functions

static Ipv4RoutingTableEntry CreateDefaultRoute (Ipv4Address nextHop, uint32_t interface)
 
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)
 

Private Member Functions

 Ipv4RoutingTableEntry (Ipv4Address network, Ipv4Mask mask, Ipv4Address gateway, uint32_t interface)
 Constructor. More...
 
 Ipv4RoutingTableEntry (Ipv4Address dest, Ipv4Mask mask, uint32_t interface)
 Constructor. More...
 
 Ipv4RoutingTableEntry (Ipv4Address dest, Ipv4Address gateway, uint32_t interface)
 Constructor. More...
 
 Ipv4RoutingTableEntry (Ipv4Address dest, uint32_t interface)
 Constructor. More...
 

Private Attributes

Ipv4Address m_dest
 destination address More...
 
Ipv4Mask m_destNetworkMask
 destination network mask More...
 
Ipv4Address m_gateway
 gateway More...
 
uint32_t m_interface
 output interface More...
 

Detailed Description

A record of an IPv4 routing table entry for Ipv4GlobalRouting and Ipv4StaticRouting.

This is not a reference counted object.

Definition at line 37 of file ipv4-routing-table-entry.h.

Constructor & Destructor Documentation

ns3::Ipv4RoutingTableEntry::Ipv4RoutingTableEntry ( )

This constructor does nothing.

Definition at line 33 of file ipv4-routing-table-entry.cc.

References NS_LOG_FUNCTION.

Referenced by CreateDefaultRoute(), CreateHostRouteTo(), and CreateNetworkRouteTo().

+ Here is the caller graph for this function:

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

Copy Constructor.

Parameters
routeThe route to copy

Definition at line 38 of file ipv4-routing-table-entry.cc.

References NS_LOG_FUNCTION.

ns3::Ipv4RoutingTableEntry::Ipv4RoutingTableEntry ( Ipv4RoutingTableEntry const *  route)

Copy Constructor.

Parameters
routeThe route to copy

Definition at line 47 of file ipv4-routing-table-entry.cc.

References NS_LOG_FUNCTION.

ns3::Ipv4RoutingTableEntry::Ipv4RoutingTableEntry ( Ipv4Address  network,
Ipv4Mask  mask,
Ipv4Address  gateway,
uint32_t  interface 
)
private

Constructor.

Parameters
networknetwork address
masknetwork mask
gatewaythe gateway
interfacethe interface index

Definition at line 73 of file ipv4-routing-table-entry.cc.

References NS_LOG_FUNCTION.

ns3::Ipv4RoutingTableEntry::Ipv4RoutingTableEntry ( Ipv4Address  dest,
Ipv4Mask  mask,
uint32_t  interface 
)
private

Constructor.

Parameters
destdestination address
masknetwork mask
interfacethe interface index

Definition at line 84 of file ipv4-routing-table-entry.cc.

References NS_LOG_FUNCTION.

ns3::Ipv4RoutingTableEntry::Ipv4RoutingTableEntry ( Ipv4Address  dest,
Ipv4Address  gateway,
uint32_t  interface 
)
private

Constructor.

Parameters
destdestination address
gatewaythe gateway
interfacethe interface index

Definition at line 56 of file ipv4-routing-table-entry.cc.

ns3::Ipv4RoutingTableEntry::Ipv4RoutingTableEntry ( Ipv4Address  dest,
uint32_t  interface 
)
private

Constructor.

Parameters
destdestination address
interfacethe interface index

Definition at line 65 of file ipv4-routing-table-entry.cc.

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

Definition at line 206 of file ipv4-routing-table-entry.cc.

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

+ Here is the call graph for this function:

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

Definition at line 172 of file ipv4-routing-table-entry.cc.

References Ipv4RoutingTableEntry(), and NS_LOG_FUNCTION_NOARGS.

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Definition at line 180 of file ipv4-routing-table-entry.cc.

References Ipv4RoutingTableEntry(), and NS_LOG_FUNCTION_NOARGS.

+ Here is the call graph for this function:

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

Definition at line 187 of file ipv4-routing-table-entry.cc.

References Ipv4RoutingTableEntry(), and NS_LOG_FUNCTION_NOARGS.

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Definition at line 197 of file ipv4-routing-table-entry.cc.

References Ipv4RoutingTableEntry(), and NS_LOG_FUNCTION_NOARGS.

+ Here is the call graph for this function:

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

Definition at line 134 of file ipv4-routing-table-entry.cc.

References m_dest, and NS_LOG_FUNCTION.

Referenced by ns3::Rip::Lookup(), ns3::operator<<(), ns3::olsr::RoutingProtocol::RoutingTableComputation(), and ns3::olsr::RoutingProtocol::SetRoutingTableAssociation().

+ Here is the caller graph for this function:

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

Definition at line 121 of file ipv4-routing-table-entry.cc.

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

Referenced by ns3::operator<<().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Definition at line 146 of file ipv4-routing-table-entry.cc.

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

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Definition at line 96 of file ipv4-routing-table-entry.cc.

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

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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 ().

Definition at line 115 of file ipv4-routing-table-entry.cc.

References IsHost(), and NS_LOG_FUNCTION.

Referenced by ns3::operator<<().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

Ipv4Address ns3::Ipv4RoutingTableEntry::m_dest
private

destination address

Definition at line 175 of file ipv4-routing-table-entry.h.

Referenced by GetDest(), GetDestNetwork(), and IsDefault().

Ipv4Mask ns3::Ipv4RoutingTableEntry::m_destNetworkMask
private

destination network mask

Definition at line 176 of file ipv4-routing-table-entry.h.

Referenced by GetDestNetworkMask(), and IsHost().

Ipv4Address ns3::Ipv4RoutingTableEntry::m_gateway
private

gateway

Definition at line 177 of file ipv4-routing-table-entry.h.

Referenced by GetGateway(), and IsGateway().

uint32_t ns3::Ipv4RoutingTableEntry::m_interface
private

output interface

Definition at line 178 of file ipv4-routing-table-entry.h.

Referenced by GetInterface().


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