Dsr Routing base. More...

#include <introspected-doxygen.h>

Inheritance diagram for ns3::dsr::DsrRouting:

Public Member Functions
	DsrRouting ()
	Constructor.

virtual	~DsrRouting ()
	Destructor.

uint16_t	AddAckReqHeader (Ptr< Packet > &packet, Ipv4Address nextHop)
	This function is called to add ack request header for network acknowledgement.

int64_t	AssignStreams (int64_t stream)

void	CallCancelPacketTimer (uint16_t ackId, Ipv4Header const &ipv4Header, Ipv4Address realSrc, Ipv4Address realDst)
	Call the cancel packet retransmission timer function.

void	CancelLinkPacketTimer (MaintainBuffEntry &mb)
	Cancel the link packet retransmission timer for a specific maintenance entry.

void	CancelNetworkPacketTimer (MaintainBuffEntry &mb)
	Cancel the network packet retransmission timer for a specific maintenance entry.

void	CancelPacketTimerNextHop (Ipv4Address nextHop, uint8_t protocol)
	Cancel the packet retransmission timer for a all maintenance entries with nextHop address.

void	CancelPassivePacketTimer (MaintainBuffEntry &mb)
	Cancel the passive packet retransmission timer for a specific maintenance entry.

bool	CancelPassiveTimer (Ptr< Packet > packet, Ipv4Address source, Ipv4Address destination, uint8_t segsLeft)
	Cancel the passive timer.

void	CancelRreqTimer (Ipv4Address dst, bool isRemove)
	Cancel the route request timer. More...

void	CheckSendBuffer ()
	Check the send buffer of packets with route when send buffer timer expire. More...

void	ConnectCallbacks ()
	Connect the callback for the tracing event. More...

void	ForwardErrPacket (DsrOptionRerrUnreachHeader &rerr, DsrOptionSRHeader &sourceRoute, Ipv4Address nextHop, uint8_t protocol, Ptr< Ipv4Route > route)
	This function is responsible for forwarding error packets along the route.

void	ForwardPacket (Ptr< const Packet > packet, DsrOptionSRHeader &sourceRoute, Ipv4Header const &ipv4Header, Ipv4Address source, Ipv4Address destination, Ipv4Address targetAddress, uint8_t protocol, Ptr< Ipv4Route > route)
	Forward the packet using the route saved in the source route option header.

IpL4Protocol::DownTargetCallback	GetDownTarget (void) const

IpL4Protocol::DownTargetCallback6	GetDownTarget6 (void) const

std::vector< std::string >	GetElementsFromContext (std::string context)
	Get the elements from the tracing context. More...

uint8_t	GetExtensionNumber () const
	Get the extension number. More...

uint16_t	GetIDfromIP (Ipv4Address address)
	Get the node id from ip address. More...

Ipv4Address	GetIPfromID (uint16_t id)
	Get the ip address from id. More...

Ipv4Address	GetIPfromMAC (Mac48Address address)
	Get the Ip address from mac address. More...

Ptr< NetDevice >	GetNetDeviceFromContext (std::string context)
	Get the netdevice from the context. More...

Ptr< Node >	GetNode () const
	Get the node. More...

Ptr< Node >	GetNodeWithAddress (Ipv4Address ipv4Address)
	Get the node with give ip address. More...

Ptr< dsr::DsrOptions >	GetOption (int optionNumber)
	Get the option corresponding to optionNumber. More...

Ptr< dsr::PassiveBuffer >	GetPassiveBuffer () const
	Get the passive buffer. More...

uint32_t	GetPriority (DsrMessageType messageType)
	Set the priority of the packet in network queue. More...

int	GetProtocolNumber (void) const
	Get the dsr protocol number. More...

Ptr< dsr::RreqTable >	GetRequestTable () const
	Get the request table. More...

Ptr< dsr::RouteCache >	GetRouteCache () const
	Get the route cache. More...

void	IncreaseRetransTimer ()
	This function is called to increase the retransmission timer for data packet in the network queue.

void	Insert (Ptr< dsr::DsrOptions > option)
	Insert a new Dsr Option. More...

void	LinkScheduleTimerExpire (MaintainBuffEntry &mb, uint8_t protocol)
	This function deals with packet retransmission timer expire using link acknowledgment.

void	NetworkScheduleTimerExpire (MaintainBuffEntry &mb, uint8_t protocol)
	This function deals with packet retransmission timer expire using network acknowledgment.

void	PacketNewRoute (Ptr< Packet > packet, Ipv4Address source, Ipv4Address destination, uint8_t protocol)
	When route vector corrupted, originate a new packet, normally not happening. More...

bool	PassiveEntryCheck (Ptr< Packet > packet, Ipv4Address source, Ipv4Address destination, uint8_t segsLeft, uint16_t fragmentOffset, uint16_t identification, bool saveEntry)
	Find the same passive entry. More...

void	PassiveScheduleTimerExpire (MaintainBuffEntry &mb, uint8_t protocol)
	This function deals with packet retransmission timer expire using passive acknowledgment.

void	PrintVector (std::vector< Ipv4Address > &vec)
	Print the route vector.

void	PriorityScheduler (uint32_t priority, bool continueWithFirst)
	This function is called to schedule sending packets from the network queue by priority.

uint8_t	Process (Ptr< Packet > &packet, Ipv4Header const &ipv4Header, Ipv4Address dst, uint8_t *nextHeader, uint8_t protocol, bool &isDropped)
	Process method Called from Ipv4L3Protocol::Receive. More...

virtual enum IpL4Protocol::RxStatus	Receive (Ptr< Packet > p, Ipv4Header const &header, Ptr< Ipv4Interface > incomingInterface)

virtual enum IpL4Protocol::RxStatus	Receive (Ptr< Packet > p, Ipv6Header const &header, Ptr< Ipv6Interface > incomingInterface)

void	RouteRequestTimerExpire (Ptr< Packet > packet, std::vector< Ipv4Address > address, uint32_t requestId, uint8_t protocol)

void	SalvagePacket (Ptr< const Packet > packet, Ipv4Address source, Ipv4Address dst, uint8_t protocol)
	Salvage the packet which has been transmitted for 3 times. More...

void	ScheduleCachedReply (Ptr< Packet > packet, Ipv4Address source, Ipv4Address destination, Ptr< Ipv4Route > route, double hops)

void	ScheduleInitialReply (Ptr< Packet > packet, Ipv4Address source, Ipv4Address nextHop, Ptr< Ipv4Route > route)

void	ScheduleInterRequest (Ptr< Packet > packet)
	Schedule the intermediate route request. More...

void	ScheduleLinkPacketRetry (MaintainBuffEntry &mb, uint8_t protocol)
	Schedule the packet retransmission based on link-layer acknowledgment. More...

void	ScheduleNetworkPacketRetry (MaintainBuffEntry &mb, bool isFirst, uint8_t protocol)
	Schedule the packet retransmission based on network layer acknowledgment. More...

void	SchedulePassivePacketRetry (MaintainBuffEntry &mb, uint8_t protocol)
	Schedule the packet retransmission based on passive acknowledgment. More...

void	Scheduler (uint32_t priority)
	This function is called to schedule sending packets from the network queue.

void	ScheduleRreqRetry (Ptr< Packet > packet, std::vector< Ipv4Address > address, bool nonProp, uint32_t requestId, uint8_t protocol)
	Schedule the route request retry. More...

Ipv4Address	SearchNextHop (Ipv4Address ipv4Address, std::vector< Ipv4Address > &vec)
	Get the next hop of the route. More...

void	Send (Ptr< Packet > packet, Ipv4Address source, Ipv4Address destination, uint8_t protocol, Ptr< Ipv4Route > route)
	This function is called by higher layer protocol when sending packets. More...

void	SendAck (uint16_t ackId, Ipv4Address destination, Ipv4Address realSrc, Ipv4Address realDst, uint8_t protocol, Ptr< Ipv4Route > route)

void	SendBuffTimerExpire ()
	The send buffer timer expire.

void	SendErrorRequest (DsrOptionRerrUnreachHeader &rerr, uint8_t protocol)
	Send the error request packet. More...

void	SendGratuitousReply (Ipv4Address replyTo, Ipv4Address replyFrom, std::vector< Ipv4Address > &nodeList, uint8_t protocol)
	Send the gratuitous reply. More...

void	SendInitialRequest (Ipv4Address source, Ipv4Address destination, uint8_t protocol)
	Broadcast the route request packet in subnet.

void	SendPacket (Ptr< Packet > packet, Ipv4Address source, Ipv4Address nextHop, uint8_t protocol)
	This function is called by when really sending out the packet.

void	SendPacketFromBuffer (DsrOptionSRHeader const &sourceRoute, Ipv4Address nextHop, uint8_t protocol)
	This function is responsible for sending out data packets when have route, if no route found, it will cache the packet and send out route requests. More...

bool	SendRealDown (DsrNetworkQueueEntry &newEntry)
	This function is called to send packets down stack.

void	SendReply (Ptr< Packet > packet, Ipv4Address source, Ipv4Address nextHop, Ptr< Ipv4Route > route)

void	SendRequest (Ptr< Packet > packet, Ipv4Address source)
	Forward the route request if the node is not the destination. More...

void	SendRequestAndIncrement (Ptr< Packet > packet, Ipv4Address source, Ipv4Address destination)
	Send the route request and increment the request count. More...

void	SendUnreachError (Ipv4Address errorHop, Ipv4Address destination, Ipv4Address originalDst, uint8_t salvage, uint8_t protocol)
	This function is responsible for sending error packets in case of break link to next hop. More...

void	SetDownTarget (IpL4Protocol::DownTargetCallback callback)

void	SetDownTarget6 (IpL4Protocol::DownTargetCallback6 callback)

void	SetNode (Ptr< Node > node)
	Set the node. More...

void	SetPassiveBuffer (Ptr< dsr::PassiveBuffer > r)
	Set the node. More...

void	SetRequestTable (Ptr< dsr::RreqTable > r)
	Set the node. More...

Ptr< Ipv4Route >	SetRoute (Ipv4Address nextHop, Ipv4Address srcAddress)
	Set the route to use for data packets. More...

void	SetRouteCache (Ptr< dsr::RouteCache > r)
	Set the route cache. More...


bool	IsLinkCache ()
	used to direct to route cache

void	UseExtends (RouteCacheEntry::IP_VECTOR rt)

bool	LookupRoute (Ipv4Address id, RouteCacheEntry &rt)

bool	AddRoute_Link (RouteCacheEntry::IP_VECTOR nodelist, Ipv4Address source)

bool	AddRoute (RouteCacheEntry &rt)

void	DeleteAllRoutesIncludeLink (Ipv4Address errorSrc, Ipv4Address unreachNode, Ipv4Address node)

bool	UpdateRouteEntry (Ipv4Address dst)

bool	FindSourceEntry (Ipv4Address src, Ipv4Address dst, uint16_t id)

Public Member Functions inherited from ns3::IpL4Protocol
virtual void	ReceiveIcmp (Ipv4Address icmpSource, uint8_t icmpTtl, uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo, Ipv4Address payloadSource, Ipv4Address payloadDestination, const uint8_t payload[8])

virtual void	ReceiveIcmp (Ipv6Address icmpSource, uint8_t icmpTtl, uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo, Ipv6Address payloadSource, Ipv6Address payloadDestination, const uint8_t payload[8])

Public Member Functions inherited from ns3::Object
void	AggregateObject (Ptr< Object > other)

void	Dispose (void)

AggregateIterator	GetAggregateIterator (void) const

virtual TypeId	GetInstanceTypeId (void) const

template<typename T >
Ptr< T >	GetObject (void) const

template<typename T >
Ptr< T >	GetObject (TypeId tid) const

void	Initialize (void)

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount (const SimpleRefCount &o)

uint32_t	GetReferenceCount (void) const

SimpleRefCount &	operator= (const SimpleRefCount &o)

void	Ref (void) const

void	Unref (void) const

Public Member Functions inherited from ns3::ObjectBase
void	GetAttribute (std::string name, AttributeValue &value) const

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type identificator. More...

Static Public Member Functions inherited from ns3::IpL4Protocol
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)

Static Public Attributes
static const uint8_t	PROT_NUMBER = 48
	Define the dsr protocol number.

Protected Member Functions
virtual void	DoDispose (void)
	Drop trace callback.

virtual void	NotifyNewAggregate ()

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	DoInitialize (void)

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)

Protected Attributes
TracedCallback< Ptr< const Packet > >	m_dropTrace

TracedCallback< const DsrOptionSRHeader & >	m_txPacketTrace

Private Types
typedef std::list< Ptr < DsrOptions > >	DsrOptionList_t
	Define the list to hold DSR options.

Private Member Functions
void	NotifyDataReceipt (std::string context, Ptr< const Packet > p)
	Notify the data receipt. More...

bool	PromiscReceive (Ptr< NetDevice > device, Ptr< const Packet > packet, uint16_t protocol, const Address &from, const Address &to, NetDevice::PacketType packetType)
	Promiscuous receive data packets destined to some other node. More...

void	SendRerrWhenBreaksLinkToNextHop (Ipv4Address nextHop, uint8_t protocol)
	Send the route error message when the link breaks to the next hop. More...

void	Start ()

Private Attributes
uint16_t	m_ackId
	The ack id assigned to each acknowledge.

std::vector< Ipv4Address >	m_addresses
	The bind ipv4 addresses with next hop, src, destination address in sequence.

std::map< NetworkKey, uint32_t >	m_addressForwardCnt
	Map network key + forward counts.

std::map< NetworkKey, Timer >	m_addressForwardTimer
	Map network key + forward timer.

std::map< Ipv4Address, Timer >	m_addressReqTimer
	Map IP address + RREQ timer.

Time	m_blacklistTimeout
	The black list time out.

Ipv4Address	m_broadcast
	The broadcast IP address.

uint32_t	m_broadcastJitter
	The max time to delay route request broadcast.

std::string	m_cacheType
	The type of route cache.

std::vector< Ipv4Address >	m_clearList
	The node that is clear to send packet to.

uint32_t	m_discoveryHopLimit
	Maximum hops to go for route request.

IpL4Protocol::DownTargetCallback	m_downTarget
	The callback for down layer.

ErrorBuffer	m_errorBuffer
	The error buffer to save the error messages.

std::vector< Ipv4Address >	m_finalRoute
	The route cache.

GraReply	m_graReply
	The gratuitous route reply.

uint32_t	m_graReplyTableSize
	Set the gratuitous reply table size.

Time	m_gratReplyHoldoff
	The max gratuitous reply hold off time.

Time	m_initStability
	The initial stability value for link cache.

Ptr< Ipv4 >	m_ip
	The ip ptr.

Ptr< Ipv4L3Protocol >	m_ipv4
	Ipv4l3Protocol.

Ptr< Ipv4Route >	m_ipv4Route
	Ipv4 Route.

bool	m_linkAck
	define if we use link acknowledgement or not

Time	m_linkAckTimeout
	The timeout value for link acknowledge.

std::map< LinkKey, Timer >	m_linkAckTimer
	The timer for link acknowledgment.

std::map< LinkKey, uint32_t >	m_linkCnt
	Map packet key + link forward counts.

uint32_t	m_linkRetries
	of retries have been sent for link acknowledgment

std::map< std::string, uint32_t >	m_macToNodeIdMap
	The map of mac address to node id.

Ipv4Address	m_mainAddress
	Our own Ip address.

MaintainBuffer	m_maintainBuffer
	The declaration of maintain buffer.

uint32_t	m_maxCacheLen
	Max # of cache entries for route cache.

Time	m_maxCacheTime
	Max time for caching the route cache entry.

uint32_t	m_maxEntriesEachDst
	Max number of route entries to save for each destination.

uint32_t	m_maxMaintainLen
	Max # of entries for maintainance buffer.

Time	m_maxMaintainTime
	Time out for maintainance buffer.

uint32_t	m_maxMaintRexmt
	Maximum number of retransmissions of data packets.

Time	m_maxNetworkDelay
	Maximum network delay.

uint32_t	m_maxNetworkSize
	Maximum network queue size.

Time	m_maxRequestPeriod
	The max request period.

uint32_t	m_maxRreqId
	The max number of request ids for a single destination.

Time	m_maxRreqTime
	Max time for caching the route request entry.

uint8_t	m_maxSalvageCount
	Maximum # times to salvage a packet.

uint32_t	m_maxSendBuffLen
	The maximum number of packets that we allow a routing protocol to buffer.

Time	m_minLifeTime
	The min life time.

Ptr< Node >	m_node
	The node ptr.

Time	m_nodeTraversalTime
	Time estimated for packet to travel between two nodes.

std::map< Ipv4Address, Timer >	m_nonPropReqTimer
	Map IP address + RREQ timer.

Time	m_nonpropRequestTimeout
	The non-propagation request timeout.

uint32_t	m_numPriorityQueues
	The number of priority queues used.

DsrOptionList_t	m_options
	List of DSR Options supported.

Time	m_passiveAckTimeout
	The timeout value for passive acknowledge.

std::map< PassiveKey, Timer >	m_passiveAckTimer
	The timer for passive acknowledgment.

Ptr< dsr::PassiveBuffer >	m_passiveBuffer
	A "drop-front" queue used by the routing layer to cache route request sent.

std::map< PassiveKey, uint32_t >	m_passiveCnt
	Map packet key + passive forward counts.

uint32_t	m_passiveRetries
	of retries have been sent for passive acknowledgment

std::map< uint32_t, Ptr < dsr::DsrNetworkQueue > >	m_priorityQueue
	priority queues

uint32_t	m_requestId
	The id assigned to each route request.

Time	m_requestPeriod
	The base time interval between route requests.

uint32_t	m_requestTableIds
	The request table identifiers.

uint32_t	m_requestTableSize
	The max size of the request table size.

Time	m_retransIncr
	the increase time for retransmission timer when face network congestion

Ptr< dsr::RouteCache >	m_routeCache
	A "drop-front" queue used by the routing layer to cache routes found.

std::string	m_routeSortType
	The type of route sort methods.

uint32_t	m_rreqRetries
	Maximum number of retransmissions of RREQ with TTL = NetDiameter to discover a route.

Ptr< dsr::RreqTable >	m_rreqTable
	A "drop-front" queue used by the routing layer to cache route request sent.

SendBuffer	m_sendBuffer
	The send buffer.

Time	m_sendBufferTimeout
	The maximum period of time that a routing protocol is allowed to buffer a packet for.

Time	m_sendBuffInterval
	how often to check send buffer

Timer	m_sendBuffTimer
	The send buffer timer.

uint32_t	m_sendRetries
	of retries have been sent for network acknowledgment

uint32_t	m_stabilityDecrFactor
	The initial decrease factor for link cache.

uint32_t	m_stabilityIncrFactor
	The initial increase factor for link cache.

bool	m_subRoute
	Whether to save sub route or not.

uint32_t	m_tryLinkAcks
	Maximum number of packet transmission using link acknowledgment.

uint32_t	m_tryPassiveAcks
	Maximum number of packet transmission using passive acknowledgment.

Ptr< UniformRandomVariable >	m_uniformRandomVariable
	Provides uniform random variables.

Time	m_useExtends
	The use extension of the life time for link cache.

uint8_t	segsLeft
	The segment left value from SR header.

Additional Inherited Members
Public Types inherited from ns3::IpL4Protocol
typedef Callback< void, Ptr < Packet >, Ipv4Address, Ipv4Address, uint8_t, Ptr < Ipv4Route > >	DownTargetCallback

typedef Callback< void, Ptr < Packet >, Ipv6Address, Ipv6Address, uint8_t, Ptr < Ipv6Route > >	DownTargetCallback6

enum	RxStatus { RX_OK, RX_CSUM_FAILED, RX_ENDPOINT_CLOSED, RX_ENDPOINT_UNREACH }

Detailed Description

Dsr Routing base.

Doxygen introspection did not find any typical Config paths.

Attributes

RouteCache: The route cache for saving routes from route discovery process.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::dsr::RouteCache >
- Initial value: 0
- Flags: construct write read
RreqTable: The request table to manage route requests.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::dsr::RreqTable >
- Initial value: 0
- Flags: construct write read
PassiveBuffer: The passive buffer to manage promisucously received passive ack.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::dsr::PassiveBuffer >
- Initial value: 0
- Flags: construct write read
MaxSendBuffLen: Maximum number of packets that can be stored in send buffer.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 64
- Flags: construct write read
MaxSendBuffTime: Maximum time packets can be queued in the send buffer .
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +30000000000.0ns
- Flags: construct write read
MaxMaintLen: Maximum number of packets that can be stored in maintenance buffer.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 50
- Flags: construct write read
MaxMaintTime: Maximum time packets can be queued in maintenance buffer.
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +30000000000.0ns
- Flags: construct write read
MaxCacheLen: Maximum number of route entries that can be stored in route cache.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 64
- Flags: construct write read
RouteCacheTimeout: Maximum time the route cache can be queued in route cache.
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +300000000000.0ns
- Flags: construct write read
MaxEntriesEachDst: Maximum number of route entries for a single destination to respond.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 20
- Flags: construct write read
SendBuffInterval: How often to check send buffer for packet with route.
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +500000000000.0ns
- Flags: construct write read
NodeTraversalTime: The time it takes to traverse two neighboring nodes.
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +40000000.0ns
- Flags: construct write read
RreqRetries: Maximum number of retransmissions for request discovery of a route.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 16
- Flags: construct write read
MaintenanceRetries: Maximum number of retransmissions for data packets from maintenance buffer.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 2
- Flags: construct write read
RequestTableSize: Maximum number of request entries in the request table, set this as the number of nodes in the simulation.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 64
- Flags: construct write read
RequestIdSize: Maximum number of request source Ids in the request table.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 16
- Flags: construct write read
UniqueRequestIdSize: Maximum number of request Ids in the request table for a single destination.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 256
- Flags: construct write read
NonPropRequestTimeout: The timeout value for non-propagation request.
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +30000000.0ns
- Flags: construct write read
DiscoveryHopLimit: The max discovery hop limit for route requests.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 255
- Flags: construct write read
MaxSalvageCount: The max salvage count for a single data packet.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 15
- Flags: construct write read
BlacklistTimeout: The time for a neighbor to stay in blacklist.
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +3000000000.0ns
- Flags: construct write read
GratReplyHoldoff: The time for gratuitous reply entry to expire.
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +1000000000.0ns
- Flags: construct write read
BroadcastJitter: The jitter time to avoid collision for broadcast packets.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 10
- Flags: construct write read
LinkAckTimeout: The time a packet in maintenance buffer wait for link acknowledgment.
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +100000000.0ns
- Flags: construct write read
TryLinkAcks: The number of link acknowledgment to use.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 1
- Flags: construct write read
PassiveAckTimeout: The time a packet in maintenance buffer wait for passive acknowledgment.
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +100000000.0ns
- Flags: construct write read
TryPassiveAcks: The number of passive acknowledgment to use.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 1
- Flags: construct write read
RequestPeriod: The base time interval between route requests.
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +500000000.0ns
- Flags: construct write read
MaxRequestPeriod: The max time interval between route requests.
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +10000000000.0ns
- Flags: construct write read
GraReplyTableSize: The gratuitous reply table size.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 64
- Flags: construct write read
CacheType: Use Link Cache or use Path Cache
- Set with class: StringValue
- Underlying type: std::string
- Initial value: LinkCache
- Flags: construct write read
StabilityDecrFactor: The stability decrease factor for link cache
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 2
- Flags: construct write read
StabilityIncrFactor: The stability increase factor for link cache
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 4
- Flags: construct write read
InitStability: The initial stability factor for link cache
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +25000000000.0ns
- Flags: construct write read
MinLifeTime: The minimal life time for link cache
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +1000000000.0ns
- Flags: construct write read
UseExtends: The extension time for link cache
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +120000000000.0ns
- Flags: construct write read
EnableSubRoute: Enables saving of sub route when receiving route error messages, only available when using path route cache
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: construct write read
RetransIncr: The increase time for retransmission timer when facing network congestion
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +20000000.0ns
- Flags: construct write read
MaxNetworkQueueSize: The max number of packet to save in the network queue.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 400
- Flags: construct write read
MaxNetworkQueueDelay: The max time for a packet to stay in the network queue.
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +30000000000.0ns
- Flags: construct write read
NumPriorityQueues: The max number of packet to save in the network queue.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 2
- Flags: construct write read
LinkAcknowledgment: Enable Link layer acknowledgment mechanism
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read

Attributes defined in parent class ns3::IpL4Protocol

ProtocolNumber: The Ip protocol number.
- Set with class: ns3::UintegerValue
- Underlying type: int32_t 18446744071562067968:2147483647
- Flags: read

TraceSources

Tx: Send DSR packet.
Drop: Drop DSR packet

Definition at line 95 of file dsr-routing.h.

Member Function Documentation

int64_t ns3::dsr::DsrRouting::AssignStreams ( int64_t stream )

Assign a fixed random variable stream number to the random variables used by this model. Return the number of streams (possibly zero) that have been assigned.

Parameters

stream first stream index to use

Returns: the number of stream indices assigned by this model

Definition at line 2705 of file dsr-routing.cc.

References m_uniformRandomVariable, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().

void ns3::dsr::DsrRouting::CancelRreqTimer	(	Ipv4Address	dst,
		bool	isRemove
	)

Cancel the route request timer.

Parameters

dst	The dst address of the route request timer
isRemove	whether to remove the route request entry or not

Definition at line 3016 of file dsr-routing.cc.

References m_addressReqTimer, m_nonPropReqTimer, m_rreqTable, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by RouteRequestTimerExpire(), and SendErrorRequest().

void ns3::dsr::DsrRouting::CheckSendBuffer ( )

Check the send buffer of packets with route when send buffer timer expire.

When found a route and use it, UseExtends to the link cache

This will be priority 0

When found a route and use it, UseExtends to the link cache

Definition at line 999 of file dsr-routing.cc.

Referenced by SendBuffTimerExpire().

void ns3::dsr::DsrRouting::ConnectCallbacks ( )

Connect the callback for the tracing event.

Returns: void

Definition at line 454 of file dsr-routing.cc.

References ns3::Config::Connect(), ns3::MakeCallback(), and NotifyDataReceipt().

IpL4Protocol::DownTargetCallback ns3::dsr::DsrRouting::GetDownTarget ( void ) const

virtual

This method allows a caller to get the current down target callback set for this L4 protocol, for

Returns: current Callback for the L4 protocol

Implements ns3::IpL4Protocol.

Definition at line 3632 of file dsr-routing.cc.

References m_downTarget.

std::vector< std::string > ns3::dsr::DsrRouting::GetElementsFromContext ( std::string context )

Get the elements from the tracing context.

Returns: the elements we are looking for

Definition at line 556 of file dsr-routing.cc.

Referenced by GetNetDeviceFromContext().

uint8_t ns3::dsr::DsrRouting::GetExtensionNumber ( ) const

Get the extension number.

Returns: extension number

uint16_t ns3::dsr::DsrRouting::GetIDfromIP ( Ipv4Address address )

Get the node id from ip address.

Returns: the node id

Definition at line 800 of file dsr-routing.cc.

References ns3::NodeList::GetNNodes(), ns3::NodeList::GetNode(), and ns3::Object::GetObject().

Referenced by CheckSendBuffer(), ForwardErrPacket(), ForwardPacket(), PacketNewRoute(), SalvagePacket(), Send(), SendAck(), SendErrorRequest(), SendGratuitousReply(), SendInitialRequest(), SendPacketFromBuffer(), and SendUnreachError().

Ipv4Address ns3::dsr::DsrRouting::GetIPfromID ( uint16_t id )

Get the ip address from id.

Returns: the ip address for the id

Definition at line 816 of file dsr-routing.cc.

References ns3::NodeList::GetNode(), ns3::Object::GetObject(), and NS_LOG_DEBUG.

Referenced by NotifyDataReceipt(), PromiscReceive(), and Receive().

Ipv4Address ns3::dsr::DsrRouting::GetIPfromMAC ( Mac48Address address )

Get the Ip address from mac address.

Returns: the ip address

Definition at line 711 of file dsr-routing.cc.

References ns3::NodeList::GetNNodes(), ns3::NodeList::GetNode(), ns3::Object::GetObject(), and NS_LOG_FUNCTION.

Referenced by NotifyDataReceipt(), and PromiscReceive().

Ptr< NetDevice > ns3::dsr::DsrRouting::GetNetDeviceFromContext ( std::string context )

Get the netdevice from the context.

Returns: the netdevice we are looking for

Definition at line 544 of file dsr-routing.cc.

References ns3::Node::GetDevice(), GetElementsFromContext(), ns3::NodeList::GetNode(), and NS_ASSERT.

Referenced by NotifyDataReceipt().

Ptr< Node > ns3::dsr::DsrRouting::GetNode ( void ) const

Get the node.

Returns: the node

Definition at line 602 of file dsr-routing.cc.

References m_node, and NS_LOG_FUNCTION_NOARGS.

Referenced by Receive().

Ptr< Node > ns3::dsr::DsrRouting::GetNodeWithAddress ( Ipv4Address ipv4Address )

Get the node with give ip address.

Returns: the node associated with the ip address

Definition at line 648 of file dsr-routing.cc.

References ns3::NodeList::GetNNodes(), ns3::NodeList::GetNode(), ns3::Object::GetObject(), and NS_LOG_FUNCTION.

Referenced by NotifyDataReceipt().

Ptr< dsr::DsrOptions > ns3::dsr::DsrRouting::GetOption ( int optionNumber )

Get the option corresponding to optionNumber.

Parameters

optionNumber the option number of the option to retrieve

Returns: a matching Dsr option

Definition at line 3649 of file dsr-routing.cc.

References m_options.

Referenced by PromiscReceive(), and Receive().

Ptr< dsr::PassiveBuffer > ns3::dsr::DsrRouting::GetPassiveBuffer ( ) const

Get the passive buffer.

Returns: the passive buffer

Definition at line 641 of file dsr-routing.cc.

References m_passiveBuffer.

Referenced by GetTypeId().

uint32_t ns3::dsr::DsrRouting::GetPriority ( DsrMessageType messageType )

Set the priority of the packet in network queue.

Returns: the priority value

Definition at line 832 of file dsr-routing.cc.

Referenced by CheckSendBuffer(), ForwardErrPacket(), IncreaseRetransTimer(), SalvagePacket(), SendAck(), SendPacket(), SendPacketFromBuffer(), SendReply(), SendRequest(), and SendUnreachError().

int ns3::dsr::DsrRouting::GetProtocolNumber ( void ) const

virtual

Get the dsr protocol number.

Returns: protocol number

Implements ns3::IpL4Protocol.

Definition at line 793 of file dsr-routing.cc.

References PROT_NUMBER.

Referenced by CheckSendBuffer(), ForwardErrPacket(), SalvagePacket(), SendAck(), SendPacket(), SendPacketFromBuffer(), SendRealDown(), SendReply(), SendRequest(), and SendUnreachError().

Ptr< dsr::RreqTable > ns3::dsr::DsrRouting::GetRequestTable ( ) const

Get the request table.

Returns: the request table

Definition at line 628 of file dsr-routing.cc.

References m_rreqTable.

Referenced by GetTypeId().

Ptr< dsr::RouteCache > ns3::dsr::DsrRouting::GetRouteCache ( ) const

Get the route cache.

Returns: the route cache

Definition at line 615 of file dsr-routing.cc.

References m_routeCache.

Referenced by GetTypeId().

TypeId ns3::dsr::DsrRouting::GetTypeId ( void )

static

Get the type identificator.

Returns: type identificator

Definition at line 105 of file dsr-routing.cc.

References GetPassiveBuffer(), GetRequestTable(), GetRouteCache(), m_blacklistTimeout, m_broadcastJitter, m_cacheType, m_discoveryHopLimit, m_dropTrace, m_graReplyTableSize, m_gratReplyHoldoff, m_initStability, m_linkAck, m_linkAckTimeout, m_maxCacheLen, m_maxCacheTime, m_maxEntriesEachDst, m_maxMaintainLen, m_maxMaintainTime, m_maxMaintRexmt, m_maxNetworkDelay, m_maxNetworkSize, m_maxRequestPeriod, m_maxRreqId, m_maxSalvageCount, m_maxSendBuffLen, m_minLifeTime, m_nodeTraversalTime, m_nonpropRequestTimeout, m_numPriorityQueues, m_passiveAckTimeout, m_requestPeriod, m_requestTableIds, m_requestTableSize, m_retransIncr, m_rreqRetries, m_sendBufferTimeout, m_sendBuffInterval, m_stabilityDecrFactor, m_stabilityIncrFactor, m_subRoute, m_tryLinkAcks, m_tryPassiveAcks, m_useExtends, ns3::MakeTraceSourceAccessor(), ns3::MilliSeconds(), ns3::Seconds(), ns3::TypeId::SetParent(), SetPassiveBuffer(), SetRequestTable(), and SetRouteCache().

void ns3::dsr::DsrRouting::Insert ( Ptr< dsr::DsrOptions > option )

Insert a new Dsr Option.

Parameters

option the option to insert

Definition at line 3644 of file dsr-routing.cc.

References m_options.

Referenced by DsrRouting().

void ns3::dsr::DsrRouting::NotifyDataReceipt	(	std::string	context,
		Ptr< const Packet >	p
	)

private

Notify the data receipt.

Returns: void

TODO this is a hard-coded check, need to find a better way to work on this

Remove the ipv4 header here

Remove the dsr routing header here

This is the ip address we just received data packet from

Remember this is the entry for previous node

Get the previous node's maintenance buffer and passive ack

Definition at line 461 of file dsr-routing.cc.

References ns3::Packet::Copy(), ns3::dsr::DsrFsHeader::GetDestId(), GetIPfromID(), GetIPfromMAC(), ns3::dsr::DsrFsHeader::GetMessageType(), GetNetDeviceFromContext(), GetNodeWithAddress(), ns3::Object::GetObject(), ns3::Packet::GetSize(), ns3::dsr::DsrFsHeader::GetSourceId(), ns3::Packet::GetUid(), m_mainAddress, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_WARN, ns3::Packet::PeekHeader(), and ns3::Packet::RemoveHeader().

Referenced by ConnectCallbacks().

void ns3::dsr::DsrRouting::NotifyNewAggregate ( void )

protectedvirtual

This method is invoked whenever two sets of objects are aggregated together. It is invoked exactly once for each object in both sets. This method can be overriden by subclasses who wish to be notified of aggregation events. These subclasses must chain up to their base class NotifyNewAggregate method. It is safe to call GetObject and AggregateObject from within this method.

This function must be implemented in the stack that needs to notify other stacks connected to the node of their presence in the node.

Reimplemented from ns3::Object.

Definition at line 330 of file dsr-routing.cc.

References ns3::Object::GetObject(), m_ip, m_ipv4, m_node, ns3::MakeCallback(), ns3::Object::NotifyNewAggregate(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Simulator::ScheduleNow(), ns3::Ipv4L3Protocol::Send(), SetDownTarget(), and SetNode().

void ns3::dsr::DsrRouting::PacketNewRoute	(	Ptr< Packet >	packet,
		Ipv4Address	source,
		Ipv4Address	destination,
		uint8_t	protocol
	)

When route vector corrupted, originate a new packet, normally not happening.

When found a route and use it, UseExtends to the link cache

Definition at line 1272 of file dsr-routing.cc.

References ns3::dsr::DsrOptionField::AddDsrOption(), ns3::Packet::AddHeader(), ns3::Packet::Copy(), GetIDfromIP(), ns3::dsr::DsrOptionHeader::GetLength(), ns3::Packet::GetUid(), m_addressForwardCnt, m_addressReqTimer, m_linkAck, m_linkCnt, m_mainAddress, m_maintainBuffer, m_maxMaintainTime, m_nonPropReqTimer, m_passiveCnt, m_routeCache, m_sendBuffer, m_sendBufferTimeout, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, ScheduleLinkPacketRetry(), ScheduleNetworkPacketRetry(), SchedulePassivePacketRetry(), SearchNextHop(), SendInitialRequest(), ns3::dsr::DsrFsHeader::SetDestId(), ns3::dsr::DsrFsHeader::SetMessageType(), ns3::dsr::DsrFsHeader::SetNextHeader(), ns3::dsr::DsrOptionSRHeader::SetNodesAddress(), ns3::dsr::DsrFsHeader::SetPayloadLength(), SetRoute(), and ns3::dsr::DsrFsHeader::SetSourceId().

Referenced by CheckSendBuffer(), RouteRequestTimerExpire(), SalvagePacket(), Send(), SendErrorRequest(), SendRerrWhenBreaksLinkToNextHop(), and SendUnreachError().

bool ns3::dsr::DsrRouting::PassiveEntryCheck	(	Ptr< Packet >	packet,
		Ipv4Address	source,
		Ipv4Address	destination,
		uint8_t	segsLeft,
		uint16_t	fragmentOffset,
		uint16_t	identification,
		bool	saveEntry
	)

Find the same passive entry.

Save this passive buffer entry for later check

Definition at line 2070 of file dsr-routing.cc.

References CancelPassivePacketTimer(), ns3::Packet::Copy(), m_passiveBuffer, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

uint8_t ns3::dsr::DsrRouting::Process	(	Ptr< Packet > &	packet,
		Ipv4Header const &	ipv4Header,
		Ipv4Address	dst,
		uint8_t *	nextHeader,
		uint8_t	protocol,
		bool &	isDropped
	)

Process method Called from Ipv4L3Protocol::Receive.

Parameters

packet	the packet
offset	the offset of the extension to process
dst	destination address of the packet received (i.e. us)
nextHeader	the next header
isDropped	if the packet must be dropped

Returns: the size processed

bool ns3::dsr::DsrRouting::PromiscReceive	(	Ptr< NetDevice >	device,
		Ptr< const Packet >	packet,
		uint16_t	protocol,
		const Address &	from,
		const Address &	to,
		NetDevice::PacketType	packetType
	)

private

Promiscuous receive data packets destined to some other node.

Parameters

device	The network device
packet	Data packet we just received
protocol	The protocol we receive, need to verify it is dsr protocol
from	The from address we received the packet
to	The address this packet is destined for
packetType	The dsr packet type, 0 is for control packet, 1 for data packet

Definition at line 1211 of file dsr-routing.cc.

References ns3::Mac48Address::ConvertFrom(), ns3::Packet::Copy(), ns3::Packet::CopyData(), ns3::Ipv4Header::GetDestination(), ns3::dsr::DsrOptionField::GetDsrOptionsOffset(), GetIPfromID(), GetIPfromMAC(), ns3::dsr::DsrFsHeader::GetNextHeader(), GetOption(), ns3::Ipv4Header::GetProtocol(), ns3::Packet::GetSize(), ns3::Ipv4Header::GetSource(), ns3::dsr::DsrFsHeader::GetSourceId(), ns3::Packet::GetUid(), m_mainAddress, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_INFO, ns3::NetDevice::PACKET_OTHERHOST, PROT_NUMBER, ns3::Packet::RemoveAtStart(), and ns3::Packet::RemoveHeader().

enum IpL4Protocol::RxStatus ns3::dsr::DsrRouting::Receive	(	Ptr< Packet >	p,
		Ipv4Header const &	header,
		Ptr< Ipv4Interface >	incomingInterface
	)

virtual

Parameters

p	packet to forward up
header	IPv4 Header information
incomingInterface	the Ipv4Interface on which the packet arrived

Called from lower-level layers to send the packet up in the stack.

this is just here for the sake of passing in the promisc source

Implements ns3::IpL4Protocol.

Definition at line 3423 of file dsr-routing.cc.

References ns3::Packet::Copy(), ns3::Packet::CopyData(), ns3::Ipv4Header::GetDestination(), ns3::dsr::DsrOptionField::GetDsrOptionsOffset(), GetIPfromID(), ns3::dsr::DsrFsHeader::GetNextHeader(), GetNode(), ns3::Object::GetObject(), GetOption(), ns3::Packet::GetSize(), ns3::Ipv4Header::GetSource(), ns3::dsr::DsrFsHeader::GetSourceId(), ns3::Packet::GetUid(), ns3::Ipv4Address::IsBroadcast(), ns3::Ipv4Address::IsMulticast(), m_dropTrace, m_mainAddress, m_node, m_rreqTable, NS_FATAL_ERROR, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, ns3::Packet::RemoveAtStart(), ns3::Packet::RemoveHeader(), ns3::dsr::DsrOptionRerrUnsupportHeader::SetErrorDst(), ns3::dsr::DsrOptionRerrUnsupportHeader::SetErrorSrc(), ns3::dsr::DsrOptionRerrHeader::SetErrorType(), ns3::dsr::DsrOptionRerrUnsupportHeader::SetSalvage(), and ns3::dsr::DsrOptionRerrUnsupportHeader::SetUnsupported().

enum IpL4Protocol::RxStatus ns3::dsr::DsrRouting::Receive	(	Ptr< Packet >	p,
		Ipv6Header const &	header,
		Ptr< Ipv6Interface >	incomingInterface
	)

virtual

Parameters

p	packet to forward up
header	IPv6 Header information
incomingInterface	the Ipv6Interface on which the packet arrived

Called from lower-level layers to send the packet up in the stack. Not implemented (IPv6).

Implements ns3::IpL4Protocol.

Definition at line 3610 of file dsr-routing.cc.

References ns3::Ipv6Header::GetDestinationAddress(), ns3::Ipv6Header::GetSourceAddress(), and NS_LOG_FUNCTION.

void ns3::dsr::DsrRouting::RouteRequestTimerExpire	(	Ptr< Packet >	packet,
		std::vector< Ipv4Address >	address,
		uint32_t	requestId,
		uint8_t	protocol
	)

Set the salvage value to 0

Try to send out data packet from the send buffer if found

Definition at line 3137 of file dsr-routing.cc.

References ns3::Packet::AddPacketTag(), CancelRreqTimer(), ns3::Packet::Copy(), m_discoveryHopLimit, m_mainAddress, m_routeCache, m_rreqRetries, m_rreqTable, m_sendBuffer, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, PacketNewRoute(), ns3::Packet::RemoveHeader(), ScheduleRreqRetry(), SearchNextHop(), SendPacketFromBuffer(), SendRequest(), ns3::dsr::DsrOptionSRHeader::SetNodesAddress(), and SetRoute().

Referenced by ScheduleRreqRetry().

void ns3::dsr::DsrRouting::SalvagePacket	(	Ptr< const Packet >	packet,
		Ipv4Address	source,
		Ipv4Address	dst,
		uint8_t	protocol
	)

Salvage the packet which has been transmitted for 3 times.

When found a route and use it, UseExtends to the link cache

Definition at line 2321 of file dsr-routing.cc.

References ns3::dsr::DsrOptionField::AddDsrOption(), ns3::Packet::AddHeader(), ns3::Packet::Copy(), ns3::Packet::CopyData(), ns3::dsr::DsrOptionField::GetDsrOptionsOffset(), GetIDfromIP(), ns3::dsr::DsrOptionHeader::GetLength(), GetPriority(), GetProtocolNumber(), m_downTarget, m_ip, m_ipv4Route, m_mainAddress, m_maxSalvageCount, m_priorityQueue, m_routeCache, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_INFO, PacketNewRoute(), ns3::Packet::RemoveAtStart(), ns3::Packet::RemoveHeader(), SearchNextHop(), ns3::dsr::DsrFsHeader::SetDestId(), ns3::dsr::DsrFsHeader::SetMessageType(), ns3::dsr::DsrFsHeader::SetNextHeader(), ns3::dsr::DsrOptionSRHeader::SetNodesAddress(), ns3::dsr::DsrOptionSRHeader::SetNumberAddress(), ns3::Ipv4Route::SetOutputDevice(), ns3::dsr::DsrFsHeader::SetPayloadLength(), SetRoute(), and ns3::dsr::DsrFsHeader::SetSourceId().

Referenced by CancelPacketTimerNextHop().

void ns3::dsr::DsrRouting::ScheduleCachedReply	(	Ptr< Packet >	packet,
		Ipv4Address	source,
		Ipv4Address	destination,
		Ptr< Ipv4Route >	route,
		double	hops
	)

Schedule the cached reply to a random start time to avoid possible route reply storm

Definition at line 3357 of file dsr-routing.cc.

References ns3::UniformRandomVariable::GetValue(), m_nodeTraversalTime, m_uniformRandomVariable, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and SendReply().

void ns3::dsr::DsrRouting::ScheduleInitialReply	(	Ptr< Packet >	packet,
		Ipv4Address	source,
		Ipv4Address	nextHop,
		Ptr< Ipv4Route >	route
	)

this is a generating the initial route reply from the destination address, a random delay time [0, m_broadcastJitter] is used before unicasting back the route reply packet

Definition at line 3346 of file dsr-routing.cc.

References NS_LOG_FUNCTION, ns3::Simulator::ScheduleNow(), and SendReply().

void ns3::dsr::DsrRouting::ScheduleInterRequest ( Ptr< Packet > packet )

Schedule the intermediate route request.

Parameters

the	original packet
source	The source address
destination	The destination address

Definition at line 3240 of file dsr-routing.cc.

References ns3::UniformRandomVariable::GetInteger(), m_broadcastJitter, m_mainAddress, m_uniformRandomVariable, ns3::MilliSeconds(), NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and SendRequest().

void ns3::dsr::DsrRouting::ScheduleLinkPacketRetry	(	MaintainBuffEntry &	mb,
		uint8_t	protocol
	)

Schedule the packet retransmission based on link-layer acknowledgment.

Parameters

mb	maintainenace buffer entry
protocol	the protocol number

Definition at line 2418 of file dsr-routing.cc.

References ns3::Timer::CANCEL_ON_DESTROY, ns3::Packet::Copy(), LinkScheduleTimerExpire(), m_linkAckTimeout, m_linkAckTimer, NS_LOG_FUNCTION, and SendPacket().

Referenced by CheckSendBuffer(), ForwardPacket(), LinkScheduleTimerExpire(), PacketNewRoute(), Send(), SendPacketFromBuffer(), and SendRerrWhenBreaksLinkToNextHop().

void ns3::dsr::DsrRouting::ScheduleNetworkPacketRetry	(	MaintainBuffEntry &	mb,
		bool	isFirst,
		uint8_t	protocol
	)

Schedule the packet retransmission based on network layer acknowledgment.

Parameters

mb	maintainenace buffer entry
isFirst	see if this is the first packet retry or not
protocol	the protocol number

Definition at line 2479 of file dsr-routing.cc.

References AddAckReqHeader(), ns3::Timer::CANCEL_ON_DESTROY, ns3::Packet::Copy(), ns3::Time::GetSeconds(), m_addressForwardCnt, m_addressForwardTimer, m_maintainBuffer, m_maxMaintainTime, m_nodeTraversalTime, m_sendRetries, NetworkScheduleTimerExpire(), NS_LOG_DEBUG, and SendPacket().

Referenced by CheckSendBuffer(), ForwardPacket(), NetworkScheduleTimerExpire(), PacketNewRoute(), PassiveScheduleTimerExpire(), Send(), SendPacketFromBuffer(), and SendRerrWhenBreaksLinkToNextHop().

void ns3::dsr::DsrRouting::SchedulePassivePacketRetry	(	MaintainBuffEntry &	mb,
		uint8_t	protocol
	)

Schedule the packet retransmission based on passive acknowledgment.

Parameters

mb	maintainenace buffer entry
protocol	the protocol number

Definition at line 2448 of file dsr-routing.cc.

References ns3::Timer::CANCEL_ON_DESTROY, ns3::Packet::Copy(), m_passiveAckTimeout, m_passiveAckTimer, NS_LOG_DEBUG, NS_LOG_FUNCTION, PassiveScheduleTimerExpire(), and SendPacket().

Referenced by CheckSendBuffer(), ForwardPacket(), PacketNewRoute(), PassiveScheduleTimerExpire(), Send(), SendPacketFromBuffer(), and SendRerrWhenBreaksLinkToNextHop().

void ns3::dsr::DsrRouting::ScheduleRreqRetry	(	Ptr< Packet >	packet,
		std::vector< Ipv4Address >	address,
		bool	nonProp,
		uint32_t	requestId,
		uint8_t	protocol
	)

Schedule the route request retry.

Parameters

dst	The dst address of the route request

Definition at line 3065 of file dsr-routing.cc.

References ns3::Timer::CANCEL_ON_DESTROY, ns3::Time::GetSeconds(), m_addressReqTimer, m_maxRequestPeriod, m_nonPropReqTimer, m_nonpropRequestTimeout, m_requestPeriod, m_rreqTable, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_LOGIC, and RouteRequestTimerExpire().

Referenced by RouteRequestTimerExpire(), SendErrorRequest(), and SendInitialRequest().

Ipv4Address ns3::dsr::DsrRouting::SearchNextHop	(	Ipv4Address	ipv4Address,
		std::vector< Ipv4Address > &	vec
	)

Get the next hop of the route.

Returns: the next hop address of the route

Definition at line 749 of file dsr-routing.cc.

References NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by CheckSendBuffer(), PacketNewRoute(), RouteRequestTimerExpire(), SalvagePacket(), Send(), SendErrorRequest(), SendRerrWhenBreaksLinkToNextHop(), and SendUnreachError().

void ns3::dsr::DsrRouting::Send	(	Ptr< Packet >	packet,
		Ipv4Address	source,
		Ipv4Address	destination,
		uint8_t	protocol,
		Ptr< Ipv4Route >	route
	)

This function is called by higher layer protocol when sending packets.

When found a route and use it, UseExtends to the link cache

Definition at line 1537 of file dsr-routing.cc.

References ns3::dsr::DsrOptionField::AddDsrOption(), ns3::Packet::AddHeader(), ns3::Packet::Copy(), GetIDfromIP(), ns3::UniformRandomVariable::GetInteger(), ns3::dsr::DsrOptionHeader::GetLength(), ns3::Packet::GetSize(), ns3::Packet::GetUid(), m_addressForwardCnt, m_addressReqTimer, m_downTarget, m_linkAck, m_linkCnt, m_mainAddress, m_maintainBuffer, m_maxMaintainTime, m_nonPropReqTimer, m_passiveCnt, m_routeCache, m_rreqTable, m_sendBuffer, m_sendBufferTimeout, m_uniformRandomVariable, ns3::MilliSeconds(), ns3::Simulator::Now(), NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, PacketNewRoute(), ns3::Simulator::Schedule(), ScheduleLinkPacketRetry(), ScheduleNetworkPacketRetry(), SchedulePassivePacketRetry(), SearchNextHop(), SendInitialRequest(), SendPacketFromBuffer(), ns3::dsr::DsrFsHeader::SetDestId(), ns3::dsr::DsrFsHeader::SetMessageType(), ns3::dsr::DsrFsHeader::SetNextHeader(), ns3::dsr::DsrOptionSRHeader::SetNodesAddress(), ns3::dsr::DsrFsHeader::SetPayloadLength(), and ns3::dsr::DsrFsHeader::SetSourceId().

Referenced by ns3::DsrHelper::Create().

void ns3::dsr::DsrRouting::SendAck	(	uint16_t	ackId,
		Ipv4Address	destination,
		Ipv4Address	realSrc,
		Ipv4Address	realDst,
		uint8_t	protocol,
		Ptr< Ipv4Route >	route
	)

Send network layer acknowledgment back to the earlier hop to notify the receipt of data packet

Definition at line 3368 of file dsr-routing.cc.

References ns3::Packet::AddHeader(), GetIDfromIP(), ns3::dsr::DsrOptionHeader::GetLength(), GetPriority(), GetProtocolNumber(), m_downTarget, m_ip, m_mainAddress, m_priorityQueue, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::dsr::DsrOptionAckHeader::SetAckId(), ns3::dsr::DsrFsHeader::SetNextHeader(), ns3::Ipv4Route::SetOutputDevice(), ns3::dsr::DsrOptionAckHeader::SetRealDst(), and ns3::dsr::DsrOptionAckHeader::SetRealSrc().

void ns3::dsr::DsrRouting::SendErrorRequest	(	DsrOptionRerrUnreachHeader &	rerr,
		uint8_t	protocol
	)

Send the error request packet.

Parameters

the	route error header
the	protocol number

When found a route and use it, UseExtends to the link cache

Try to send out the packet from the buffer once we found one route

Definition at line 2911 of file dsr-routing.cc.

void ns3::dsr::DsrRouting::SendGratuitousReply	(	Ipv4Address	replyTo,
		Ipv4Address	replyFrom,
		std::vector< Ipv4Address > &	nodeList,
		uint8_t	protocol
	)

Send the gratuitous reply.

Parameters

replyTo	The destination address to send the reply to
replyFrom	The source address sending the reply

Push back the node addresses other than those between srcAddress and our own ip address

Definition at line 3252 of file dsr-routing.cc.

References ns3::dsr::DsrOptionField::AddDsrOption(), ns3::Packet::AddHeader(), GetIDfromIP(), ns3::dsr::DsrOptionHeader::GetLength(), m_finalRoute, m_graReply, m_gratReplyHoldoff, m_ipv4Route, m_mainAddress, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, SendReply(), ns3::dsr::DsrFsHeader::SetDestId(), ns3::dsr::DsrFsHeader::SetMessageType(), ns3::dsr::DsrFsHeader::SetNextHeader(), ns3::dsr::DsrOptionRrepHeader::SetNodesAddress(), ns3::dsr::DsrFsHeader::SetPayloadLength(), SetRoute(), and ns3::dsr::DsrFsHeader::SetSourceId().

void ns3::dsr::DsrRouting::SendPacketFromBuffer	(	DsrOptionSRHeader const &	sourceRoute,
		Ipv4Address	nextHop,
		uint8_t	protocol
	)

This function is responsible for sending out data packets when have route, if no route found, it will cache the packet and send out route requests.

When found a route and use it, UseExtends to the link cache

Definition at line 1865 of file dsr-routing.cc.

Referenced by RouteRequestTimerExpire(), Send(), and SendErrorRequest().

void ns3::dsr::DsrRouting::SendReply	(	Ptr< Packet >	packet,
		Ipv4Address	source,
		Ipv4Address	nextHop,
		Ptr< Ipv4Route >	route
	)

Send the route reply back to the request originator with the cumulated route

Definition at line 3314 of file dsr-routing.cc.

References GetPriority(), GetProtocolNumber(), m_downTarget, m_ipv4, m_mainAddress, m_priorityQueue, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_INFO, and ns3::Ipv4Route::SetOutputDevice().

Referenced by ScheduleCachedReply(), ScheduleInitialReply(), and SendGratuitousReply().

void ns3::dsr::DsrRouting::SendRequest	(	Ptr< Packet >	packet,
		Ipv4Address	source
	)

Forward the route request if the node is not the destination.

Parameters

the	original packet
source	address

Definition at line 3211 of file dsr-routing.cc.

References GetPriority(), GetProtocolNumber(), m_broadcast, m_downTarget, m_priorityQueue, NS_ASSERT_MSG, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by RouteRequestTimerExpire(), ScheduleInterRequest(), SendErrorRequest(), and SendInitialRequest().

void ns3::dsr::DsrRouting::SendRequestAndIncrement	(	Ptr< Packet >	packet,
		Ipv4Address	source,
		Ipv4Address	destination
	)

Send the route request and increment the request count.

Parameters

the	original packet
source	address
destination	address

void ns3::dsr::DsrRouting::SendRerrWhenBreaksLinkToNextHop	(	Ipv4Address	nextHop,
		uint8_t	protocol
	)

private

Send the route error message when the link breaks to the next hop.

When found a route and use it, UseExtends to the link cache

Definition at line 844 of file dsr-routing.cc.

References ns3::Packet::Copy(), ns3::dsr::DsrOptionField::GetDsrOptionsOffset(), ns3::UniformRandomVariable::GetInteger(), ns3::dsr::DsrOptionSRHeader::GetNodesAddress(), m_addressForwardCnt, m_linkAck, m_linkCnt, m_mainAddress, m_maintainBuffer, m_maxSalvageCount, m_passiveCnt, m_routeCache, m_uniformRandomVariable, ns3::MilliSeconds(), NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_LOGIC, PacketNewRoute(), ns3::Packet::RemoveHeader(), ns3::Simulator::Schedule(), ScheduleLinkPacketRetry(), ScheduleNetworkPacketRetry(), SchedulePassivePacketRetry(), SearchNextHop(), SendUnreachError(), ns3::dsr::DsrOptionSRHeader::SetNodesAddress(), and ns3::dsr::DsrOptionSRHeader::SetNumberAddress().

void ns3::dsr::DsrRouting::SendUnreachError	(	Ipv4Address	errorHop,
		Ipv4Address	destination,
		Ipv4Address	originalDst,
		uint8_t	salvage,
		uint8_t	protocol
	)

This function is responsible for sending error packets in case of break link to next hop.

When found a route and use it, UseExtends to the link cache

Definition at line 1391 of file dsr-routing.cc.

Referenced by LinkScheduleTimerExpire(), NetworkScheduleTimerExpire(), and SendRerrWhenBreaksLinkToNextHop().

void ns3::dsr::DsrRouting::SetDownTarget ( IpL4Protocol::DownTargetCallback cb )

virtual

This method allows a caller to set the current down target callback set for this L4 protocol

Parameters

cb	current Callback for the L4 protocol

Implements ns3::IpL4Protocol.

Definition at line 3619 of file dsr-routing.cc.

References m_downTarget.

Referenced by ns3::DsrHelper::Create(), and NotifyNewAggregate().

void ns3::dsr::DsrRouting::SetNode ( Ptr< Node > node )

Set the node.

Parameters

node	the node to set

Definition at line 596 of file dsr-routing.cc.

References m_node.

Referenced by NotifyNewAggregate().

void ns3::dsr::DsrRouting::SetPassiveBuffer ( Ptr< dsr::PassiveBuffer > r )

Set the node.

Parameters

the	passive buffer to set

Definition at line 634 of file dsr-routing.cc.

References m_passiveBuffer.

Referenced by GetTypeId().

void ns3::dsr::DsrRouting::SetRequestTable ( Ptr< dsr::RreqTable > r )

Set the node.

Parameters

the	request table to set

Definition at line 621 of file dsr-routing.cc.

References m_rreqTable.

Referenced by GetTypeId().

Ptr< Ipv4Route > ns3::dsr::DsrRouting::SetRoute	(	Ipv4Address	nextHop,
		Ipv4Address	srcAddress
	)

Set the route to use for data packets.

Returns: the route by the option headers when sending data/control packets

Definition at line 782 of file dsr-routing.cc.

References m_ipv4Route, NS_LOG_FUNCTION, ns3::Ipv4Route::SetDestination(), ns3::Ipv4Route::SetGateway(), and ns3::Ipv4Route::SetSource().

Referenced by CheckSendBuffer(), LinkScheduleTimerExpire(), PacketNewRoute(), PassiveScheduleTimerExpire(), RouteRequestTimerExpire(), SalvagePacket(), SendErrorRequest(), SendGratuitousReply(), SendPacket(), SendPacketFromBuffer(), and SendUnreachError().

void ns3::dsr::DsrRouting::SetRouteCache ( Ptr< dsr::RouteCache > r )

Set the route cache.

Parameters

the	route cache to set

Definition at line 608 of file dsr-routing.cc.

References m_routeCache.

Referenced by GetTypeId().

Member Data Documentation

TracedCallback<Ptr<const Packet> > ns3::dsr::DsrRouting::m_dropTrace

protected

The trace for drop, receive and send data packets

Definition at line 542 of file dsr-routing.h.

Referenced by GetTypeId(), and Receive().

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

src/dsr/model/dsr-routing.h
src/dsr/model/dsr-routing.cc

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

of retries have been sent for link acknowledgment

of retries have been sent for passive acknowledgment

of retries have been sent for network acknowledgment

Additional Inherited Members

Detailed Description

Attributes

Attributes defined in parent class ns3::IpL4Protocol

TraceSources

Member Function Documentation

Member Data Documentation