ns-3
Classes | Public Member Functions | Static Public Member Functions
ns3::ArpCache Class Reference
Arp

An ARP cache. More...

#include <arp-cache.h>

Inheritance diagram for ns3::ArpCache:
Inheritance graph
[legend]
Collaboration diagram for ns3::ArpCache:
Collaboration graph
[legend]

List of all members.

Classes

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

Public Member Functions

void SetDevice (Ptr< NetDevice > device, Ptr< Ipv4Interface > interface)
Ptr< NetDevice > GetDevice (void) const
Ptr< Ipv4Interface > GetInterface (void) const
void SetAliveTimeout (Time aliveTimeout)
void SetDeadTimeout (Time deadTimeout)
void SetWaitReplyTimeout (Time waitReplyTimeout)
Time GetAliveTimeout (void) const
Time GetDeadTimeout (void) const
Time GetWaitReplyTimeout (void) const
void SetArpRequestCallback (Callback< void, Ptr< const ArpCache >, Ipv4Address > arpRequestCallback)
void StartWaitReplyTimer (void)
ArpCache::Entry * Lookup (Ipv4Address destination)
 Do lookup in the ARP cache against an IP address.
ArpCache::Entry * Add (Ipv4Address to)
 Add an Ipv4Address to this ARP cache.
void Flush (void)
 Clear the ArpCache of all entries.
- Public Member Functions inherited from ns3::Object
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Dispose (void)
void AggregateObject (Ptr< Object > other)
AggregateIterator GetAggregateIterator (void) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
SimpleRefCount & operator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
uint32_t GetReferenceCount (void) const
- Public Member Functions inherited from ns3::ObjectBase
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
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.

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
virtual void NotifyNewAggregate (void)
virtual void DoStart (void)
 Object (const Object &o)

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

Member Function Documentation

Ptr< NetDevice > ns3::ArpCache::GetDevice ( void  ) const
Returns:
The NetDevice that this ARP cache is associated with
Ptr< Ipv4Interface > ns3::ArpCache::GetInterface ( void  ) const
Returns:
the Ipv4Interface that this ARP cache is associated with
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
  • PendingQueueSize: The size of the queue for packets pending an arp reply.

TraceSources defined for this type:

Reimplemented from ns3::Object.

References ns3::MakeTraceSourceAccessor(), ns3::Seconds(), and ns3::TypeId::SetParent().

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

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

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.

References NS_LOG_FUNCTION.

void ns3::ArpCache::SetDevice ( Ptr< NetDevice >  device,
Ptr< Ipv4Interface >  interface 
)
Parameters:
deviceThe hardware NetDevice associated with this ARP chache
interfacethe Ipv4Interface associated with this ARP chache

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

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

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