A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::Ipv4ListRouting Class Reference

#include <ipv4-list-routing.h>

+ Inheritance diagram for ns3::Ipv4ListRouting:
+ Collaboration diagram for ns3::Ipv4ListRouting:

Public Member Functions

 Ipv4ListRouting ()
virtual ~Ipv4ListRouting ()
virtual void AddRoutingProtocol (Ptr< Ipv4RoutingProtocol > routingProtocol, int16_t priority)
 Register a new routing protocol to be used in this IPv4 stack.
virtual uint32_t GetNRoutingProtocols (void) const
virtual Ptr< Ipv4RoutingProtocolGetRoutingProtocol (uint32_t index, int16_t &priority) const
virtual void NotifyAddAddress (uint32_t interface, Ipv4InterfaceAddress address)
virtual void NotifyInterfaceDown (uint32_t interface)
virtual void NotifyInterfaceUp (uint32_t interface)
virtual void NotifyRemoveAddress (uint32_t interface, Ipv4InterfaceAddress address)
virtual void PrintRoutingTable (Ptr< OutputStreamWrapper > stream) const
 Print the Routing Table entries.
virtual bool RouteInput (Ptr< const Packet > p, const Ipv4Header &header, Ptr< const NetDevice > idev, UnicastForwardCallback ucb, MulticastForwardCallback mcb, LocalDeliverCallback lcb, ErrorCallback ecb)
 Route an input packet (to be forwarded or locally delivered)
virtual Ptr< Ipv4RouteRouteOutput (Ptr< Packet > p, const Ipv4Header &header, Ptr< NetDevice > oif, Socket::SocketErrno &sockerr)
 Query routing cache for an existing route, for an outbound packet.
virtual void SetIpv4 (Ptr< Ipv4 > ipv4)

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::Ipv4ListRouting.

Protected Member Functions

void DoDispose (void)
void DoStart (void)

Private Types

typedef std::pair< int16_t,
Ptr< Ipv4RoutingProtocol > > 
Ipv4RoutingProtocolEntry
typedef std::list
< Ipv4RoutingProtocolEntry
Ipv4RoutingProtocolList

Static Private Member Functions

static bool Compare (const Ipv4RoutingProtocolEntry &a, const Ipv4RoutingProtocolEntry &b)

Private Attributes

Ptr< Ipv4m_ipv4
Ipv4RoutingProtocolList m_routingProtocols

Additional Inherited Members

- Public Types inherited from ns3::Ipv4RoutingProtocol
typedef Callback< void, Ptr
< const Packet >, const
Ipv4Header
&, Socket::SocketErrno
ErrorCallback
typedef Callback< void, Ptr
< const Packet >, const
Ipv4Header &, uint32_t > 
LocalDeliverCallback
typedef Callback< void, Ptr
< Ipv4MulticastRoute >, Ptr
< const Packet >, const
Ipv4Header & > 
MulticastForwardCallback
typedef Callback< void, Ptr
< Ipv4Route >, Ptr< const
Packet >, const Ipv4Header & > 
UnicastForwardCallback

Detailed Description

This class is a specialization of Ipv4RoutingProtocol that allows other instances of Ipv4RoutingProtocol to be inserted in a prioritized list. Routing protocols in the list are consulted one by one, from highest to lowest priority, until a routing protocol is found that will take the packet (this corresponds to a non-zero return value to RouteOutput, or a return value of true to RouteInput). The order by which routing protocols with the same priority value are consulted is undefined.

Definition at line 45 of file ipv4-list-routing.h.

Member Typedef Documentation

Definition at line 95 of file ipv4-list-routing.h.

Constructor & Destructor Documentation

ns3::Ipv4ListRouting::Ipv4ListRouting ( )

Definition at line 44 of file ipv4-list-routing.cc.

References NS_LOG_FUNCTION_NOARGS.

ns3::Ipv4ListRouting::~Ipv4ListRouting ( )
virtual

Definition at line 50 of file ipv4-list-routing.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

void ns3::Ipv4ListRouting::AddRoutingProtocol ( Ptr< Ipv4RoutingProtocol routingProtocol,
int16_t  priority 
)
virtual

Register a new routing protocol to be used in this IPv4 stack.

Parameters
routingProtocolnew routing protocol implementation object
prioritypriority to give to this routing protocol. Values may range between -32768 and +32767.

Definition at line 250 of file ipv4-list-routing.cc.

References Compare(), ns3::Object::GetInstanceTypeId(), m_ipv4, m_routingProtocols, NS_LOG_FUNCTION, and ns3::Ipv4RoutingProtocol::SetIpv4().

+ Here is the call graph for this function:

bool ns3::Ipv4ListRouting::Compare ( const Ipv4RoutingProtocolEntry a,
const Ipv4RoutingProtocolEntry b 
)
staticprivate

Definition at line 290 of file ipv4-list-routing.cc.

Referenced by AddRoutingProtocol().

+ Here is the caller graph for this function:

void ns3::Ipv4ListRouting::DoDispose ( void  )
protectedvirtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden 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 56 of file ipv4-list-routing.cc.

References m_ipv4, m_routingProtocols, and NS_LOG_FUNCTION_NOARGS.

void ns3::Ipv4ListRouting::DoStart ( void  )
protectedvirtual

This method is called only once by Object::Start. If the user calls Object::Start multiple times, DoStart is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject and AggregateObject from within this method.

Reimplemented from ns3::Object.

Definition at line 87 of file ipv4-list-routing.cc.

References m_routingProtocols, and ns3::Object::Start().

+ Here is the call graph for this function:

uint32_t ns3::Ipv4ListRouting::GetNRoutingProtocols ( void  ) const
virtual
Returns
number of routing protocols in the list

Definition at line 262 of file ipv4-list-routing.cc.

References m_routingProtocols, and NS_LOG_FUNCTION.

Referenced by main().

+ Here is the caller graph for this function:

Ptr< Ipv4RoutingProtocol > ns3::Ipv4ListRouting::GetRoutingProtocol ( uint32_t  index,
int16_t &  priority 
) const
virtual

Return pointer to routing protocol stored at index, with the first protocol (index 0) the highest priority, the next one (index 1) the second highest priority, and so on. The priority parameter is an output parameter and it returns the integer priority of the protocol.

Returns
pointer to routing protocol indexed by
Parameters
indexindex of protocol to return
priorityoutput parameter, set to the priority of the protocol being returned

Definition at line 269 of file ipv4-list-routing.cc.

References m_routingProtocols, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by main().

+ Here is the caller graph for this function:

TypeId ns3::Ipv4ListRouting::GetTypeId ( void  )
static

This method returns the TypeId associated to ns3::Ipv4ListRouting.

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Ipv4RoutingProtocol.

Definition at line 34 of file ipv4-list-routing.cc.

References ns3::TypeId::SetParent().

Referenced by RouteOutput().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::Ipv4ListRouting::NotifyAddAddress ( uint32_t  interface,
Ipv4InterfaceAddress  address 
)
virtual
Parameters
interfacethe index of the interface we are being notified about
addressa 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 211 of file ipv4-list-routing.cc.

References m_routingProtocols, and NS_LOG_FUNCTION.

void ns3::Ipv4ListRouting::NotifyInterfaceDown ( uint32_t  interface)
virtual
Parameters
interfacethe 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 199 of file ipv4-list-routing.cc.

References m_routingProtocols, and NS_LOG_FUNCTION.

void ns3::Ipv4ListRouting::NotifyInterfaceUp ( uint32_t  interface)
virtual
Parameters
interfacethe 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 187 of file ipv4-list-routing.cc.

References m_routingProtocols, and NS_LOG_FUNCTION.

void ns3::Ipv4ListRouting::NotifyRemoveAddress ( uint32_t  interface,
Ipv4InterfaceAddress  address 
)
virtual
Parameters
interfacethe index of the interface we are being notified about
addressa 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 223 of file ipv4-list-routing.cc.

References m_routingProtocols, and NS_LOG_FUNCTION.

void ns3::Ipv4ListRouting::PrintRoutingTable ( Ptr< OutputStreamWrapper stream) const
virtual

Print the Routing Table entries.

Parameters
streamthe ostream the Routing table is printed to

Implements ns3::Ipv4RoutingProtocol.

Definition at line 72 of file ipv4-list-routing.cc.

References ns3::Object::GetObject(), ns3::Time::GetSeconds(), ns3::OutputStreamWrapper::GetStream(), m_ipv4, m_routingProtocols, and ns3::Now().

+ Here is the call graph for this function:

bool ns3::Ipv4ListRouting::RouteInput ( Ptr< const Packet p,
const Ipv4Header header,
Ptr< const NetDevice idev,
UnicastForwardCallback  ucb,
MulticastForwardCallback  mcb,
LocalDeliverCallback  lcb,
ErrorCallback  ecb 
)
virtual

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.

Parameters
preceived packet
headerinput parameter used to form a search key for a route
idevPointer to ingress network device
ucbCallback for the case in which the packet is to be forwarded as unicast
mcbCallback for the case in which the packet is to be forwarded as multicast
lcbCallback for the case in which the packet is to be locally delivered
ecbCallback to call if there is an error in forwarding
Returns
true if the Ipv4RoutingProtocol takes responsibility for forwarding or delivering the packet, false otherwise

Implements ns3::Ipv4RoutingProtocol.

Definition at line 126 of file ipv4-list-routing.cc.

References ns3::Packet::Copy(), ns3::Socket::ERROR_NOROUTETOHOST, ns3::Ipv4Header::GetDestination(), ns3::Node::GetId(), ns3::Ipv4::GetInterfaceForDevice(), ns3::Object::GetObject(), ns3::Ipv4::IsDestinationAddress(), ns3::Ipv4::IsForwarding(), ns3::Ipv4Address::IsMulticast(), m_ipv4, m_routingProtocols, NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

+ Here is the call graph for this function:

Ptr< Ipv4Route > ns3::Ipv4ListRouting::RouteOutput ( Ptr< Packet p,
const Ipv4Header header,
Ptr< NetDevice oif,
Socket::SocketErrno sockerr 
)
virtual

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.

Parameters
ppacket to be routed. Note that this method may modify the packet. Callers may also pass in a null pointer.
headerinput parameter (used to form key to search for the route)
oifOutput interface Netdevice. May be zero, or may be bound via socket options to a particular output interface.
sockerrOutput parameter; socket errno
Returns
a code that indicates what happened in the lookup

Implements ns3::Ipv4RoutingProtocol.

Definition at line 100 of file ipv4-list-routing.cc.

References ns3::Socket::ERROR_NOROUTETOHOST, ns3::Socket::ERROR_NOTERROR, ns3::Ipv4Header::GetDestination(), ns3::Ipv4Header::GetSource(), GetTypeId(), m_routingProtocols, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

+ Here is the call graph for this function:

void ns3::Ipv4ListRouting::SetIpv4 ( Ptr< Ipv4 ipv4)
virtual
Parameters
ipv4the ipv4 object this routing protocol is being associated with

Typically, invoked directly or indirectly from ns3::Ipv4::SetRoutingProtocol

Implements ns3::Ipv4RoutingProtocol.

Definition at line 235 of file ipv4-list-routing.cc.

References m_ipv4, m_routingProtocols, NS_ASSERT, and NS_LOG_FUNCTION.

Member Data Documentation

Ptr<Ipv4> ns3::Ipv4ListRouting::m_ipv4
private

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