ns3::ArpCache::Entry Class Reference

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

#include <arp-cache.h>

List of all members.

Public Member Functions
	Entry (ArpCache *arp)
	Constructor.
void	MarkDead (void)
	Changes the state of this entry to dead.
void	MarkAlive (Address macAddress)
void	MarkWaitReply (Ptr< Packet > waiting)
bool	UpdateWaitReply (Ptr< Packet > waiting)
bool	IsDead (void)
bool	IsAlive (void)
bool	IsWaitReply (void)
Address	GetMacAddress (void) const
Ipv4Address	GetIpv4Address (void) const
void	SetIpv4Address (Ipv4Address destination)
bool	IsExpired (void) const
Ptr< Packet >	DequeuePending (void)
uint32_t	GetRetries (void) const
void	IncrementRetries (void)
	Increment the counter of number of retries for an entry.
void	ClearRetries (void)
	Zero the counter of number of retries for an entry.

---

Detailed Description

A record that that holds information about an ArpCache entry.

---

Constructor & Destructor Documentation

ns3::ArpCache::Entry::Entry

(

ArpCache *

arp

)

Constructor.

Parameters:

arp	The ArpCache this entry belongs to

References NS_LOG_FUNCTION.

---

Member Function Documentation

Ptr< Packet > ns3::ArpCache::Entry::DequeuePending

(

void

)

Returns:

0 is no packet is pending, the next packet to send if packets are pending.

References NS_LOG_FUNCTION.

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

Ipv4Address ns3::ArpCache::Entry::GetIpv4Address

(

void

)

const

Returns:

The Ipv4Address for this entry

Address ns3::ArpCache::Entry::GetMacAddress

(

void

)

const

Returns:

The MacAddress of this entry

References NS_ASSERT.

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

uint32_t ns3::ArpCache::Entry::GetRetries

(

void

)

const

Returns:

number of retries that have been sent for an ArpRequest in WaitReply state.

bool ns3::ArpCache::Entry::IsAlive

(

void

)

Returns:

True if the state of this entry is alive; false otherwise.

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

bool ns3::ArpCache::Entry::IsDead

(

void

)

Returns:

True if the state of this entry is dead; false otherwise.

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

bool ns3::ArpCache::Entry::IsExpired

(

void

)

const

Returns:

True if this entry has timed out; false otherwise.

This function returns true if the time elapsed strictly exceeds the timeout value (i.e., is not less than or equal to the timeout).

References ns3::Time::GetSeconds(), ns3::Now(), and NS_LOG_DEBUG.

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

bool ns3::ArpCache::Entry::IsWaitReply

(

void

)

Returns:

True if the state of this entry is wait_reply; false otherwise.

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

void ns3::ArpCache::Entry::MarkAlive

(

Address

macAddress

)

Parameters:

macAddress

References NS_ASSERT, and NS_LOG_FUNCTION.

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

void ns3::ArpCache::Entry::MarkWaitReply

(

Ptr< Packet >

waiting

)

Parameters:

waiting

References NS_ASSERT, and NS_LOG_FUNCTION.

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

void ns3::ArpCache::Entry::SetIpv4Address

(

Ipv4Address

destination

)

Parameters:

destination

The Ipv4Address for this entry

References NS_LOG_FUNCTION.

bool ns3::ArpCache::Entry::UpdateWaitReply

(

Ptr< Packet >

waiting

)

Parameters:

waiting

Returns:

References NS_ASSERT, and NS_LOG_FUNCTION.

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

---

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

• src/internet/model/arp-cache.h
• src/internet/model/arp-cache.cc