NS-3 based Named Data Networking (NDN) simulator
ndnSIM: NDN, CCN, CCNx, content centric networks 		API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
ns3::ndn::ConsumerWindow Class Reference
NDN applications

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

#include <ndn-consumer-window.h>

Inheritance diagram for ns3::ndn::ConsumerWindow:
Inheritance graph
[legend]
Collaboration diagram for ns3::ndn::ConsumerWindow:
Collaboration graph
[legend]

Public Member Functions

 ConsumerWindow ()
 Default constructor.
 
virtual void OnNack (Ptr< const Interest > interest)
 Method that will be called every time new NACK arrives. More...
 
virtual void OnData (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.
 
void SendPacket ()
 Actually send packet.
 
- Public Member Functions inherited from ns3::ndn::App
 App ()
 Default constructor.
 
uint32_t GetId () const
 Get application ID (ID of applications face)
 
virtual void OnInterest (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.
 
- Protected Member Functions inherited from ns3::ndn::Consumer
virtual void StartApplication ()
 Called at time specified by Start.
 
virtual void StopApplication ()
 Called at time specified by Stop.
 
void CheckRetxTimeout ()
 Checks if the packet need to be retransmitted becuase of retransmission timer expiration.
 
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.
 

Additional Inherited Members

- Protected Attributes inherited from ns3::ndn::Consumer
UniformVariable m_rand
 nonce generator
 
uint32_t m_seq
 currently requested sequence number
 
uint32_t m_seqMax
 maximum number of sequence number
 
EventId m_sendEvent
 EventId of pending "send packet" event.
 
Time m_retxTimer
 Currently estimated retransmission timer.
 
EventId m_retxEvent
 Event to check whether or not retransmission should be performed.
 
Ptr< RttEstimator > m_rtt
 RTT estimator.
 
Time m_offTime
 Time interval between packets.
 
Name m_interestName
 NDN Name of the Interest (use Name)
 
Time m_interestLifeTime
 LifeTime for interest packet.
 
- Protected Attributes inherited from ns3::ndn::App
bool m_active
 Flag to indicate that application is active (set by StartApplication and StopApplication)
 
Ptr< Face > m_face
 automatically created application face through which application communicates
 
TracedCallback< Ptr< const
Interest >, Ptr< App >, Ptr
< Face > > 		m_receivedInterests
 App-level trace of received Interests.
 
TracedCallback< Ptr< const
Interest >, Ptr< App >, Ptr
< Face > > 		m_receivedNacks
 App-level trace of received NACKs.
 
TracedCallback< Ptr< const
Data >, Ptr< App >, Ptr< Face > > 		m_receivedDatas
 App-level trace of received Data.
 
TracedCallback< Ptr< const
Interest >, Ptr< App >, Ptr
< Face > > 		m_transmittedInterests
 App-level trace of transmitted Interests.
 
TracedCallback< Ptr< const
Data >, Ptr< App >, Ptr< Face > > 		m_transmittedDatas
 App-level trace of transmitted Data.
 

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

  • WindowTrace: Window that controls how many outstanding interests are allowed
  • InFlight: Current number of outstanding interests

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

  • 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
  • ReceivedNacks: ReceivedNacks
  • ReceivedDatas: ReceivedDatas
  • TransmittedInterests: TransmittedInterests
  • TransmittedDatas: TransmittedDatas

Definition at line 38 of file ndn-consumer-window.h.

Member Function Documentation

void ns3::ndn::ConsumerWindow::OnData ( Ptr< const Data >  contentObject)
virtual

Method that will be called every time new Data arrives.

Parameters
contentObjectData header
payloadpayload (potentially virtual) of the Data packet (may include packet tags of original packet)

Reimplemented from ns3::ndn::Consumer.

Definition at line 189 of file ndn-consumer-window.cc.

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

void ns3::ndn::ConsumerWindow::OnNack ( Ptr< const Interest >  interest)
virtual

Method that will be called every time new NACK arrives.

Parameters
interestInterest header

Reimplemented from ns3::ndn::Consumer.

Definition at line 202 of file ndn-consumer-window.cc.

References ns3::ndn::Consumer::OnNack(), and ScheduleNextPacket().

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

Timeout event.

Parameters
sequenceNumbertime outed sequence number

Reimplemented from ns3::ndn::Consumer.

Definition at line 220 of file ndn-consumer-window.cc.

References ns3::ndn::Consumer::OnTimeout().

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 235 of file ndn-consumer-window.cc.

References ns3::ndn::Consumer::WillSendOutInterest().

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