ns-3
ns3::NdiscCache Class Reference

IPv6 Neighbor Discovery cache. More...

#include <ndisc-cache.h>

Inheritance diagram for ns3::NdiscCache:
Collaboration diagram for ns3::NdiscCache:

List of all members.

Classes

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

Public Member Functions

 NdiscCache ()
 Constructor.
 ~NdiscCache ()
 Destructor.
Ptr< NetDeviceGetDevice () const
 Get the NetDevice associated with this cache.
Ptr< Ipv6InterfaceGetInterface () const
 Get the Ipv6Interface associated with this cache.
NdiscCache::EntryLookup (Ipv6Address dst)
 Lookup in the cache.
NdiscCache::EntryAdd (Ipv6Address to)
 Add an entry.
void Remove (NdiscCache::Entry *entry)
 Delete an entry.
void Flush ()
 Flush the cache.
void SetUnresQlen (uint32_t unresQlen)
 Set the max number of waiting packet.
uint32_t GetUnresQlen ()
 Get the max number of waiting packet.
void SetDevice (Ptr< NetDevice > device, Ptr< Ipv6Interface > interface)
 Set the device and interface.

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID.

Static Public Attributes

static const uint32_t DEFAULT_UNRES_QLEN = 3
 Default value for unres qlen.

Detailed Description

IPv6 Neighbor Discovery cache.


Member Function Documentation

Add an entry.

Parameters:
toaddress to add
Returns:
an new Entry

References NS_ASSERT, and NS_LOG_FUNCTION.

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

Get the NetDevice associated with this cache.

Returns:
NetDevice

References NS_LOG_FUNCTION_NOARGS.

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

TypeId ns3::NdiscCache::GetTypeId ( void  ) [static]

Get the type ID.

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

Returns:
type ID

This object is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::NdiscCache
  • /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::NdiscCache

Attributes defined for this type:

  • UnresolvedQueueSize: Size of the queue for packets pending an NA reply.

No TraceSources defined for this type.

Reimplemented from ns3::Object.

References DEFAULT_UNRES_QLEN, and ns3::TypeId::SetParent().

Get the max number of waiting packet.

Returns:
max number

References NS_LOG_FUNCTION_NOARGS.

Lookup in the cache.

Parameters:
dstdestination address
Returns:
the entry if found, 0 otherwise

References NS_LOG_FUNCTION.

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

Delete an entry.

Parameters:
entrypointer to delete from the list.

References ns3::NdiscCache::Entry::ClearWaitingPacket(), and NS_LOG_FUNCTION_NOARGS.

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

void ns3::NdiscCache::SetDevice ( Ptr< NetDevice device,
Ptr< Ipv6Interface interface 
)

Set the device and interface.

Parameters:
devicethe device
interfacethe IPv6 interface

References NS_LOG_FUNCTION.

Referenced by ns3::Icmpv6L4Protocol::CreateCache().

void ns3::NdiscCache::SetUnresQlen ( uint32_t  unresQlen)

Set the max number of waiting packet.

Parameters:
unresQlenvalue to set

References NS_LOG_FUNCTION.


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