Static routing protocol for IP version 4 stacks. More...
#include "ipv4-static-routing.h"
Public Member Functions | |
Ipv4StaticRouting () | |
~Ipv4StaticRouting () override | |
void | AddHostRouteTo (Ipv4Address dest, Ipv4Address nextHop, uint32_t interface, uint32_t metric=0) |
Add a host route to the static routing table. | |
void | AddHostRouteTo (Ipv4Address dest, uint32_t interface, uint32_t metric=0) |
Add a host route to the static routing table. | |
void | AddMulticastRoute (Ipv4Address origin, Ipv4Address group, uint32_t inputInterface, std::vector< uint32_t > outputInterfaces) |
Add a multicast route to the static routing table. | |
void | AddNetworkRouteTo (Ipv4Address network, Ipv4Mask networkMask, Ipv4Address nextHop, uint32_t interface, uint32_t metric=0) |
Add a network route to the static routing table. | |
void | AddNetworkRouteTo (Ipv4Address network, Ipv4Mask networkMask, uint32_t interface, uint32_t metric=0) |
Add a network route to the static routing table. | |
Ipv4RoutingTableEntry | GetDefaultRoute () |
Get the default route with lowest metric from the static routing table. | |
uint32_t | GetMetric (uint32_t index) const |
Get a metric for route from the static unicast routing table. | |
Ipv4MulticastRoutingTableEntry | GetMulticastRoute (uint32_t i) const |
Get a route from the static multicast routing table. | |
uint32_t | GetNMulticastRoutes () const |
Get the number of individual multicast routes that have been added to the routing table. | |
uint32_t | GetNRoutes () const |
Get the number of individual unicast routes that have been added to the routing table. | |
Ipv4RoutingTableEntry | GetRoute (uint32_t i) const |
Get a route from the static unicast routing table. | |
void | NotifyAddAddress (uint32_t interface, Ipv4InterfaceAddress address) override |
void | NotifyInterfaceDown (uint32_t interface) override |
void | NotifyInterfaceUp (uint32_t interface) override |
void | NotifyRemoveAddress (uint32_t interface, Ipv4InterfaceAddress address) override |
void | PrintRoutingTable (Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S) const override |
Print the Routing Table entries. | |
bool | RemoveMulticastRoute (Ipv4Address origin, Ipv4Address group, uint32_t inputInterface) |
Remove a route from the static multicast routing table. | |
void | RemoveMulticastRoute (uint32_t index) |
Remove a route from the static multicast routing table. | |
void | RemoveRoute (uint32_t i) |
Remove a route from the static unicast routing table. | |
bool | RouteInput (Ptr< const Packet > p, const Ipv4Header &header, Ptr< const NetDevice > idev, const UnicastForwardCallback &ucb, const MulticastForwardCallback &mcb, const LocalDeliverCallback &lcb, const ErrorCallback &ecb) override |
Route an input packet (to be forwarded or locally delivered) | |
Ptr< Ipv4Route > | RouteOutput (Ptr< Packet > p, const Ipv4Header &header, Ptr< NetDevice > oif, Socket::SocketErrno &sockerr) override |
Query routing cache for an existing route, for an outbound packet. | |
void | SetDefaultMulticastRoute (uint32_t outputInterface) |
Add a default multicast route to the static routing table. | |
void | SetDefaultRoute (Ipv4Address nextHop, uint32_t interface, uint32_t metric=0) |
Add a default route to the static routing table. | |
void | SetIpv4 (Ptr< Ipv4 > ipv4) override |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. | |
~Object () override | |
Destructor. | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. | |
void | Dispose () |
Dispose of this Object. | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. | |
bool | IsInitialized () const |
Check if the object has been initialized. | |
void | UnidirectionalAggregateObject (Ptr< Object > other) |
Aggregate an Object to another Object. | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. | |
void | Ref () const |
Increment the reference count. | |
void | Unref () const |
Decrement the reference count. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
The interface Id associated with this class. | |
Static Public Member Functions inherited from ns3::Ipv4RoutingProtocol | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Protected Member Functions | |
void | DoDispose () override |
Destructor implementation. | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | DoInitialize () |
Initialize() implementation. | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Private Types | |
typedef std::list< Ipv4MulticastRoutingTableEntry * > | MulticastRoutes |
Container for the multicast routes. | |
typedef std::list< Ipv4MulticastRoutingTableEntry * >::const_iterator | MulticastRoutesCI |
Const Iterator for container for the multicast routes. | |
typedef std::list< Ipv4MulticastRoutingTableEntry * >::iterator | MulticastRoutesI |
Iterator for container for the multicast routes. | |
typedef std::list< std::pair< Ipv4RoutingTableEntry *, uint32_t > > | NetworkRoutes |
Container for the network routes. | |
typedef std::list< std::pair< Ipv4RoutingTableEntry *, uint32_t > >::const_iterator | NetworkRoutesCI |
Const Iterator for container for the network routes. | |
typedef std::list< std::pair< Ipv4RoutingTableEntry *, uint32_t > >::iterator | NetworkRoutesI |
Iterator for container for the network routes. | |
Private Member Functions | |
bool | LookupRoute (const Ipv4RoutingTableEntry &route, uint32_t metric) |
Checks if a route is already present in the forwarding table. | |
Ptr< Ipv4Route > | LookupStatic (Ipv4Address dest, Ptr< NetDevice > oif=nullptr) |
Lookup in the forwarding table for destination. | |
Ptr< Ipv4MulticastRoute > | LookupStatic (Ipv4Address origin, Ipv4Address group, uint32_t interface) |
Lookup in the multicast forwarding table for destination. | |
Private Attributes | |
Ptr< Ipv4 > | m_ipv4 |
Ipv4 reference. | |
MulticastRoutes | m_multicastRoutes |
the forwarding table for multicast. | |
NetworkRoutes | m_networkRoutes |
the forwarding table for network. | |
Additional Inherited Members | |
Public Types inherited from ns3::Ipv4RoutingProtocol | |
typedef Callback< void, Ptr< const Packet >, const Ipv4Header &, Socket::SocketErrno > | ErrorCallback |
Callback for routing errors (e.g., no route found) | |
typedef Callback< void, Ptr< const Packet >, const Ipv4Header &, uint32_t > | LocalDeliverCallback |
Callback for packets to be locally delivered. | |
typedef Callback< void, Ptr< Ipv4MulticastRoute >, Ptr< const Packet >, const Ipv4Header & > | MulticastForwardCallback |
Callback for multicast packets to be forwarded. | |
typedef Callback< void, Ptr< Ipv4Route >, Ptr< const Packet >, const Ipv4Header & > | UnicastForwardCallback |
Callback for unicast packets to be forwarded. | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Static routing protocol for IP version 4 stacks.
Introspection did not find any typical Config paths.
This class provides a basic set of methods for inserting static unicast and multicast routes into the Ipv4 routing system. This particular protocol is designed to be inserted into an Ipv4ListRouting protocol but can be used also as a standalone protocol.
The Ipv4StaticRouting class inherits from the abstract base class Ipv4RoutingProtocol that defines the interface methods that a routing protocol must support.
No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Internet
Size of this type is 112 bytes (on a 64-bit architecture).
Definition at line 56 of file ipv4-static-routing.h.
|
private |
Container for the multicast routes.
Definition at line 365 of file ipv4-static-routing.h.
|
private |
Const Iterator for container for the multicast routes.
Definition at line 368 of file ipv4-static-routing.h.
|
private |
Iterator for container for the multicast routes.
Definition at line 371 of file ipv4-static-routing.h.
|
private |
Container for the network routes.
Definition at line 356 of file ipv4-static-routing.h.
|
private |
Const Iterator for container for the network routes.
Definition at line 359 of file ipv4-static-routing.h.
|
private |
Iterator for container for the network routes.
Definition at line 362 of file ipv4-static-routing.h.
ns3::Ipv4StaticRouting::Ipv4StaticRouting | ( | ) |
Definition at line 49 of file ipv4-static-routing.cc.
References NS_LOG_FUNCTION.
|
override |
Definition at line 571 of file ipv4-static-routing.cc.
References NS_LOG_FUNCTION.
void ns3::Ipv4StaticRouting::AddHostRouteTo | ( | Ipv4Address | dest, |
Ipv4Address | nextHop, | ||
uint32_t | interface, | ||
uint32_t | metric = 0 ) |
Add a host route to the static routing table.
dest | The Ipv4Address destination for this route. |
nextHop | The Ipv4Address of the next hop in the route. |
interface | The network interface index used to send packets to the destination. |
metric | Metric of route in case of multiple routes to same destination |
Definition at line 94 of file ipv4-static-routing.cc.
References AddNetworkRouteTo(), ns3::Ipv4Mask::GetOnes(), and NS_LOG_FUNCTION.
void ns3::Ipv4StaticRouting::AddHostRouteTo | ( | Ipv4Address | dest, |
uint32_t | interface, | ||
uint32_t | metric = 0 ) |
Add a host route to the static routing table.
dest | The Ipv4Address destination for this route. |
interface | The network interface index used to send packets to the destination. |
metric | Metric of route in case of multiple routes to same destination |
Definition at line 104 of file ipv4-static-routing.cc.
References AddNetworkRouteTo(), ns3::Ipv4Mask::GetOnes(), and NS_LOG_FUNCTION.
void ns3::Ipv4StaticRouting::AddMulticastRoute | ( | Ipv4Address | origin, |
Ipv4Address | group, | ||
uint32_t | inputInterface, | ||
std::vector< uint32_t > | outputInterfaces ) |
Add a multicast route to the static routing table.
A multicast route must specify an origin IP address, a multicast group and an input network interface index as conditions and provide a vector of output network interface indices over which packets matching the conditions are sent.
Typically there are two main types of multicast routes: routes used during forwarding, and routes used in the originator node. For forwarding, all of the conditions must be explicitly provided. For originator nodes, the route is equivalent to a unicast route, and must be added through AddHostRouteTo
.
origin | The Ipv4Address of the origin of packets for this route. May be Ipv4Address:GetAny for open groups. |
group | The Ipv4Address of the multicast group or this route. |
inputInterface | The input network interface index over which to expect packets destined for this route. |
outputInterfaces | A vector of network interface indexes used to specify how to send packets to the destination(s). |
Definition at line 118 of file ipv4-static-routing.cc.
References ns3::Ipv4MulticastRoutingTableEntry::CreateMulticastRoute(), m_multicastRoutes, and NS_LOG_FUNCTION.
void ns3::Ipv4StaticRouting::AddNetworkRouteTo | ( | Ipv4Address | network, |
Ipv4Mask | networkMask, | ||
Ipv4Address | nextHop, | ||
uint32_t | interface, | ||
uint32_t | metric = 0 ) |
Add a network route to the static routing table.
network | The Ipv4Address network for this route. |
networkMask | The Ipv4Mask to extract the network. |
nextHop | The next hop in the route to the destination network. |
interface | The network interface index used to send packets to the destination. |
metric | Metric of route in case of multiple routes to same destination |
Definition at line 56 of file ipv4-static-routing.cc.
References ns3::Ipv4RoutingTableEntry::CreateNetworkRouteTo(), LookupRoute(), m_networkRoutes, and NS_LOG_FUNCTION.
Referenced by AddHostRouteTo(), AddHostRouteTo(), NotifyAddAddress(), NotifyInterfaceUp(), and SetDefaultRoute().
void ns3::Ipv4StaticRouting::AddNetworkRouteTo | ( | Ipv4Address | network, |
Ipv4Mask | networkMask, | ||
uint32_t | interface, | ||
uint32_t | metric = 0 ) |
Add a network route to the static routing table.
network | The Ipv4Address network for this route. |
networkMask | The Ipv4Mask to extract the network. |
interface | The network interface index used to send packets to the destination. |
metric | Metric of route in case of multiple routes to same destination |
Definition at line 76 of file ipv4-static-routing.cc.
References ns3::Ipv4RoutingTableEntry::CreateNetworkRouteTo(), LookupRoute(), m_networkRoutes, and NS_LOG_FUNCTION.
|
overrideprotectedvirtual |
Destructor implementation.
This method is called by Dispose() or by the Object's destructor, whichever comes first.
Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.
It is safe to call GetObject() from within this method.
Reimplemented from ns3::Object.
Definition at line 577 of file ipv4-static-routing.cc.
References ns3::Object::DoDispose(), m_ipv4, m_multicastRoutes, m_networkRoutes, and NS_LOG_FUNCTION.
Ipv4RoutingTableEntry ns3::Ipv4StaticRouting::GetDefaultRoute | ( | ) |
Get the default route with lowest metric from the static routing table.
Definition at line 370 of file ipv4-static-routing.cc.
References ns3::Ipv4Mask::GetPrefixLength(), m_networkRoutes, and NS_LOG_FUNCTION.
Get a metric for route from the static unicast routing table.
index | The index (into the routing table) of the route to retrieve. |
Definition at line 423 of file ipv4-static-routing.cc.
References m_networkRoutes, NS_ASSERT, and NS_LOG_FUNCTION.
Referenced by PrintRoutingTable().
Ipv4MulticastRoutingTableEntry ns3::Ipv4StaticRouting::GetMulticastRoute | ( | uint32_t | i | ) | const |
Get a route from the static multicast routing table.
Externally, the multicast static routing table appears simply as a table with n entries.
i | The index (into the routing table) of the multicast route to retrieve. |
Definition at line 155 of file ipv4-static-routing.cc.
References m_multicastRoutes, NS_ASSERT_MSG, and NS_LOG_FUNCTION.
uint32_t ns3::Ipv4StaticRouting::GetNMulticastRoutes | ( | ) | const |
Get the number of individual multicast routes that have been added to the routing table.
Definition at line 148 of file ipv4-static-routing.cc.
References m_multicastRoutes, and NS_LOG_FUNCTION.
uint32_t ns3::Ipv4StaticRouting::GetNRoutes | ( | ) | const |
Get the number of individual unicast routes that have been added to the routing table.
Definition at line 363 of file ipv4-static-routing.cc.
References m_networkRoutes, and NS_LOG_FUNCTION.
Referenced by PrintRoutingTable().
Ipv4RoutingTableEntry ns3::Ipv4StaticRouting::GetRoute | ( | uint32_t | i | ) | const |
Get a route from the static unicast routing table.
Externally, the unicast static routing table appears simply as a table with n entries.
i | The index (into the routing table) of the route to retrieve. |
Definition at line 405 of file ipv4-static-routing.cc.
References m_networkRoutes, NS_ASSERT, and NS_LOG_FUNCTION.
Referenced by PrintRoutingTable().
|
static |
The interface Id associated with this class.
Definition at line 40 of file ipv4-static-routing.cc.
References ns3::TypeId::SetParent().
|
private |
Checks if a route is already present in the forwarding table.
route | route |
metric | metric of route |
Definition at line 214 of file ipv4-static-routing.cc.
References ns3::Ipv4RoutingTableEntry::GetDest(), ns3::Ipv4RoutingTableEntry::GetDestNetworkMask(), ns3::Ipv4RoutingTableEntry::GetGateway(), ns3::Ipv4RoutingTableEntry::GetInterface(), and m_networkRoutes.
Referenced by AddNetworkRouteTo(), and AddNetworkRouteTo().
|
private |
Lookup in the forwarding table for destination.
dest | destination address |
oif | output interface if any (put 0 otherwise) |
Definition at line 232 of file ipv4-static-routing.cc.
References ns3::Create(), ns3::Ipv4::GetAddress(), ns3::Ipv4RoutingTableEntry::GetDest(), ns3::Ipv4RoutingTableEntry::GetGateway(), ns3::Ipv4RoutingTableEntry::GetInterface(), ns3::Ipv4::GetInterfaceForDevice(), ns3::Ipv4InterfaceAddress::GetLocal(), ns3::Ipv4::GetNetDevice(), ns3::Ipv4Mask::GetPrefixLength(), ns3::Ipv4Address::GetZero(), ns3::Ipv4Address::IsLocalMulticast(), ns3::Ipv4Mask::IsMatch(), m_ipv4, m_networkRoutes, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::Ipv4::SourceAddressSelection().
Referenced by RouteInput(), and RouteOutput().
|
private |
Lookup in the multicast forwarding table for destination.
origin | source address |
group | group multicast address |
interface | interface index |
Definition at line 315 of file ipv4-static-routing.cc.
References ns3::Create(), ns3::Ipv4MulticastRoutingTableEntry::GetGroup(), ns3::Ipv4MulticastRoutingTableEntry::GetInputInterface(), ns3::Ipv4MulticastRoutingTableEntry::GetNOutputInterfaces(), ns3::Ipv4MulticastRoutingTableEntry::GetOrigin(), ns3::Ipv4MulticastRoutingTableEntry::GetOutputInterface(), ns3::Ipv4::IF_ANY, m_multicastRoutes, ns3::Ipv4MulticastRoute::MAX_TTL, NS_LOG_FUNCTION, and NS_LOG_LOGIC.
|
overridevirtual |
interface | the index of the interface we are being notified about |
address | a new address being added to an interface |
Protocols are expected to implement this method to be notified whenever a new address is added to an interface. Typically used to add a 'network route' on an interface. Can be invoked on an up or down interface.
Implements ns3::Ipv4RoutingProtocol.
Definition at line 634 of file ipv4-static-routing.cc.
References AddNetworkRouteTo(), ns3::Ipv4::IsUp(), m_ipv4, and NS_LOG_FUNCTION.
|
overridevirtual |
interface | the index of the interface we are being notified about |
Protocols are expected to implement this method to be notified of the state change of an interface in a node.
Implements ns3::Ipv4RoutingProtocol.
Definition at line 615 of file ipv4-static-routing.cc.
References m_networkRoutes, and NS_LOG_FUNCTION.
Referenced by SetIpv4().
|
overridevirtual |
interface | the index of the interface we are being notified about |
Protocols are expected to implement this method to be notified of the state change of an interface in a node.
Implements ns3::Ipv4RoutingProtocol.
Definition at line 594 of file ipv4-static-routing.cc.
References AddNetworkRouteTo(), ns3::Ipv4Address::CombineMask(), ns3::Ipv4::GetAddress(), ns3::Ipv4InterfaceAddress::GetLocal(), ns3::Ipv4InterfaceAddress::GetMask(), ns3::Ipv4::GetNAddresses(), ns3::Ipv4Mask::GetOnes(), m_ipv4, and NS_LOG_FUNCTION.
Referenced by SetIpv4().
|
overridevirtual |
interface | the index of the interface we are being notified about |
address | a new address being added to an interface |
Protocols are expected to implement this method to be notified whenever a new address is removed from an interface. Typically used to remove the 'network route' of an interface. Can be invoked on an up or down interface.
Implements ns3::Ipv4RoutingProtocol.
Definition at line 651 of file ipv4-static-routing.cc.
References ns3::Ipv4::IsUp(), m_ipv4, m_networkRoutes, and NS_LOG_FUNCTION.
|
overridevirtual |
Print the Routing Table entries.
stream | The ostream the Routing table is printed to |
unit | The time unit to be used in the report |
Implements ns3::Ipv4RoutingProtocol.
Definition at line 699 of file ipv4-static-routing.cc.
References ns3::Time::As(), ns3::Names::FindName(), ns3::Ipv4RoutingTableEntry::GetDest(), ns3::Ipv4RoutingTableEntry::GetDestNetworkMask(), ns3::Ipv4RoutingTableEntry::GetGateway(), ns3::Ipv4RoutingTableEntry::GetInterface(), GetMetric(), ns3::Ipv4::GetNetDevice(), GetNRoutes(), ns3::Object::GetObject(), GetRoute(), ns3::Ipv4RoutingTableEntry::IsGateway(), ns3::Ipv4RoutingTableEntry::IsHost(), m_ipv4, ns3::Now(), and NS_LOG_FUNCTION.
bool ns3::Ipv4StaticRouting::RemoveMulticastRoute | ( | Ipv4Address | origin, |
Ipv4Address | group, | ||
uint32_t | inputInterface ) |
Remove a route from the static multicast routing table.
Externally, the multicast static routing table appears simply as a table with n entries. This method causes the multicast routing table to be searched for the first route that matches the parameters and removes it.
Wildcards may be provided to this function, but the wildcards are used to exactly match wildcards in the routes (see AddMulticastRoute). That is, calling RemoveMulticastRoute with the origin set to "0.0.0.0" will not remove routes with any address in the origin, but will only remove routes with "0.0.0.0" set as the the origin.
origin | The IP address specified as the origin of packets for the route. |
group | The IP address specified as the multicast group address of the route. |
inputInterface | The network interface index specified as the expected input interface for the route. |
Definition at line 177 of file ipv4-static-routing.cc.
References ns3::Ipv4MulticastRoutingTableEntry::GetGroup(), ns3::Ipv4MulticastRoutingTableEntry::GetInputInterface(), ns3::Ipv4MulticastRoutingTableEntry::GetOrigin(), m_multicastRoutes, and NS_LOG_FUNCTION.
void ns3::Ipv4StaticRouting::RemoveMulticastRoute | ( | uint32_t | index | ) |
Remove a route from the static multicast routing table.
Externally, the multicast static routing table appears simply as a table with n entries.
index | The index (into the multicast routing table) of the route to remove. |
Definition at line 197 of file ipv4-static-routing.cc.
References m_multicastRoutes, and NS_LOG_FUNCTION.
void ns3::Ipv4StaticRouting::RemoveRoute | ( | uint32_t | i | ) |
Remove a route from the static unicast routing table.
Externally, the unicast static routing table appears simply as a table with n entries.
i | The index (into the routing table) of the route to remove. |
Definition at line 441 of file ipv4-static-routing.cc.
References m_networkRoutes, NS_ASSERT, and NS_LOG_FUNCTION.
|
overridevirtual |
Route an input packet (to be forwarded or locally delivered)
This lookup is used in the forwarding process. The packet is handed over to the Ipv4RoutingProtocol, and will get forwarded onward by one of the callbacks. The Linux equivalent is ip_route_input(). There are four valid outcomes, and a matching callbacks to handle each.
p | received packet |
header | input parameter used to form a search key for a route |
idev | Pointer to ingress network device |
ucb | Callback for the case in which the packet is to be forwarded as unicast |
mcb | Callback for the case in which the packet is to be forwarded as multicast |
lcb | Callback for the case in which the packet is to be locally delivered |
ecb | Callback to call if there is an error in forwarding |
Implements ns3::Ipv4RoutingProtocol.
Definition at line 492 of file ipv4-static-routing.cc.
References ns3::Socket::ERROR_NOROUTETOHOST, ns3::Ipv4Header::GetDestination(), ns3::Ipv4::GetInterfaceForDevice(), ns3::Ipv4Header::GetSource(), ns3::Ipv4::IsDestinationAddress(), ns3::Ipv4::IsForwarding(), ns3::Ipv4Address::IsMulticast(), ns3::Callback< R, UArgs >::IsNull(), LookupStatic(), m_ipv4, NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_LOGIC.
|
overridevirtual |
Query routing cache for an existing route, for an outbound packet.
This lookup is used by transport protocols. It does not cause any packet to be forwarded, and is synchronous. Can be used for multicast or unicast. The Linux equivalent is ip_route_output()
The header input parameter may have an uninitialized value for the source address, but the destination address should always be properly set by the caller.
p | packet to be routed. Note that this method may modify the packet. Callers may also pass in a null pointer. |
header | input parameter (used to form key to search for the route) |
oif | Output interface Netdevice. May be zero, or may be bound via socket options to a particular output interface. |
sockerr | Output parameter; socket errno |
Implements ns3::Ipv4RoutingProtocol.
Definition at line 459 of file ipv4-static-routing.cc.
References ns3::Socket::ERROR_NOROUTETOHOST, ns3::Socket::ERROR_NOTERROR, ns3::Ipv4Header::GetDestination(), ns3::Ipv4Address::IsMulticast(), LookupStatic(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.
void ns3::Ipv4StaticRouting::SetDefaultMulticastRoute | ( | uint32_t | outputInterface | ) |
Add a default multicast route to the static routing table.
This is the multicast equivalent of the unicast version SetDefaultRoute. We tell the routing system what to do in the case where a specific route to a destination multicast group is not found. The system forwards packets out the specified interface in the hope that "something out there" knows better how to route the packet. This method is only used in initially sending packets off of a host. The default multicast route is not consulted during forwarding – exact routes must be specified using AddMulticastRoute for that case.
Since we're basically sending packets to some entity we think may know better what to do, we don't pay attention to "subtleties" like origin address, nor do we worry about forwarding out multiple interfaces. If the default multicast route is set, it is returned as the selected route from LookupStatic irrespective of origin or multicast group if another specific route is not found.
outputInterface | The network interface index used to specify where to send packets in the case of unknown routes. |
Definition at line 137 of file ipv4-static-routing.cc.
References ns3::Ipv4RoutingTableEntry::CreateNetworkRouteTo(), m_networkRoutes, and NS_LOG_FUNCTION.
void ns3::Ipv4StaticRouting::SetDefaultRoute | ( | Ipv4Address | nextHop, |
uint32_t | interface, | ||
uint32_t | metric = 0 ) |
Add a default route to the static routing table.
This method tells the routing system what to do in the case where a specific route to a destination is not found. The system forwards packets to the specified node in the hope that it knows better how to route the packet.
If the default route is set, it is returned as the selected route from LookupStatic irrespective of destination address if no specific route is found.
nextHop | The Ipv4Address to send packets to in the hope that they will be forwarded correctly. |
interface | The network interface index used to send packets. |
metric | Metric of route in case of multiple routes to same destination |
Definition at line 111 of file ipv4-static-routing.cc.
References AddNetworkRouteTo(), ns3::Ipv4Mask::GetZero(), and NS_LOG_FUNCTION.
ipv4 | the ipv4 object this routing protocol is being associated with |
Typically, invoked directly or indirectly from ns3::Ipv4::SetRoutingProtocol
Implements ns3::Ipv4RoutingProtocol.
Definition at line 679 of file ipv4-static-routing.cc.
References ns3::Ipv4::GetNInterfaces(), ns3::Ipv4::IsUp(), m_ipv4, NotifyInterfaceDown(), NotifyInterfaceUp(), NS_ASSERT, and NS_LOG_FUNCTION.
Ipv4 reference.
Definition at line 411 of file ipv4-static-routing.h.
Referenced by DoDispose(), LookupStatic(), NotifyAddAddress(), NotifyInterfaceUp(), NotifyRemoveAddress(), PrintRoutingTable(), RouteInput(), and SetIpv4().
|
private |
the forwarding table for multicast.
Definition at line 406 of file ipv4-static-routing.h.
Referenced by AddMulticastRoute(), DoDispose(), GetMulticastRoute(), GetNMulticastRoutes(), LookupStatic(), RemoveMulticastRoute(), and RemoveMulticastRoute().
|
private |
the forwarding table for network.
Definition at line 401 of file ipv4-static-routing.h.
Referenced by AddNetworkRouteTo(), AddNetworkRouteTo(), DoDispose(), GetDefaultRoute(), GetMetric(), GetNRoutes(), GetRoute(), LookupRoute(), LookupStatic(), NotifyInterfaceDown(), NotifyRemoveAddress(), RemoveRoute(), and SetDefaultMulticastRoute().