A record that that holds information about an ArpCache entry. More...
#include "arp-cache.h"
Public Member Functions | |
Entry (ArpCache *arp) | |
Constructor. | |
void | ClearPendingPacket () |
Clear the pending packet list. | |
void | ClearRetries () |
Zero the counter of number of retries for an entry. | |
Ipv4PayloadHeaderPair | DequeuePending () |
Ipv4Address | GetIpv4Address () const |
Address | GetMacAddress () const |
uint32_t | GetRetries () const |
void | IncrementRetries () |
Increment the counter of number of retries for an entry. | |
bool | IsAlive () |
bool | IsAutoGenerated () |
bool | IsDead () |
bool | IsExpired () const |
bool | IsPermanent () |
bool | IsWaitReply () |
void | MarkAlive (Address macAddress) |
void | MarkAutoGenerated () |
Changes the state of this entry to auto-generated. | |
void | MarkDead () |
Changes the state of this entry to dead. | |
void | MarkPermanent () |
Changes the state of this entry to Permanent. | |
void | MarkWaitReply (Ipv4PayloadHeaderPair waiting) |
void | SetIpv4Address (Ipv4Address destination) |
void | SetMacAddress (Address macAddress) |
void | UpdateSeen () |
Update the entry when seeing a packet. | |
bool | UpdateWaitReply (Ipv4PayloadHeaderPair waiting) |
Private Types | |
enum | ArpCacheEntryState_e { ALIVE , WAIT_REPLY , DEAD , PERMANENT , STATIC_AUTOGENERATED } |
ARP cache entry states. More... | |
Private Member Functions | |
Time | GetTimeout () const |
Returns the entry timeout. | |
Private Attributes | |
ArpCache * | m_arp |
pointer to the ARP cache owning the entry | |
Ipv4Address | m_ipv4Address |
entry's IP address | |
Time | m_lastSeen |
last moment a packet from that address has been seen | |
Address | m_macAddress |
entry's MAC address | |
std::list< Ipv4PayloadHeaderPair > | m_pending |
list of pending packets for the entry's IP | |
uint32_t | m_retries |
retry counter | |
ArpCacheEntryState_e | m_state |
state of the entry | |
A record that that holds information about an ArpCache entry.
Definition at line 172 of file arp-cache.h.
|
private |
ARP cache entry states.
Enumerator | |
---|---|
ALIVE | |
WAIT_REPLY | |
DEAD | |
PERMANENT | |
STATIC_AUTOGENERATED |
Definition at line 285 of file arp-cache.h.
ns3::ArpCache::Entry::Entry | ( | ArpCache * | arp | ) |
Constructor.
arp | The ArpCache this entry belongs to |
Definition at line 370 of file arp-cache.cc.
References NS_LOG_FUNCTION.
void ns3::ArpCache::Entry::ClearPendingPacket | ( | ) |
Clear the pending packet list.
Definition at line 562 of file arp-cache.cc.
References NS_LOG_FUNCTION.
Referenced by ns3::ArpCache::Remove().
void ns3::ArpCache::Entry::ClearRetries | ( | ) |
Zero the counter of number of retries for an entry.
Definition at line 591 of file arp-cache.cc.
References NS_LOG_FUNCTION.
Referenced by ns3::ArpCache::HandleWaitReplyTimeout().
ArpCache::Ipv4PayloadHeaderPair ns3::ArpCache::Entry::DequeuePending | ( | ) |
Definition at line 545 of file arp-cache.cc.
References NS_LOG_FUNCTION.
Referenced by ns3::ArpCache::HandleWaitReplyTimeout(), and ns3::ArpL3Protocol::Receive().
Ipv4Address ns3::ArpCache::Entry::GetIpv4Address | ( | ) | const |
Definition at line 502 of file arp-cache.cc.
References NS_LOG_FUNCTION.
Referenced by ns3::ArpCache::HandleWaitReplyTimeout().
Address ns3::ArpCache::Entry::GetMacAddress | ( | ) | const |
Definition at line 488 of file arp-cache.cc.
References NS_LOG_FUNCTION.
Referenced by ns3::ArpL3Protocol::Lookup(), ns3::ArpCache::LookupInverse(), ns3::aodv::Neighbors::LookupMacAddress(), and ns3::dsr::DsrRouteCache::LookupMacAddress().
uint32_t ns3::ArpCache::Entry::GetRetries | ( | ) | const |
Definition at line 576 of file arp-cache.cc.
References NS_LOG_FUNCTION.
Referenced by ns3::ArpCache::HandleWaitReplyTimeout().
|
private |
Returns the entry timeout.
Definition at line 516 of file arp-cache.cc.
References ALIVE, DEAD, ns3::Time::Max(), NS_LOG_FUNCTION, PERMANENT, STATIC_AUTOGENERATED, and WAIT_REPLY.
void ns3::ArpCache::Entry::IncrementRetries | ( | ) |
Increment the counter of number of retries for an entry.
Definition at line 583 of file arp-cache.cc.
References NS_LOG_FUNCTION.
Referenced by ns3::ArpCache::HandleWaitReplyTimeout().
bool ns3::ArpCache::Entry::IsAlive | ( | ) |
Definition at line 386 of file arp-cache.cc.
References NS_LOG_FUNCTION.
Referenced by ns3::ArpL3Protocol::Lookup(), ns3::aodv::Neighbors::LookupMacAddress(), ns3::dsr::DsrRouteCache::LookupMacAddress(), and ns3::Ipv4L3Protocol::Receive().
bool ns3::ArpCache::Entry::IsAutoGenerated | ( | ) |
Definition at line 407 of file arp-cache.cc.
References NS_LOG_FUNCTION.
Referenced by ns3::ArpL3Protocol::Lookup().
bool ns3::ArpCache::Entry::IsDead | ( | ) |
Definition at line 379 of file arp-cache.cc.
References NS_LOG_FUNCTION.
Referenced by ns3::ArpL3Protocol::Lookup().
bool ns3::ArpCache::Entry::IsExpired | ( | ) | const |
This function returns true if the time elapsed strictly exceeds the timeout value (i.e., is not less than or equal to the timeout).
Definition at line 535 of file arp-cache.cc.
References ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and timeout.
Referenced by ns3::ArpL3Protocol::Lookup(), ns3::aodv::Neighbors::LookupMacAddress(), and ns3::dsr::DsrRouteCache::LookupMacAddress().
bool ns3::ArpCache::Entry::IsPermanent | ( | ) |
Definition at line 400 of file arp-cache.cc.
References NS_LOG_FUNCTION.
Referenced by ns3::ArpL3Protocol::Lookup(), ns3::aodv::Neighbors::LookupMacAddress(), and ns3::dsr::DsrRouteCache::LookupMacAddress().
bool ns3::ArpCache::Entry::IsWaitReply | ( | ) |
Definition at line 393 of file arp-cache.cc.
References NS_LOG_FUNCTION.
Referenced by ns3::ArpCache::HandleWaitReplyTimeout(), ns3::ArpL3Protocol::Lookup(), and ns3::ArpL3Protocol::Receive().
void ns3::ArpCache::Entry::MarkAlive | ( | Address | macAddress | ) |
macAddress |
Definition at line 424 of file arp-cache.cc.
References NS_ASSERT, and NS_LOG_FUNCTION.
Referenced by ns3::ArpL3Protocol::Receive().
void ns3::ArpCache::Entry::MarkAutoGenerated | ( | ) |
Changes the state of this entry to auto-generated.
The entry must have a valid MacAddress.
Definition at line 446 of file arp-cache.cc.
References NS_ASSERT, and NS_LOG_FUNCTION.
Referenced by ns3::NeighborCacheHelper::AddEntry().
void ns3::ArpCache::Entry::MarkDead | ( | ) |
Changes the state of this entry to dead.
Definition at line 414 of file arp-cache.cc.
References NS_ASSERT, and NS_LOG_FUNCTION.
Referenced by ns3::ArpCache::HandleWaitReplyTimeout().
void ns3::ArpCache::Entry::MarkPermanent | ( | ) |
Changes the state of this entry to Permanent.
The entry must have a valid MacAddress.
Definition at line 435 of file arp-cache.cc.
References NS_ASSERT, and NS_LOG_FUNCTION.
Referenced by EpcS1uUlTestCase::DoRun(), and FlushTest::DoRun().
void ns3::ArpCache::Entry::MarkWaitReply | ( | Ipv4PayloadHeaderPair | waiting | ) |
waiting |
Definition at line 474 of file arp-cache.cc.
References NS_ASSERT, NS_ASSERT_MSG, and NS_LOG_FUNCTION.
Referenced by ns3::ArpL3Protocol::Lookup().
void ns3::ArpCache::Entry::SetIpv4Address | ( | Ipv4Address | destination | ) |
destination | The Ipv4Address for this entry |
Definition at line 509 of file arp-cache.cc.
References NS_LOG_FUNCTION.
void ns3::ArpCache::Entry::SetMacAddress | ( | Address | macAddress | ) |
macAddress | The MacAddress for this entry |
Definition at line 495 of file arp-cache.cc.
References NS_LOG_FUNCTION.
Referenced by ns3::NeighborCacheHelper::AddEntry(), EpcS1uUlTestCase::DoRun(), and FlushTest::DoRun().
void ns3::ArpCache::Entry::UpdateSeen | ( | ) |
Update the entry when seeing a packet.
Definition at line 569 of file arp-cache.cc.
References ns3::Simulator::Now(), and NS_LOG_FUNCTION.
Referenced by ns3::Ipv4L3Protocol::Receive().
bool ns3::ArpCache::Entry::UpdateWaitReply | ( | Ipv4PayloadHeaderPair | waiting | ) |
waiting |
Definition at line 457 of file arp-cache.cc.
References NS_ASSERT, and NS_LOG_FUNCTION.
Referenced by ns3::ArpL3Protocol::Lookup().
|
private |
pointer to the ARP cache owning the entry
Definition at line 300 of file arp-cache.h.
|
private |
entry's IP address
Definition at line 304 of file arp-cache.h.
|
private |
last moment a packet from that address has been seen
Definition at line 302 of file arp-cache.h.
|
private |
entry's MAC address
Definition at line 303 of file arp-cache.h.
|
private |
list of pending packets for the entry's IP
Definition at line 305 of file arp-cache.h.
|
private |
retry counter
Definition at line 306 of file arp-cache.h.
|
private |
state of the entry
Definition at line 301 of file arp-cache.h.