Hold list of Ipv6RoutingProtocol objects. More...
#include "ipv6-list-routing.h"
Public Member Functions | |
Ipv6ListRouting () | |
Constructor. | |
~Ipv6ListRouting () override | |
Destructor. | |
virtual void | AddRoutingProtocol (Ptr< Ipv6RoutingProtocol > routingProtocol, int16_t priority) |
Register a new routing protocol to be used in this IPv4 stack. | |
virtual uint32_t | GetNRoutingProtocols () const |
Get the number of routing protocols. | |
virtual Ptr< Ipv6RoutingProtocol > | GetRoutingProtocol (uint32_t index, int16_t &priority) const |
Get pointer to routing protocol stored at index,. | |
void | NotifyAddAddress (uint32_t interface, Ipv6InterfaceAddress address) override |
Notify when specified interface add an address. | |
void | NotifyAddRoute (Ipv6Address dst, Ipv6Prefix mask, Ipv6Address nextHop, uint32_t interface, Ipv6Address prefixToUse=Ipv6Address::GetZero()) override |
Notify a new route. | |
void | NotifyInterfaceDown (uint32_t interface) override |
Notify when specified interface goes DOWN. | |
void | NotifyInterfaceUp (uint32_t interface) override |
Notify when specified interface goes UP. | |
void | NotifyRemoveAddress (uint32_t interface, Ipv6InterfaceAddress address) override |
Notify when specified interface add an address. | |
void | NotifyRemoveRoute (Ipv6Address dst, Ipv6Prefix mask, Ipv6Address nextHop, uint32_t interface, Ipv6Address prefixToUse=Ipv6Address::GetZero()) override |
Notify route removing. | |
void | PrintRoutingTable (Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S) const override |
Print the Routing Table entries. | |
bool | RouteInput (Ptr< const Packet > p, const Ipv6Header &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< Ipv6Route > | RouteOutput (Ptr< Packet > p, const Ipv6Header &header, Ptr< NetDevice > oif, Socket::SocketErrno &sockerr) override |
Query routing cache for an existing route, for an outbound packet. | |
void | SetIpv6 (Ptr< Ipv6 > ipv6) override |
Typically, invoked directly or indirectly from ns3::Ipv6::SetRoutingProtocol. | |
virtual void | NotifyAddAddress (uint32_t interface, Ipv6InterfaceAddress address)=0 |
Notify when specified interface add an address. | |
virtual void | NotifyAddRoute (Ipv6Address dst, Ipv6Prefix mask, Ipv6Address nextHop, uint32_t interface, Ipv6Address prefixToUse=Ipv6Address::GetZero())=0 |
Notify a new route. | |
virtual void | NotifyInterfaceDown (uint32_t interface)=0 |
Notify when specified interface goes DOWN. | |
virtual void | NotifyInterfaceUp (uint32_t interface)=0 |
Notify when specified interface goes UP. | |
virtual void | NotifyRemoveAddress (uint32_t interface, Ipv6InterfaceAddress address)=0 |
Notify when specified interface add an address. | |
virtual void | NotifyRemoveRoute (Ipv6Address dst, Ipv6Prefix mask, Ipv6Address nextHop, uint32_t interface, Ipv6Address prefixToUse=Ipv6Address::GetZero())=0 |
Notify route removing. | |
virtual void | PrintRoutingTable (Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S) const =0 |
Print the Routing Table entries. | |
virtual bool | RouteInput (Ptr< const Packet > p, const Ipv6Header &header, Ptr< const NetDevice > idev, const UnicastForwardCallback &ucb, const MulticastForwardCallback &mcb, const LocalDeliverCallback &lcb, const ErrorCallback &ecb)=0 |
Route an input packet (to be forwarded or locally delivered) | |
virtual Ptr< Ipv6Route > | RouteOutput (Ptr< Packet > p, const Ipv6Header &header, Ptr< NetDevice > oif, Socket::SocketErrno &sockerr)=0 |
Query routing cache for an existing route, for an outbound packet. | |
virtual void | SetIpv6 (Ptr< Ipv6 > ipv6)=0 |
Typically, invoked directly or indirectly from ns3::Ipv6::SetRoutingProtocol. | |
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. | |
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) 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. | |
virtual TypeId | GetInstanceTypeId () const =0 |
Get the most derived TypeId for this Object. | |
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 () |
Get the type ID of this class. | |
Static Public Member Functions inherited from ns3::Ipv6RoutingProtocol | |
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 |
Dispose this object. | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | DoDispose () |
Destructor implementation. | |
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::pair< int16_t, Ptr< Ipv6RoutingProtocol > > | Ipv6RoutingProtocolEntry |
Container identifying an IPv6 Routing Protocol entry in the list. | |
typedef std::list< Ipv6RoutingProtocolEntry > | Ipv6RoutingProtocolList |
Container of the IPv6 Routing Protocols. | |
Static Private Member Functions | |
static bool | Compare (const Ipv6RoutingProtocolEntry &a, const Ipv6RoutingProtocolEntry &b) |
Compare two routing protocols. | |
Private Attributes | |
Ptr< Ipv6 > | m_ipv6 |
Ipv6 this protocol is associated with. | |
Ipv6RoutingProtocolList | m_routingProtocols |
List of routing protocols. | |
Additional Inherited Members | |
Public Types inherited from ns3::Ipv6RoutingProtocol | |
typedef Callback< void, Ptr< const Packet >, const Ipv6Header &, Socket::SocketErrno > | ErrorCallback |
Callback for routing errors (e.g., no route found) | |
typedef Callback< void, Ptr< const Packet >, const Ipv6Header &, uint32_t > | LocalDeliverCallback |
Callback for packets to be locally delivered. | |
typedef Callback< void, Ptr< const NetDevice >, Ptr< Ipv6MulticastRoute >, Ptr< const Packet >, const Ipv6Header & > | MulticastForwardCallback |
Callback for multicast packets to be forwarded. | |
typedef Callback< void, Ptr< const NetDevice >, Ptr< Ipv6Route >, Ptr< const Packet >, const Ipv6Header & > | UnicastForwardCallback |
Callback for unicast packets to be forwarded. | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Hold list of Ipv6RoutingProtocol objects.
Introspection did not find any typical Config paths.
This class is a specialization of Ipv6RoutingProtocol that allows other instances of Ipv6RoutingProtocol 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.
No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 56 bytes (on a 64-bit architecture).
Definition at line 43 of file ipv6-list-routing.h.
|
private |
Container identifying an IPv6 Routing Protocol entry in the list.
Definition at line 130 of file ipv6-list-routing.h.
|
private |
Container of the IPv6 Routing Protocols.
Definition at line 135 of file ipv6-list-routing.h.
ns3::Ipv6ListRouting::Ipv6ListRouting | ( | ) |
|
override |
|
virtual |
Register a new routing protocol to be used in this IPv4 stack.
routingProtocol | new routing protocol implementation object |
priority | priority to give to this routing protocol. Values may range between -32768 and +32767. |
Definition at line 263 of file ipv6-list-routing.cc.
References Compare(), m_ipv6, m_routingProtocols, and NS_LOG_FUNCTION.
|
staticprivate |
Compare two routing protocols.
a | first object to compare |
b | second object to compare |
Definition at line 305 of file ipv6-list-routing.cc.
Referenced by AddRoutingProtocol().
|
overrideprotectedvirtual |
Dispose this object.
Reimplemented from ns3::Object.
Definition at line 57 of file ipv6-list-routing.cc.
References m_ipv6, m_routingProtocols, and NS_LOG_FUNCTION.
|
virtual |
Get the number of routing protocols.
Definition at line 275 of file ipv6-list-routing.cc.
References m_routingProtocols, and NS_LOG_FUNCTION.
|
virtual |
Get pointer to routing protocol stored at index,.
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.
index | index of protocol to return |
priority | output parameter, set to the priority of the protocol being returned |
Definition at line 282 of file ipv6-list-routing.cc.
References m_routingProtocols, NS_FATAL_ERROR, and NS_LOG_FUNCTION.
|
static |
Get the type ID of this class.
Definition at line 36 of file ipv6-list-routing.cc.
References ns3::TypeId::SetParent().
Referenced by RouteOutput().
|
overridevirtual |
Notify when specified interface add an address.
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.
interface | the index of the interface we are being notified about |
address | a new address being added to an interface |
Implements ns3::Ipv6RoutingProtocol.
Definition at line 174 of file ipv6-list-routing.cc.
References m_routingProtocols, and NS_LOG_FUNCTION.
|
overridevirtual |
Notify a new route.
Typically this is used to add another route from IPv6 stack (i.e. ICMPv6 redirect case, ...).
dst | destination address |
mask | destination mask |
nextHop | nextHop for this destination |
interface | output interface |
prefixToUse | prefix to use as source with this route |
Implements ns3::Ipv6RoutingProtocol.
Definition at line 198 of file ipv6-list-routing.cc.
References m_routingProtocols, and NS_LOG_FUNCTION.
|
overridevirtual |
Notify when specified interface goes DOWN.
Protocols are expected to implement this method to be notified of the state change of an interface in a node.
interface | the index of the interface we are being notified about |
Implements ns3::Ipv6RoutingProtocol.
Definition at line 162 of file ipv6-list-routing.cc.
References m_routingProtocols, and NS_LOG_FUNCTION.
|
overridevirtual |
Notify when specified interface goes UP.
Protocols are expected to implement this method to be notified of the state change of an interface in a node.
interface | the index of the interface we are being notified about |
Implements ns3::Ipv6RoutingProtocol.
Definition at line 150 of file ipv6-list-routing.cc.
References m_routingProtocols, and NS_LOG_FUNCTION.
|
overridevirtual |
Notify when specified interface add an address.
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.
interface | the index of the interface we are being notified about |
address | a new address being added to an interface |
Implements ns3::Ipv6RoutingProtocol.
Definition at line 186 of file ipv6-list-routing.cc.
References m_routingProtocols, and NS_LOG_FUNCTION.
|
overridevirtual |
Notify route removing.
dst | destination address |
mask | destination mask |
nextHop | nextHop for this destination |
interface | output interface |
prefixToUse | prefix to use as source with this route |
Implements ns3::Ipv6RoutingProtocol.
Definition at line 214 of file ipv6-list-routing.cc.
References m_routingProtocols, 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::Ipv6RoutingProtocol.
Definition at line 230 of file ipv6-list-routing.cc.
References ns3::Time::As(), m_ipv6, m_routingProtocols, ns3::Now(), 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 Ipv6RoutingProtocol, 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::Ipv6RoutingProtocol.
Definition at line 105 of file ipv6-list-routing.cc.
References ns3::Socket::ERROR_NOROUTETOHOST, ns3::Ipv6Header::GetDestination(), ns3::Node::GetId(), m_ipv6, m_routingProtocols, 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 ()
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 device. May be zero, or may be bound via socket options to a particular output interface. |
sockerr | Output parameter; socket errno |
Implements ns3::Ipv6RoutingProtocol.
Definition at line 74 of file ipv6-list-routing.cc.
References ns3::Socket::ERROR_NOROUTETOHOST, ns3::Socket::ERROR_NOTERROR, ns3::Ipv6Header::GetDestination(), ns3::Ipv6Header::GetSource(), GetTypeId(), m_routingProtocols, NS_LOG_FUNCTION, and NS_LOG_LOGIC.
Typically, invoked directly or indirectly from ns3::Ipv6::SetRoutingProtocol.
ipv6 | the ipv6 object this routing protocol is being associated with |
Implements ns3::Ipv6RoutingProtocol.
Definition at line 249 of file ipv6-list-routing.cc.
References m_ipv6, m_routingProtocols, NS_ASSERT, and NS_LOG_FUNCTION.
Ipv6 this protocol is associated with.
Definition at line 146 of file ipv6-list-routing.h.
Referenced by AddRoutingProtocol(), DoDispose(), PrintRoutingTable(), RouteInput(), and SetIpv6().
|
private |
List of routing protocols.
Definition at line 145 of file ipv6-list-routing.h.
Referenced by AddRoutingProtocol(), DoDispose(), GetNRoutingProtocols(), GetRoutingProtocol(), NotifyAddAddress(), NotifyAddRoute(), NotifyInterfaceDown(), NotifyInterfaceUp(), NotifyRemoveAddress(), NotifyRemoveRoute(), PrintRoutingTable(), RouteInput(), RouteOutput(), and SetIpv6().