A Discrete-Event Network Simulator
API
ns3::ArpCache Class Reference

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 Types

typedef std::pair< Ptr< Packet >, Ipv4HeaderIpv4PayloadHeaderPair
 Pair of a packet and an Ipv4 header. More...
 

Public Member Functions

 ArpCache ()
 
 ~ArpCache ()
 
ArpCache::EntryAdd (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< NetDeviceGetDevice (void) const
 Returns the NetDevice that this ARP cache is associated with. More...
 
Ptr< Ipv4InterfaceGetInterface (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::EntryLookup (Ipv4Address destination)
 Do lookup in the ARP cache against an IP address. More...
 
std::list< ArpCache::Entry * > LookupInverse (Address destination)
 Do lookup in the ARP cache against a MAC address. More...
 
void PrintArpCache (Ptr< OutputStreamWrapper > stream)
 Print the ARP cache entries. More...
 
void Remove (ArpCache::Entry *entry)
 Remove an entry. 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 ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject () const
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. 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
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

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::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Types

typedef sgi::hash_map< Ipv4Address, ArpCache::Entry *, Ipv4AddressHashCache
 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)
 Destructor implementation. 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...
 
ArpCacheoperator= (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 >, Ipv4Addressm_arpRequestCallback
 reply timeout callback More...
 
Time m_deadTimeout
 cache dead state timeout More...
 
Ptr< NetDevicem_device
 NetDevice associated with the cache. More...
 
TracedCallback< Ptr< const Packet > > m_dropTrace
 trace for packets dropped by the ARP cache queue More...
 
Ptr< Ipv4Interfacem_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)
 Copy an Object. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. 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::Ipv4L3Protocol/InterfaceList/[i]/ArpCache"
  • "/NodeList/[i]/$ns3::ArpL3Protocol/CacheList/[i]"

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

Size of this type is 168 bytes (on a 64-bit architecture).

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

Member Typedef Documentation

◆ Cache

ARP Cache container.

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

◆ CacheI

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

ARP Cache container iterator.

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

◆ Ipv4PayloadHeaderPair

Pair of a packet and an Ipv4 header.

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

Constructor & Destructor Documentation

◆ ArpCache() [1/2]

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

Copy constructor.

Defined and unimplemented to avoid misuse

◆ ArpCache() [2/2]

ns3::ArpCache::ArpCache ( )

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

References NS_LOG_FUNCTION.

◆ ~ArpCache()

ns3::ArpCache::~ArpCache ( )

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Add()

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

Add an Ipv4Address to this ARP cache.

Parameters
tothe destination address of the ARP entry.
Returns
A pointer to a new ARP Entry.

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

References m_arpCache, NS_ASSERT, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

◆ DoDispose()

void ns3::ArpCache::DoDispose ( void  )
privatevirtual

Destructor implementation.

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

Subclasses are expected to implement their real destruction code in an overridden 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 100 of file arp-cache.cc.

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

+ Here is the call graph for this function:

◆ Flush()

void ns3::ArpCache::Flush ( void  )

Clear the ArpCache of all entries.

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

◆ GetAliveTimeout()

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

References m_aliveTimeout, and NS_LOG_FUNCTION.

◆ GetDeadTimeout()

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

References m_deadTimeout, and NS_LOG_FUNCTION.

◆ GetDevice()

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

References m_device, and NS_LOG_FUNCTION.

◆ GetInterface()

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

References m_interface, and NS_LOG_FUNCTION.

◆ GetTypeId()

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

◆ GetWaitReplyTimeout()

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

References m_waitReplyTimeout, and NS_LOG_FUNCTION.

◆ HandleWaitReplyTimeout()

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 195 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:

◆ Lookup()

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

Do lookup in the ARP cache against an IP address.

Parameters
destinationThe destination IPv4 address to lookup the MAC address of
Returns
An ArpCache::Entry with info about layer 2

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

References m_arpCache, and NS_LOG_FUNCTION.

Referenced by ns3::ArpL3Protocol::Lookup(), and ns3::Ipv4L3Protocol::Receive().

+ Here is the caller graph for this function:

◆ LookupInverse()

std::list< ArpCache::Entry * > ns3::ArpCache::LookupInverse ( Address  destination)

Do lookup in the ARP cache against a MAC address.

Parameters
destinationThe destination MAC address to lookup of
Returns
A std::list of ArpCache::Entry with info about layer 2

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

References ns3::ArpCache::Entry::GetMacAddress(), m_arpCache, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv4L3Protocol::Receive().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ operator=()

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

Copy constructor.

Defined and unimplemented to avoid misuse

Returns

◆ PrintArpCache()

void ns3::ArpCache::PrintArpCache ( Ptr< OutputStreamWrapper stream)

Print the ARP cache entries.

Parameters
streamthe ostream the ARP cache entries is printed to

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

References ns3::Names::FindName(), ns3::OutputStreamWrapper::GetStream(), m_arpCache, m_device, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv4RoutingHelper::PrintArpCache(), and ns3::Ipv4RoutingHelper::PrintArpCacheEvery().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Remove()

void ns3::ArpCache::Remove ( ArpCache::Entry entry)

Remove an entry.

Parameters
entrypointer to delete it from the list

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

References ns3::ArpCache::Entry::ClearPendingPacket(), m_arpCache, NS_LOG_FUNCTION, and NS_LOG_WARN.

+ Here is the call graph for this function:

◆ SetAliveTimeout()

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

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

Parameters
aliveTimeoutthe Alive state timeout

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

References m_aliveTimeout, and NS_LOG_FUNCTION.

Referenced by EpcS1uUlTestCase::DoRun().

+ Here is the caller graph for this function:

◆ SetArpRequestCallback()

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
arpRequestCallbackCallback for transmitting an Arp request.

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

References m_arpRequestCallback, and NS_LOG_FUNCTION.

◆ SetDeadTimeout()

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

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

Parameters
deadTimeoutthe Dead state timeout

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

References m_deadTimeout, and NS_LOG_FUNCTION.

◆ SetDevice()

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

Set the NetDevice and Ipv4Interface associated with the ArpCache.

Parameters
deviceThe hardware NetDevice associated with this ARP cache
interfacethe Ipv4Interface associated with this ARP cache

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

◆ SetWaitReplyTimeout()

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

Set the time the entry will be in WAIT_REPLY state.

Parameters
waitReplyTimeoutthe WAIT_REPLY state timeout

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

References m_waitReplyTimeout, and NS_LOG_FUNCTION.

◆ StartWaitReplyTimer()

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 182 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:

Member Data Documentation

◆ m_aliveTimeout

Time ns3::ArpCache::m_aliveTimeout
private

cache alive state timeout

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

Referenced by GetAliveTimeout(), GetTypeId(), and SetAliveTimeout().

◆ m_arpCache

Cache ns3::ArpCache::m_arpCache
private

the ARP cache

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

Referenced by Add(), Flush(), HandleWaitReplyTimeout(), Lookup(), LookupInverse(), PrintArpCache(), and Remove().

◆ m_arpRequestCallback

Callback<void, Ptr<const ArpCache>, Ipv4Address> ns3::ArpCache::m_arpRequestCallback
private

reply timeout callback

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

Referenced by HandleWaitReplyTimeout(), and SetArpRequestCallback().

◆ m_deadTimeout

Time ns3::ArpCache::m_deadTimeout
private

cache dead state timeout

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

Referenced by GetDeadTimeout(), GetTypeId(), and SetDeadTimeout().

◆ m_device

Ptr<NetDevice> ns3::ArpCache::m_device
private

NetDevice associated with the cache.

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

Referenced by DoDispose(), GetDevice(), HandleWaitReplyTimeout(), PrintArpCache(), and SetDevice().

◆ m_dropTrace

TracedCallback<Ptr<const Packet> > ns3::ArpCache::m_dropTrace
private

trace for packets dropped by the ARP cache queue

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

Referenced by GetTypeId(), and HandleWaitReplyTimeout().

◆ m_interface

Ptr<Ipv4Interface> ns3::ArpCache::m_interface
private

Ipv4Interface associated with the cache.

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

Referenced by DoDispose(), GetInterface(), and SetDevice().

◆ m_maxRetries

uint32_t ns3::ArpCache::m_maxRetries
private

max retries for a resolution

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

Referenced by GetTypeId(), and HandleWaitReplyTimeout().

◆ m_pendingQueueSize

uint32_t ns3::ArpCache::m_pendingQueueSize
private

number of packets waiting for a resolution

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

Referenced by GetTypeId().

◆ m_waitReplyTimeout

Time ns3::ArpCache::m_waitReplyTimeout
private

cache reply state timeout

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

Referenced by GetTypeId(), GetWaitReplyTimeout(), HandleWaitReplyTimeout(), SetWaitReplyTimeout(), and StartWaitReplyTimer().

◆ m_waitReplyTimer

EventId ns3::ArpCache::m_waitReplyTimer
private

cache alive state timer

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

Referenced by DoDispose(), Flush(), HandleWaitReplyTimeout(), and StartWaitReplyTimer().


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