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.
void	Flush (void)
	Clear the ArpCache of all entries.
Time	GetAliveTimeout (void) const
Time	GetDeadTimeout (void) const
Ptr< NetDevice >	GetDevice (void) const
Ptr< Ipv4Interface >	GetInterface (void) const
Time	GetWaitReplyTimeout (void) const
ArpCache::Entry *	Lookup (Ipv4Address destination)
	Do lookup in the ARP cache against an IP address.
void	SetAliveTimeout (Time aliveTimeout)
void	SetArpRequestCallback (Callback< void, Ptr< const ArpCache >, Ipv4Address > arpRequestCallback)
void	SetDeadTimeout (Time deadTimeout)
void	SetDevice (Ptr< NetDevice > device, Ptr< Ipv4Interface > interface)
void	SetWaitReplyTimeout (Time waitReplyTimeout)
void	StartWaitReplyTimer (void)
Public Member Functions inherited from ns3::Object
	Object ()
virtual	~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	Start (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	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
virtual	~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 (void)
	This method returns the TypeId associated to ns3::ArpCache.

Private Types
typedef sgi::hash_map < Ipv4Address, ArpCache::Entry *, Ipv4AddressHash >	Cache
typedef sgi::hash_map < Ipv4Address, ArpCache::Entry *, Ipv4AddressHash >::iterator	CacheI

Private Member Functions
	ArpCache (ArpCache const &)
virtual void	DoDispose (void)
void	HandleWaitReplyTimeout (void)
ArpCache &	operator= (ArpCache const &)

Private Attributes
Time	m_aliveTimeout
Cache	m_arpCache
Callback< void, Ptr< const ArpCache >, Ipv4Address >	m_arpRequestCallback
Time	m_deadTimeout
Ptr< NetDevice >	m_device
TracedCallback< Ptr< const Packet > >	m_dropTrace
Ptr< Ipv4Interface >	m_interface
uint32_t	m_maxRetries
uint32_t	m_pendingQueueSize
Time	m_waitReplyTimeout
EventId	m_waitReplyTimer

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
virtual void	DoDispose (void)
virtual void	DoStart (void)
virtual void	NotifyNewAggregate (void)

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

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

Member Typedef Documentation

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

private

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

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

private

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

Constructor & Destructor Documentation

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

private

ns3::ArpCache::ArpCache ( )

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

References NS_LOG_FUNCTION.

ns3::ArpCache::~ArpCache ( )

Definition at line 82 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 252 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

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

References 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 225 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

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

References m_aliveTimeout.

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

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

References m_deadTimeout.

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

Returns: The NetDevice that this ARP cache is associated with

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

References m_device.

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

Returns: the Ipv4Interface that this ARP cache is associated with

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

References m_interface.

TypeId ns3::ArpCache::GetTypeId ( void )

static

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

This object 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 defined for this type:

AliveTimeout: When this timeout expires, the matching cache entry needs refreshing
- Set with class: TimeValue
- Underlying type: Time
- 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: TimeValue
- Underlying type: Time
- 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: TimeValue
- Underlying type: Time
- 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 defined for this type:

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

Reimplemented from ns3::Object.

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

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

Here is the call graph for this function:

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

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

References m_waitReplyTimeout.

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

References ns3::ArpCache::Entry::ClearRetries(), ns3::ArpCache::Entry::DequeuePending(), ns3::Node::GetId(), ns3::ArpCache::Entry::GetIpv4Address(), ns3::NetDevice::GetNode(), 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 241 of file arp-cache.cc.

References m_arpCache.

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

Here is the caller graph for this function:

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

private

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

Definition at line 122 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 157 of file arp-cache.cc.

References m_arpRequestCallback, and NS_LOG_FUNCTION.

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

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

References m_deadTimeout, and NS_LOG_FUNCTION.

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

Parameters

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

Definition at line 102 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 )

Definition at line 134 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 165 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: