NDN application for sending out Interest packets. More...

#include <ndn-consumer.hpp>

Inheritance diagram for ns3::ndn::Consumer:

Collaboration diagram for ns3::ndn::Consumer:

Public Member Functions
	Consumer ()
	Default constructor Sets up randomizer function and packet sequence number. More...

virtual	~Consumer ()

virtual void	OnData (shared_ptr< const Data > contentObject)
	Method that will be called every time new Data arrives. More...

virtual void	OnTimeout (uint32_t sequenceNumber)
	Timeout event. More...

void	SendPacket ()
	Actually send packet. More...

virtual void	WillSendOutInterest (uint32_t sequenceNumber)
	An event that is fired just before an Interest packet is actually send out (send is inevitable) More...

Public Member Functions inherited from ns3::ndn::App
	App ()
	Default constructor. More...

virtual	~App ()

uint32_t	GetId () const
	Get application ID (ID of applications face) More...

virtual void	OnInterest (shared_ptr< const Interest > interest)
	Method that will be called every time new Interest arrives. More...

Static Public Member Functions
static TypeId	GetTypeId ()

Static Public Member Functions inherited from ns3::ndn::App
static TypeId	GetTypeId ()

Protected Member Functions
virtual void	StartApplication ()
	Called at time specified by Start. More...

virtual void	StopApplication ()
	Called at time specified by Stop. More...

virtual void	ScheduleNextPacket ()=0
	Constructs the Interest packet and sends it using a callback to the underlying NDN protocol. More...

void	CheckRetxTimeout ()
	Checks if the packet need to be retransmitted becuase of retransmission timer expiration. More...

void	SetRetxTimer (Time retxTimer)
	Modifies the frequency of checking the retransmission timeouts. More...

Time	GetRetxTimer () const
	Returns the frequency of checking the retransmission timeouts. More...

Protected Member Functions inherited from ns3::ndn::App
virtual void	DoDispose ()
	Do cleanup when application is destroyed. More...

Protected Attributes
UniformVariable	m_rand
	nonce generator More...

uint32_t	m_seq
	currently requested sequence number More...

uint32_t	m_seqMax
	maximum number of sequence number More...

EventId	m_sendEvent
	EventId of pending "send packet" event. More...

Time	m_retxTimer
	Currently estimated retransmission timer. More...

EventId	m_retxEvent
	Event to check whether or not retransmission should be performed. More...

Ptr< RttEstimator >	m_rtt
	RTT estimator. More...

Time	m_offTime
	Time interval between packets. More...

Name	m_interestName
	NDN Name of the Interest (use Name) More...

Time	m_interestLifeTime
	LifeTime for interest packet. More...

Protected Attributes inherited from ns3::ndn::App
bool	m_active
	Flag to indicate that application is active (set by StartApplication. More...

shared_ptr< Face >	m_face
	and StopApplication) More...

TracedCallback< shared_ptr < const Interest >, Ptr< App > , shared_ptr< Face > >	m_receivedInterests
	communicates More...

TracedCallback< shared_ptr < const Data >, Ptr< App > , shared_ptr< Face > >	m_receivedDatas
	App-level trace of received Data. More...

TracedCallback< shared_ptr < const Interest >, Ptr< App > , shared_ptr< Face > >	m_transmittedInterests
	App-level trace of transmitted Interests. More...

TracedCallback< shared_ptr < const Data >, Ptr< App > , shared_ptr< Face > >	m_transmittedDatas
	App-level trace of transmitted Data. More...

Detailed Description

NDN application for sending out Interest packets.

Config Paths

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

/NodeList/[i]/ApplicationList/[i]/$ns3::ndn::App/$ns3::ndn::Consumer
/NodeList/[i]/ApplicationList/[i]/$ns3::ndn::Consumer

Attributes

StartSeq: Initial sequence number
- Set with class: ns3::IntegerValue
- Underlying type: int32_t -2147483648:2147483647
- Initial value: 0
- Flags: construct write read
Prefix: Name of the Interest
- Set with class: NameValue
- Underlying type: Name
- Initial value: /
- Flags: construct write read
LifeTime: LifeTime for interest packet
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: 2s
- Flags: construct write read
RetxTimer: Timeout defining how frequent retransmission timeouts should be checked
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: 50ms
- Flags: construct write read

Attributes defined in parent class ns3::Application

StartTime: Time at which the application will start
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +0.0ns
- Flags: construct write read
StopTime: Time at which the application will stop
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +0.0ns
- Flags: construct write read

TraceSources

LastRetransmittedInterestDataDelay: Delay between last retransmitted Interest and received Data
FirstInterestDataDelay: Delay between first transmitted Interest and received Data

TraceSources defined in parent class ns3::ndn::App

ReceivedInterests: ReceivedInterests
ReceivedDatas: ReceivedDatas
TransmittedInterests: TransmittedInterests
TransmittedDatas: TransmittedDatas

Definition at line 50 of file ndn-consumer.hpp.

Constructor & Destructor Documentation

ns3::ndn::Consumer::Consumer ( )

Default constructor Sets up randomizer function and packet sequence number.

Definition at line 78 of file ndn-consumer.cpp.

References m_rtt.

virtual ns3::ndn::Consumer::~Consumer ( )

inlinevirtual

Definition at line 60 of file ndn-consumer.hpp.

Member Function Documentation

void ns3::ndn::Consumer::CheckRetxTimeout ( )

protected

Checks if the packet need to be retransmitted becuase of retransmission timer expiration.

Definition at line 108 of file ndn-consumer.cpp.

References m_retxEvent, m_retxTimer, m_rtt, and OnTimeout().

Referenced by SetRetxTimer().

Time ns3::ndn::Consumer::GetRetxTimer ( ) const

protected

Returns the frequency of checking the retransmission timeouts.

Returns: Timeout defining how frequent retransmission timeouts should be checked

Definition at line 102 of file ndn-consumer.cpp.

References m_retxTimer.

Referenced by GetTypeId().

TypeId ns3::ndn::Consumer::GetTypeId ( void )

static

Definition at line 47 of file ndn-consumer.cpp.

References GetRetxTimer(), m_interestLifeTime, m_interestName, m_seq, ns3::ndn::MakeNameAccessor(), ns3::ndn::MakeNameChecker(), and SetRetxTimer().

void ns3::ndn::Consumer::OnData ( shared_ptr< const Data > data )

virtual

Method that will be called every time new Data arrives.

Parameters

contentObject	Data header
payload	payload (potentially virtual) of the Data packet (may include packet tags of original packet)

Reimplemented from ns3::ndn::App.

Reimplemented in ns3::ndn::ConsumerWindow.

Definition at line 209 of file ndn-consumer.cpp.

References ns3::ndn::FwHopCountTag::Get(), ns3::ndn::App::m_active, m_rtt, and ns3::ndn::App::OnData().

Referenced by ns3::ndn::ConsumerWindow::OnData().

void ns3::ndn::Consumer::OnTimeout ( uint32_t sequenceNumber )

virtual

Timeout event.

Parameters

sequenceNumber time outed sequence number

Reimplemented in ns3::ndn::ConsumerWindow.

Definition at line 255 of file ndn-consumer.cpp.

References m_rtt, and ScheduleNextPacket().

Referenced by CheckRetxTimeout(), and ns3::ndn::ConsumerWindow::OnTimeout().

virtual void ns3::ndn::Consumer::ScheduleNextPacket ( )

protectedpure virtual

Constructs the Interest packet and sends it using a callback to the underlying NDN protocol.

Implemented in ns3::ndn::ConsumerZipfMandelbrot, ns3::ndn::ConsumerWindow, ns3::ndn::ConsumerBatches, and ns3::ndn::ConsumerCbr.

Referenced by OnTimeout(), SendPacket(), and StartApplication().

void ns3::ndn::Consumer::SendPacket ( )

Actually send packet.

Definition at line 156 of file ndn-consumer.cpp.

References ns3::ndn::App::m_active, ns3::ndn::App::m_face, m_interestLifeTime, m_interestName, m_rand, m_seq, m_seqMax, ns3::ndn::App::m_transmittedInterests, ScheduleNextPacket(), and WillSendOutInterest().

Referenced by ns3::ndn::ConsumerCbr::ScheduleNextPacket(), ns3::ndn::ConsumerBatches::ScheduleNextPacket(), and ns3::ndn::ConsumerWindow::ScheduleNextPacket().

void ns3::ndn::Consumer::SetRetxTimer ( Time retxTimer )

protected

Modifies the frequency of checking the retransmission timeouts.

Parameters

retxTimer Timeout defining how frequent retransmission timeouts should be checked

Definition at line 89 of file ndn-consumer.cpp.

References CheckRetxTimeout(), m_retxEvent, and m_retxTimer.

Referenced by GetTypeId().

void ns3::ndn::Consumer::StartApplication ( )

protectedvirtual

Called at time specified by Start.

Reimplemented from ns3::ndn::App.

Definition at line 133 of file ndn-consumer.cpp.

References ScheduleNextPacket(), and ns3::ndn::App::StartApplication().

void ns3::ndn::Consumer::StopApplication ( )

protectedvirtual

Called at time specified by Stop.

Reimplemented from ns3::ndn::App.

Definition at line 144 of file ndn-consumer.cpp.

References m_sendEvent, and ns3::ndn::App::StopApplication().

void ns3::ndn::Consumer::WillSendOutInterest ( uint32_t sequenceNumber )

virtual

An event that is fired just before an Interest packet is actually send out (send is inevitable)

The reason for "before" even is that in certain cases (when it is possible to satisfy from the local cache), the send call will immediately return data, and if "after" even was used, this after would be called after all processing of incoming data, potentially producing unexpected results.

Reimplemented in ns3::ndn::ConsumerWindow.

Definition at line 269 of file ndn-consumer.cpp.

References m_rtt.

Referenced by SendPacket(), and ns3::ndn::ConsumerWindow::WillSendOutInterest().