An implementation of the ARP protocol. More...

#include <arp-l3-protocol.h>

Inheritance diagram for ns3::ArpL3Protocol:

Collaboration diagram for ns3::ArpL3Protocol:

Public Member Functions
	ArpL3Protocol ()

virtual	~ArpL3Protocol ()

int64_t	AssignStreams (int64_t stream)

Ptr< ArpCache >	CreateCache (Ptr< NetDevice > device, Ptr< Ipv4Interface > interface)

bool	Lookup (Ptr< Packet > p, Ipv4Address destination, Ptr< NetDevice > device, Ptr< ArpCache > cache, Address *hardwareDestination)
	Perform an ARP lookup. More...

void	Receive (Ptr< NetDevice > device, Ptr< const Packet > p, uint16_t protocol, const Address &from, const Address &to, NetDevice::PacketType packetType)
	Receive a packet. More...

void	SetNode (Ptr< Node > node)

Public Member Functions inherited from ns3::Object
	Object ()

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)

AggregateIterator	GetAggregateIterator (void) const

virtual TypeId	GetInstanceTypeId (void) const

template<typename T >
Ptr< T >	GetObject (void) const

template<typename T >
Ptr< T >	GetObject (TypeId tid) const

void	Initialize (void)

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()

	SimpleRefCount (const SimpleRefCount &o)

uint32_t	GetReferenceCount (void) const

SimpleRefCount &	operator= (const SimpleRefCount &o)

void	Ref (void) const

void	Unref (void) const

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()

void	GetAttribute (std::string name, AttributeValue &value) const

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

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)

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)

Static Public Attributes
static const uint16_t	PROT_NUMBER = 0x0806

Protected Member Functions
virtual void	DoDispose (void)

virtual void	NotifyNewAggregate ()

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	DoInitialize (void)

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)

Private Types
typedef std::list< Ptr < ArpCache > >	CacheList

Private Member Functions
	ArpL3Protocol (const ArpL3Protocol &o)

Ptr< ArpCache >	FindCache (Ptr< NetDevice > device)

ArpL3Protocol &	operator= (const ArpL3Protocol &o)

void	SendArpReply (Ptr< const ArpCache > cache, Ipv4Address myIp, Ipv4Address toIp, Address toMac)

void	SendArpRequest (Ptr< const ArpCache >cache, Ipv4Address to)

Private Attributes
CacheList	m_cacheList

TracedCallback< Ptr< const Packet > >	m_dropTrace

Ptr< Node >	m_node

Ptr< RandomVariableStream >	m_requestJitter

Detailed Description

An implementation of the ARP protocol.

Config Paths

ns3::ArpL3Protocol is accessible through the following paths with Config::Set and Config::Connect:

/NodeList/[i]/$ns3::ArpL3Protocol

Attributes

CacheList: The list of ARP caches
- Set with class: ns3::ObjectPtrContainerValue
- Underlying type: ns3::Ptr< ns3::ArpCache >
- Flags: read
RequestJitter: The jitter in ms a node is allowed to wait before sending an ARP request. Some jitter aims to prevent collisions. By default, the model will wait for a duration in ms defined by a uniform random-variable between 0 and RequestJitter
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::RandomVariableStream >
- Initial value: ns3::UniformRandomVariable[Min=0.0|Max=10.0]
- Flags: construct write read

TraceSources

Drop: Packet dropped because not enough room in pending queue for a specific cache entry.

Definition at line 49 of file arp-l3-protocol.h.

Member Typedef Documentation

typedef std::list<Ptr<ArpCache> > ns3::ArpL3Protocol::CacheList

private

Definition at line 99 of file arp-l3-protocol.h.

Constructor & Destructor Documentation

ns3::ArpL3Protocol::ArpL3Protocol ( )

Definition at line 65 of file arp-l3-protocol.cc.

References NS_LOG_FUNCTION.

ns3::ArpL3Protocol::~ArpL3Protocol ( )

virtual

Definition at line 70 of file arp-l3-protocol.cc.

References NS_LOG_FUNCTION.

ns3::ArpL3Protocol::ArpL3Protocol ( const ArpL3Protocol & o )

private

Member Function Documentation

int64_t ns3::ArpL3Protocol::AssignStreams ( int64_t stream )

Assign a fixed random variable stream number to the random variables used by this model. Return the number of streams (possibly zero) that have been assigned.

Parameters

stream first stream index to use

Returns: the number of stream indices assigned by this model

Definition at line 76 of file arp-l3-protocol.cc.

References m_requestJitter, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().

Here is the call graph for this function:

Ptr< ArpCache > ns3::ArpL3Protocol::CreateCache	(	Ptr< NetDevice >	device,
		Ptr< Ipv4Interface >	interface
	)

Definition at line 126 of file arp-l3-protocol.cc.

References ns3::ArpCache::Flush(), ns3::Object::GetObject(), m_cacheList, m_node, ns3::MakeCallback(), NS_ASSERT, NS_LOG_FUNCTION, SendArpRequest(), and ns3::ArpCache::SetDevice().

Here is the call graph for this function:

void ns3::ArpL3Protocol::DoDispose ( void )

protectedvirtual

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

Subclasses are expected to implement their real destruction code in an overriden 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 112 of file arp-l3-protocol.cc.

References ns3::Object::Dispose(), ns3::Object::DoDispose(), m_cacheList, m_node, and NS_LOG_FUNCTION.

Here is the call graph for this function:

Ptr< ArpCache > ns3::ArpL3Protocol::FindCache ( Ptr< NetDevice > device )

private

Definition at line 140 of file arp-l3-protocol.cc.

References m_cacheList, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by Receive().

Here is the caller graph for this function:

TypeId ns3::ArpL3Protocol::GetTypeId ( void )

static

Definition at line 44 of file arp-l3-protocol.cc.

References m_cacheList, m_dropTrace, m_requestJitter, ns3::MakeObjectVectorAccessor(), ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

bool ns3::ArpL3Protocol::Lookup	(	Ptr< Packet >	p,
		Ipv4Address	destination,
		Ptr< NetDevice >	device,
		Ptr< ArpCache >	cache,
		Address *	hardwareDestination
	)

Perform an ARP lookup.

Parameters

p
destination
device
cache
hardwareDestination

Returns

Definition at line 258 of file arp-l3-protocol.cc.

References ns3::ArpCache::Add(), ns3::Node::GetId(), ns3::ArpCache::Entry::GetMacAddress(), ns3::RandomVariableStream::GetValue(), ns3::ArpCache::Entry::IsAlive(), ns3::ArpCache::Entry::IsDead(), ns3::ArpCache::Entry::IsExpired(), ns3::ArpCache::Entry::IsWaitReply(), ns3::ArpCache::Lookup(), m_dropTrace, m_node, m_requestJitter, ns3::ArpCache::Entry::MarkWaitReply(), NS_FATAL_ERROR, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Simulator::Schedule(), SendArpRequest(), and ns3::ArpCache::Entry::UpdateWaitReply().

Here is the call graph for this function:

void ns3::ArpL3Protocol::NotifyNewAggregate ( void )

protectedvirtual

This method is invoked whenever two sets of objects are aggregated together. It is invoked exactly once for each object in both sets. This method can be overriden by subclasses who wish to be notified of aggregation events. These subclasses must chain up to their base class NotifyNewAggregate method. It is safe to call GetObject and AggregateObject from within this method.

This function must be implemented in the stack that needs to notify other stacks connected to the node of their presence in the node.

Reimplemented from ns3::Object.

Definition at line 95 of file arp-l3-protocol.cc.

References m_node, ns3::Object::NotifyNewAggregate(), NS_LOG_FUNCTION, and SetNode().

Here is the call graph for this function:

ArpL3Protocol& ns3::ArpL3Protocol::operator= ( const ArpL3Protocol & o )

private

void ns3::ArpL3Protocol::Receive	(	Ptr< NetDevice >	device,
		Ptr< const Packet >	p,
		uint16_t	protocol,
		const Address &	from,
		const Address &	to,
		NetDevice::PacketType	packetType
	)