ns3::Ipv4RoutingHelper Class Reference
a factory to create ns3::Ipv4RoutingProtocol objects More...
#include <ipv4-routing-helper.h>
Public Member Functions | |
| virtual Ipv4RoutingHelper * | Copy (void) const =0 |
| virtual constructor | |
| virtual Ptr< Ipv4RoutingProtocol > | Create (Ptr< Node > node) const =0 |
| void | PrintRoutingTableAllAt (Time printTime, Ptr< OutputStreamWrapper > stream) const |
| prints the routing tables of all nodes at a particular time. | |
| void | PrintRoutingTableAllEvery (Time printInterval, Ptr< OutputStreamWrapper > stream) const |
| prints the routing tables of all nodes at regular intervals specified by user. | |
| void | PrintRoutingTableAt (Time printTime, Ptr< Node > node, Ptr< OutputStreamWrapper > stream) const |
| prints the routing tables of a node at a particular time. | |
| void | PrintRoutingTableEvery (Time printInterval, Ptr< Node > node, Ptr< OutputStreamWrapper > stream) const |
| prints the routing tables of a node at regular intervals specified by user. | |
Detailed Description
a factory to create ns3::Ipv4RoutingProtocol objects
For each new routing protocol created as a subclass of ns3::Ipv4RoutingProtocol, you need to create a subclass of ns3::Ipv4RoutingHelper which can be used by ns3::InternetStackHelper::SetRoutingHelper and ns3::InternetStackHelper::Install.
Member Function Documentation
| virtual Ipv4RoutingHelper* ns3::Ipv4RoutingHelper::Copy | ( | void | ) | const [pure virtual] |
virtual constructor
- Returns:
- pointer to clone of this Ipv4RoutingHelper
This method is mainly for internal use by the other helpers; clients are expected to free the dynamic memory allocated by this method
Implemented in ns3::AodvHelper, ns3::Ipv4NixVectorHelper, ns3::DsdvHelper, ns3::Ipv4GlobalRoutingHelper, ns3::Ipv4ListRoutingHelper, ns3::OlsrHelper, and ns3::Ipv4StaticRoutingHelper.
| virtual Ptr<Ipv4RoutingProtocol> ns3::Ipv4RoutingHelper::Create | ( | Ptr< Node > | node | ) | const [pure virtual] |
- Parameters:
-
node the node within which the new routing protocol will run
- Returns:
- a newly-created routing protocol
Implemented in ns3::AodvHelper, ns3::Ipv4NixVectorHelper, ns3::DsdvHelper, ns3::Ipv4GlobalRoutingHelper, ns3::Ipv4ListRoutingHelper, ns3::OlsrHelper, and ns3::Ipv4StaticRoutingHelper.
| void ns3::Ipv4RoutingHelper::PrintRoutingTableAllAt | ( | Time | printTime, | |
| Ptr< OutputStreamWrapper > | stream | |||
| ) | const |
prints the routing tables of all nodes at a particular time.
- Parameters:
-
printTime the time at which the routing table is supposed to be printed. stream The output stream object to use
This method calls the PrintRoutingTable() method of the Ipv4RoutingProtocol stored in the Ipv4 object, for all nodes at the specified time; the output format is routing protocol-specific.
| void ns3::Ipv4RoutingHelper::PrintRoutingTableAllEvery | ( | Time | printInterval, | |
| Ptr< OutputStreamWrapper > | stream | |||
| ) | const |
prints the routing tables of all nodes at regular intervals specified by user.
- Parameters:
-
printInterval the time interval for which the routing table is supposed to be printed. stream The output stream object to use
This method calls the PrintRoutingTable() method of the Ipv4RoutingProtocol stored in the Ipv4 object, for all nodes at the specified time interval; the output format is routing protocol-specific.
| void ns3::Ipv4RoutingHelper::PrintRoutingTableAt | ( | Time | printTime, | |
| Ptr< Node > | node, | |||
| Ptr< OutputStreamWrapper > | stream | |||
| ) | const |
prints the routing tables of a node at a particular time.
- Parameters:
-
printTime the time at which the routing table is supposed to be printed. node The node ptr for which we need the routing table to be printed stream The output stream object to use
This method calls the PrintRoutingTable() method of the Ipv4RoutingProtocol stored in the Ipv4 object, for the selected node at the specified time; the output format is routing protocol-specific.
| void ns3::Ipv4RoutingHelper::PrintRoutingTableEvery | ( | Time | printInterval, | |
| Ptr< Node > | node, | |||
| Ptr< OutputStreamWrapper > | stream | |||
| ) | const |
prints the routing tables of a node at regular intervals specified by user.
- Parameters:
-
printInterval the time interval for which the routing table is supposed to be printed. node The node ptr for which we need the routing table to be printed stream The output stream object to use
This method calls the PrintRoutingTable() method of the Ipv4RoutingProtocol stored in the Ipv4 object, for the selected node at the specified interval; the output format is routing protocol-specific.
The documentation for this class was generated from the following file:
- src/helper/ipv4-routing-helper.h
