Ndn application for sending out Interest packets (window-based) More...

#include <ndn-consumer-window.hpp>

Inheritance diagram for ns3::ndn::ConsumerWindow:

[legend]

Collaboration diagram for ns3::ndn::ConsumerWindow:

[legend]

Public Types
typedef std::function< void(double)>	WindowTraceCallback

Public Types inherited from ns3::ndn::Consumer
typedef void(*	LastRetransmittedInterestDataDelayCallback) (Ptr< App > app, uint32_t seqno, Time delay, int32_t hopCount)

typedef void(*	FirstInterestDataDelayCallback) (Ptr< App > app, uint32_t seqno, Time delay, uint32_t retxCount, int32_t hopCount)

Public Types inherited from ns3::ndn::App
typedef void(*	InterestTraceCallback) (shared_ptr< const Interest >, Ptr< App >, shared_ptr< Face >)

typedef void(*	DataTraceCallback) (shared_ptr< const Data >, Ptr< App >, shared_ptr< Face >)

typedef void(*	NackTraceCallback) (shared_ptr< const lp::Nack >, Ptr< App >, shared_ptr< Face >)

Public Member Functions
	ConsumerWindow ()
	Default constructor. More...

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...

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::Consumer
	Consumer ()
	Default constructor Sets up randomizer function and packet sequence number. More...

virtual	~Consumer ()

virtual void	OnNack (shared_ptr< const lp::Nack > nack)
	Method that will be called every time new Nack arrives. More...

void	SendPacket ()
	Actually send packet. 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::Consumer
static TypeId	GetTypeId ()

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

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

Protected Member Functions inherited from ns3::ndn::Consumer
virtual void	StartApplication ()
	Called at time specified by Start. More...

virtual void	StopApplication ()
	Called at time specified by Stop. 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	DoInitialize ()

virtual void	DoDispose ()

Protected Attributes
uint32_t	m_payloadSize

double	m_maxSize

uint32_t	m_initialWindow

bool	m_setInitialWindowOnTimeout

TracedValue< double >	m_window

TracedValue< uint32_t >	m_inFlight

Protected Attributes inherited from ns3::ndn::Consumer
Ptr< UniformRandomVariable >	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 and StopApplication) More...

shared_ptr< Face >	m_face

AppLinkService *	m_appLink

uint32_t	m_appId

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

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

TracedCallback< shared_ptr< const lp::Nack >, Ptr< App >, shared_ptr< Face > >	m_receivedNacks
	App-level trace of received Nacks. 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...

TracedCallback< shared_ptr< const lp::Nack >, Ptr< App >, shared_ptr< Face > >	m_transmittedNacks
	App-level trace of transmitted Nacks. More...

Detailed Description

Ndn application for sending out Interest packets (window-based)

!!! ATTENTION !!! This is highly experimental and relies on experimental features of the simulator. Behavior may be unpredictable if used incorrectly.

Config Paths

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

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

Attributes

Window: Initial size of the window
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 1
- Flags: construct write read
PayloadSize: Average size of content object size (to calculate interest generation rate)
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 1040
- Flags: construct write read
Size: Amount of data in megabytes to request, relying on PayloadSize parameter (alternative to MaxSeq attribute)
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: -1
- Flags: construct write read
MaxSeq: Maximum sequence number to request (alternative to Size attribute, would activate only if Size is -1). The parameter is activated only if Size negative (not set)
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 4294967295
- Flags: construct write read
InitialWindowOnTimeout: Set window to initial value when timeout occurs
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: construct write read

Attributes defined in parent class ns3::ndn::Consumer

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 -9.22337e+18ns:+9.22337e+18ns
- 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 -9.22337e+18ns:+9.22337e+18ns
- 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 -9.22337e+18ns:+9.22337e+18ns
- Initial value: +0ns
- Flags: construct write read
StopTime: Time at which the application will stop
- Set with class: ns3::TimeValue
- Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
- Initial value: +0ns
- Flags: construct write read

TraceSources

WindowTrace: Window that controls how many outstanding interests are allowed
Callback signature: ns3::ndn::ConsumerWindow::WindowTraceCallback
InFlight: Current number of outstanding interests
Callback signature: ns3::ndn::ConsumerWindow::WindowTraceCallback

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

LastRetransmittedInterestDataDelay: Delay between last retransmitted Interest and received Data
Callback signature: ns3::ndn::Consumer::LastRetransmittedInterestDataDelayCallback
FirstInterestDataDelay: Delay between first transmitted Interest and received Data
Callback signature: ns3::ndn::Consumer::FirstInterestDataDelayCallback

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

ReceivedInterests: ReceivedInterests
Callback signature: ns3::ndn::App::InterestTraceCallback
ReceivedDatas: ReceivedDatas
Callback signature: ns3::ndn::App::DataTraceCallback
ReceivedNacks: ReceivedNacks
Callback signature: ns3::ndn::App::NackTraceCallback
TransmittedInterests: TransmittedInterests
Callback signature: ns3::ndn::App::InterestTraceCallback
TransmittedDatas: TransmittedDatas
Callback signature: ns3::ndn::App::DataTraceCallback
TransmittedNacks: TransmittedNacks
Callback signature: ns3::ndn::App::NackTraceCallback

Size of this type is 800 bytes (on a 64-bit architecture).

Definition at line 39 of file ndn-consumer-window.hpp.

Member Typedef Documentation

◆ WindowTraceCallback

typedef std::function<void(double)> ns3::ndn::ConsumerWindow::WindowTraceCallback

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

Constructor & Destructor Documentation

◆ ConsumerWindow()

ns3::ndn::ConsumerWindow::ConsumerWindow ( )

Default constructor.

Definition at line 86 of file ndn-consumer-window.cpp.

References m_initialWindow, m_maxSize, m_payloadSize, ns3::ndn::Consumer::m_seqMax, m_window, and nonstd::span_lite::size().

Member Function Documentation

◆ GetTypeId()

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

static

Definition at line 39 of file ndn-consumer-window.cpp.

References m_inFlight, m_setInitialWindowOnTimeout, and m_window.

◆ OnData()

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

virtual

Method that will be called every time new Data arrives.

Reimplemented from ns3::ndn::Consumer.

Reimplemented in ns3::ndn::ConsumerPcon.

Definition at line 186 of file ndn-consumer-window.cpp.

References m_inFlight, m_window, ns3::ndn::Consumer::OnData(), and ScheduleNextPacket().

◆ OnTimeout()

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

virtual

Timeout event.

Parameters

sequenceNumber time outed sequence number

Reimplemented from ns3::ndn::Consumer.

Reimplemented in ns3::ndn::ConsumerPcon.

Definition at line 200 of file ndn-consumer-window.cpp.

References m_inFlight, m_initialWindow, m_setInitialWindowOnTimeout, m_window, and ns3::ndn::Consumer::OnTimeout().

◆ WillSendOutInterest()

void ns3::ndn::ConsumerWindow::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 from ns3::ndn::Consumer.

Definition at line 215 of file ndn-consumer-window.cpp.

References m_inFlight, and ns3::ndn::Consumer::WillSendOutInterest().

◆ ScheduleNextPacket()

void ns3::ndn::ConsumerWindow::ScheduleNextPacket ( )

protectedvirtual

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

Implements ns3::ndn::Consumer.

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

References m_inFlight, ns3::ndn::Consumer::m_rtt, ns3::ndn::Consumer::m_sendEvent, m_window, and ns3::ndn::Consumer::SendPacket().

Referenced by OnData(), and ns3::ndn::ConsumerPcon::OnData().

Member Data Documentation

◆ m_payloadSize

uint32_t ns3::ndn::ConsumerWindow::m_payloadSize

protected

Definition at line 96 of file ndn-consumer-window.hpp.

Referenced by ConsumerWindow().

◆ m_maxSize

double ns3::ndn::ConsumerWindow::m_maxSize

protected

Definition at line 97 of file ndn-consumer-window.hpp.

Referenced by ConsumerWindow().

◆ m_initialWindow

uint32_t ns3::ndn::ConsumerWindow::m_initialWindow

protected

Definition at line 99 of file ndn-consumer-window.hpp.

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

◆ m_setInitialWindowOnTimeout

bool ns3::ndn::ConsumerWindow::m_setInitialWindowOnTimeout

protected

Definition at line 100 of file ndn-consumer-window.hpp.

Referenced by GetTypeId(), and OnTimeout().

◆ m_window

TracedValue<double> ns3::ndn::ConsumerWindow::m_window

protected

Definition at line 102 of file ndn-consumer-window.hpp.

Referenced by ConsumerWindow(), GetTypeId(), OnData(), ns3::ndn::ConsumerPcon::OnData(), OnTimeout(), ns3::ndn::ConsumerPcon::OnTimeout(), and ScheduleNextPacket().

◆ m_inFlight

TracedValue<uint32_t> ns3::ndn::ConsumerWindow::m_inFlight

protected

Definition at line 103 of file ndn-consumer-window.hpp.

Referenced by GetTypeId(), OnData(), ns3::ndn::ConsumerPcon::OnData(), OnTimeout(), ns3::ndn::ConsumerPcon::OnTimeout(), ScheduleNextPacket(), and WillSendOutInterest().

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

ndnSIM/apps/ndn-consumer-window.hpp
ndnSIM/apps/ndn-consumer-window.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::ndn::Consumer

Attributes defined in parent class ns3::Application

TraceSources

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

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

Member Typedef Documentation

◆ WindowTraceCallback

Constructor & Destructor Documentation

◆ ConsumerWindow()

Member Function Documentation

◆ GetTypeId()

◆ OnData()

◆ OnTimeout()

◆ WillSendOutInterest()

◆ ScheduleNextPacket()

Member Data Documentation

◆ m_payloadSize

◆ m_maxSize

◆ m_initialWindow

◆ m_setInitialWindowOnTimeout

◆ m_window

◆ m_inFlight