An ARP cache. More...

#include <arp-cache.h>

Inheritance diagram for ns3::ArpCache:

Collaboration diagram for ns3::ArpCache:

Classes
class	Entry
	A record that that holds information about an ArpCache entry. More...

Public Member Functions
	ArpCache ()

	~ArpCache ()

ArpCache::Entry *	Add (Ipv4Address to)
	Add an Ipv4Address to this ARP cache. More...

void	Flush (void)
	Clear the ArpCache of all entries. More...

Time	GetAliveTimeout (void) const
	Get the time the entry will be in ALIVE state (unless refreshed) More...

Time	GetDeadTimeout (void) const
	Get the time the entry will be in DEAD state before being removed. More...

Ptr< NetDevice >	GetDevice (void) const
	Returns the NetDevice that this ARP cache is associated with. More...

Ptr< Ipv4Interface >	GetInterface (void) const
	Returns the Ipv4Interface that this ARP cache is associated with. More...

Time	GetWaitReplyTimeout (void) const
	Get the time the entry will be in WAIT_REPLY state. More...

ArpCache::Entry *	Lookup (Ipv4Address destination)
	Do lookup in the ARP cache against an IP address. More...

void	SetAliveTimeout (Time aliveTimeout)
	Set the time the entry will be in ALIVE state (unless refreshed) More...

void	SetArpRequestCallback (Callback< void, Ptr< const ArpCache >, Ipv4Address > arpRequestCallback)
	This callback is set when the ArpCache is set up and allows the cache to generate an Arp request when the WaitReply time expires and a retransmission must be sent. More...

void	SetDeadTimeout (Time deadTimeout)
	Set the time the entry will be in DEAD state before being removed. More...

void	SetDevice (Ptr< NetDevice > device, Ptr< Ipv4Interface > interface)
	Set the NetDevice and Ipv4Interface associated with the ArpCache. More...

void	SetWaitReplyTimeout (Time waitReplyTimeout)
	Set the time the entry will be in WAIT_REPLY state. More...

void	StartWaitReplyTimer (void)
	This method will schedule a timeout at WaitReplyTimeout interval in the future, unless a timer is already running for the cache, in which case this method does nothing. More...

Public Member Functions inherited from ns3::Object
	Object ()

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

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)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

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 (void)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

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

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Private Types
typedef sgi::hash_map < Ipv4Address, ArpCache::Entry *, Ipv4AddressHash >	Cache
	ARP Cache container. More...

typedef sgi::hash_map < Ipv4Address, ArpCache::Entry *, Ipv4AddressHash >::iterator	CacheI
	ARP Cache container iterator. More...

Private Member Functions
	ArpCache (ArpCache const &)
	Copy constructor. More...

virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

void	HandleWaitReplyTimeout (void)
	This function is an event handler for the event that the ArpCache wants to check whether it must retry any Arp requests. More...

ArpCache &	operator= (ArpCache const &)
	Copy constructor. More...

Private Attributes
Time	m_aliveTimeout
	cache alive state timeout More...

Cache	m_arpCache
	the ARP cache More...

Callback< void, Ptr< const ArpCache >, Ipv4Address >	m_arpRequestCallback
	reply timeout callback More...

Time	m_deadTimeout
	cache dead state timeout More...

Ptr< NetDevice >	m_device
	NetDevice associated with the cache. More...

TracedCallback< Ptr< const Packet > >	m_dropTrace
	trace for packets dropped by the ARP cache queue More...

Ptr< Ipv4Interface >	m_interface
	Ipv4Interface associated with the cache. More...

uint32_t	m_maxRetries
	max retries for a resolution More...

uint32_t	m_pendingQueueSize
	number of packets waiting for a resolution More...

Time	m_waitReplyTimeout
	cache reply state timeout More...

EventId	m_waitReplyTimer
	cache alive state timer More...

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

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

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

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Detailed Description

An ARP cache.

A cached lookup table for translating layer 3 addresses to layer 2. This implementation does lookups from IPv4 to a MAC address

Config Paths

ns3::ArpCache is accessible through the following paths with Config::Set and Config::Connect:

/NodeList/[i]/$ns3::ArpL3Protocol/CacheList/[i]
/NodeList/[i]/$ns3::Ipv4L3Protocol/InterfaceList/[i]/ArpCache

Attributes

AliveTimeout: When this timeout expires, the matching cache entry needs refreshing
- Set with class: ns3::TimeValue
- Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +120000000000.0ns
- Flags: construct write read
DeadTimeout: When this timeout expires, a new attempt to resolve the matching entry is made
- Set with class: ns3::TimeValue
- Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +100000000000.0ns
- Flags: construct write read
WaitReplyTimeout: When this timeout expires, the cache entries will be scanned and entries in WaitReply state will resend ArpRequest unless MaxRetries has been exceeded, in which case the entry is marked dead
- Set with class: ns3::TimeValue
- Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +1000000000.0ns
- Flags: construct write read
MaxRetries: Number of retransmissions of ArpRequest before marking dead
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 3
- Flags: construct write read
PendingQueueSize: The size of the queue for packets pending an arp reply.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 3
- Flags: construct write read

TraceSources

Drop: Packet dropped due to ArpCache entry in WaitReply expiring.

Definition at line 49 of file arp-cache.h.

Member Typedef Documentation

typedef sgi::hash_map<Ipv4Address, ArpCache::Entry *, Ipv4AddressHash> ns3::ArpCache::Cache

private

ARP Cache container.

Definition at line 270 of file arp-cache.h.

typedef sgi::hash_map<Ipv4Address, ArpCache::Entry *, Ipv4AddressHash>::iterator ns3::ArpCache::CacheI

private

ARP Cache container iterator.

Definition at line 274 of file arp-cache.h.

Constructor & Destructor Documentation

ns3::ArpCache::ArpCache ( ArpCache const & )

private

Copy constructor.

Defined and unimplemented to avoid misuse

ns3::ArpCache::ArpCache ( )

Definition at line 76 of file arp-cache.cc.

References NS_LOG_FUNCTION.

ns3::ArpCache::~ArpCache ( )

Definition at line 83 of file arp-cache.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

ArpCache::Entry * ns3::ArpCache::Add ( Ipv4Address to )

Add an Ipv4Address to this ARP cache.

Definition at line 259 of file arp-cache.cc.

References m_arpCache, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by ns3::EpcS1uUlTestCase::DoRun(), and ns3::ArpL3Protocol::Lookup().

Here is the caller graph for this function:

void ns3::ArpCache::DoDispose ( void )

privatevirtual

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 89 of file arp-cache.cc.

References ns3::Object::DoDispose(), Flush(), ns3::EventId::IsRunning(), m_device, m_interface, m_waitReplyTimer, NS_LOG_FUNCTION, and ns3::Simulator::Remove().

Here is the call graph for this function:

void ns3::ArpCache::Flush ( void )

Clear the ArpCache of all entries.

Definition at line 231 of file arp-cache.cc.

References ns3::EventId::Cancel(), ns3::EventId::IsRunning(), m_arpCache, m_waitReplyTimer, ns3::Simulator::Now(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by ns3::ArpL3Protocol::CreateCache(), and DoDispose().

Here is the call graph for this function:

Here is the caller graph for this function:

Time ns3::ArpCache::GetAliveTimeout ( void ) const

Get the time the entry will be in ALIVE state (unless refreshed)

Returns: the Alive state timeout

Definition at line 144 of file arp-cache.cc.

References m_aliveTimeout, and NS_LOG_FUNCTION.

Time ns3::ArpCache::GetDeadTimeout ( void ) const

Get the time the entry will be in DEAD state before being removed.

Returns: the Dead state timeout

Definition at line 150 of file arp-cache.cc.

References m_deadTimeout, and NS_LOG_FUNCTION.

Ptr< NetDevice > ns3::ArpCache::GetDevice ( void ) const

Returns the NetDevice that this ARP cache is associated with.

Returns: The NetDevice that this ARP cache is associated with

Definition at line 111 of file arp-cache.cc.

References m_device, and NS_LOG_FUNCTION.

Ptr< Ipv4Interface > ns3::ArpCache::GetInterface ( void ) const

Returns the Ipv4Interface that this ARP cache is associated with.

Returns: the Ipv4Interface that this ARP cache is associated with

Definition at line 118 of file arp-cache.cc.

References m_interface, and NS_LOG_FUNCTION.

TypeId ns3::ArpCache::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 40 of file arp-cache.cc.

References m_aliveTimeout, m_deadTimeout, m_dropTrace, m_maxRetries, m_pendingQueueSize, m_waitReplyTimeout, ns3::MakeTimeChecker(), ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

Time ns3::ArpCache::GetWaitReplyTimeout ( void ) const

Get the time the entry will be in WAIT_REPLY state.

Returns: the WAIT_REPLY state timeout

Definition at line 156 of file arp-cache.cc.

References m_waitReplyTimeout, and NS_LOG_FUNCTION.

void ns3::ArpCache::HandleWaitReplyTimeout ( void )

private

This function is an event handler for the event that the ArpCache wants to check whether it must retry any Arp requests.

If there are no Arp requests pending, this event is not scheduled.

Definition at line 184 of file arp-cache.cc.

References ns3::ArpCache::Entry::ClearRetries(), ns3::ArpCache::Entry::DequeuePending(), ns3::ArpCache::Entry::GetIpv4Address(), ns3::ArpCache::Entry::GetRetries(), ns3::ArpCache::Entry::IncrementRetries(), ns3::ArpCache::Entry::IsWaitReply(), m_arpCache, m_arpRequestCallback, m_device, m_dropTrace, m_maxRetries, m_waitReplyTimeout, m_waitReplyTimer, ns3::ArpCache::Entry::MarkDead(), ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::Simulator::Schedule().

Referenced by StartWaitReplyTimer().

Here is the call graph for this function:

Here is the caller graph for this function:

ArpCache::Entry * ns3::ArpCache::Lookup ( Ipv4Address destination )

Do lookup in the ARP cache against an IP address.

Parameters

destination The destination IPv4 address to lookup the MAC address of

Returns: An ArpCache::Entry with info about layer 2

Definition at line 247 of file arp-cache.cc.

References m_arpCache, and NS_LOG_FUNCTION.

Referenced by ns3::ArpL3Protocol::Lookup().

Here is the caller graph for this function:

ArpCache& ns3::ArpCache::operator= ( ArpCache const & )

private

Copy constructor.

Defined and unimplemented to avoid misuse

Returns

void ns3::ArpCache::SetAliveTimeout ( Time aliveTimeout )

Set the time the entry will be in ALIVE state (unless refreshed)

Parameters

aliveTimeout the Alive state timeout

Definition at line 125 of file arp-cache.cc.

References m_aliveTimeout, and NS_LOG_FUNCTION.

Referenced by ns3::EpcS1uUlTestCase::DoRun().

Here is the caller graph for this function:

void ns3::ArpCache::SetArpRequestCallback ( Callback< void, Ptr< const ArpCache >, Ipv4Address > arpRequestCallback )

This callback is set when the ArpCache is set up and allows the cache to generate an Arp request when the WaitReply time expires and a retransmission must be sent.

Parameters

arpRequestCallback Callback for transmitting an Arp request.

Definition at line 163 of file arp-cache.cc.

References m_arpRequestCallback, and NS_LOG_FUNCTION.

void ns3::ArpCache::SetDeadTimeout ( Time deadTimeout )

Set the time the entry will be in DEAD state before being removed.

Parameters

deadTimeout the Dead state timeout

Definition at line 131 of file arp-cache.cc.

References m_deadTimeout, and NS_LOG_FUNCTION.

void ns3::ArpCache::SetDevice	(	Ptr< NetDevice >	device,
		Ptr< Ipv4Interface >	interface
	)

Set the NetDevice and Ipv4Interface associated with the ArpCache.

Parameters

device	The hardware NetDevice associated with this ARP chache
interface	the Ipv4Interface associated with this ARP chache

Definition at line 103 of file arp-cache.cc.

References m_device, m_interface, and NS_LOG_FUNCTION.

Referenced by ns3::ArpL3Protocol::CreateCache().

Here is the caller graph for this function:

void ns3::ArpCache::SetWaitReplyTimeout ( Time waitReplyTimeout )

Set the time the entry will be in WAIT_REPLY state.

Parameters

waitReplyTimeout the WAIT_REPLY state timeout

Definition at line 137 of file arp-cache.cc.

References m_waitReplyTimeout, and NS_LOG_FUNCTION.

void ns3::ArpCache::StartWaitReplyTimer ( void )

This method will schedule a timeout at WaitReplyTimeout interval in the future, unless a timer is already running for the cache, in which case this method does nothing.

Definition at line 171 of file arp-cache.cc.

References HandleWaitReplyTimeout(), ns3::EventId::IsRunning(), m_waitReplyTimeout, m_waitReplyTimer, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::Simulator::Schedule().

Here is the call graph for this function: