ns3::ndn::fw::BestRoute::PerOutFaceLimits Class Reference

Strategy implementing per-out-face limits on top of BestRoute strategy. More...

#include <introspected-doxygen.h>

Inheritance diagram for ns3::ndn::fw::BestRoute::PerOutFaceLimits:

Collaboration diagram for ns3::ndn::fw::BestRoute::PerOutFaceLimits:

Classes
class	PerFibLimits
	Strategy implementing per-fib-per-out-face limits on top of BestRoute strategy. More...

Additional Inherited Members
Public Member Functions inherited from ns3::ndn::fw::PerOutFaceLimits< BestRoute >
	PerOutFaceLimits ()
	Default constructor.
virtual void	WillEraseTimedOutPendingInterest (Ptr< pit::Entry > pitEntry)
virtual void	AddFace (Ptr< Face > face)
Public Member Functions inherited from ns3::ndn::fw::BestRoute
	BestRoute ()
	Default constructor.
virtual bool	DoPropagateInterest (Ptr< Face > incomingFace, Ptr< const Interest > interest, Ptr< pit::Entry > pitEntry)
	Virtual method to perform Interest propagation according to the forwarding strategy logic. More...
Public Member Functions inherited from ns3::ndn::fw::Nacks
virtual void	OnInterest (Ptr< Face > face, Ptr< Interest > interest)
	Actual processing of incoming Ndn interests. More...
Public Member Functions inherited from ns3::ndn::ForwardingStrategy
	ForwardingStrategy ()
	Default constructor.
virtual void	OnData (Ptr< Face > face, Ptr< Data > data)
	Actual processing of incoming Ndn content objects. More...
virtual void	RemoveFace (Ptr< Face > face)
	Event fired every time face is removed from NDN stack. More...
virtual void	DidAddFibEntry (Ptr< fib::Entry > fibEntry)
	Event fired every time a FIB entry is added to FIB. More...
virtual void	WillRemoveFibEntry (Ptr< fib::Entry > fibEntry)
	Fired just before FIB entry will be removed from FIB. More...
Static Public Member Functions inherited from ns3::ndn::fw::PerOutFaceLimits< BestRoute >
static TypeId	GetTypeId ()
	Get TypeId of the class.
static std::string	GetLogName ()
	Helper function to retrieve logging name for the forwarding strategy.
Static Public Member Functions inherited from ns3::ndn::fw::BestRoute
static TypeId	GetTypeId ()
static std::string	GetLogName ()
	Helper function to retrieve logging name for the forwarding strategy.
Static Public Member Functions inherited from ns3::ndn::fw::GreenYellowRed
static TypeId	GetTypeId (void)
Static Public Member Functions inherited from ns3::ndn::fw::Nacks
static TypeId	GetTypeId ()
Static Public Member Functions inherited from ns3::ndn::ForwardingStrategy
static TypeId	GetTypeId ()
static std::string	GetLogName ()
	Helper function to retrieve logging name for the forwarding strategy.
Protected Member Functions inherited from ns3::ndn::fw::PerOutFaceLimits< BestRoute >
virtual bool	CanSendOutInterest (Ptr< Face > inFace, Ptr< Face > outFace, Ptr< const Interest > interest, Ptr< pit::Entry > pitEntry)
virtual void	WillSatisfyPendingInterest (Ptr< Face > inFace, Ptr< pit::Entry > pitEntry)
Protected Member Functions inherited from ns3::ndn::fw::GreenYellowRed
virtual void	DidReceiveValidNack (Ptr< Face > incomingFace, uint32_t nackCode, Ptr< const Interest > nack, Ptr< pit::Entry > pitEntry)
Protected Member Functions inherited from ns3::ndn::fw::Nacks
virtual void	DidReceiveDuplicateInterest (Ptr< Face > inFace, Ptr< const Interest > interest, Ptr< pit::Entry > pitEntry)
	An event that is fired every time a duplicated Interest is received. More...
virtual void	DidExhaustForwardingOptions (Ptr< Face > inFace, Ptr< const Interest > interest, Ptr< pit::Entry > pitEntry)
	An even that is fired when Interest cannot be forwarded. More...
virtual void	OnNack (Ptr< Face > inFace, Ptr< Interest > nack)
Protected Member Functions inherited from ns3::ndn::ForwardingStrategy
virtual void	DidCreatePitEntry (Ptr< Face > inFace, Ptr< const Interest > interest, Ptr< pit::Entry > pitEntry)
	An event that is fired every time a new PIT entry is created. More...
virtual void	FailedToCreatePitEntry (Ptr< Face > inFace, Ptr< const Interest > interest)
	An event that is fired every time a new PIT entry cannot be created (e.g., PIT container imposes a limit) More...
virtual void	DidSuppressSimilarInterest (Ptr< Face > inFace, Ptr< const Interest > interest, Ptr< pit::Entry > pitEntry)
	An event that is fired every time when a similar Interest is received and suppressed (collapsed) More...
virtual void	DidForwardSimilarInterest (Ptr< Face > inFace, Ptr< const Interest > interest, Ptr< pit::Entry > pitEntry)
	An event that is fired every time when a similar Interest is received and further forwarded (not suppressed/collapsed) More...
virtual bool	DetectRetransmittedInterest (Ptr< Face > inFace, Ptr< const Interest > interest, Ptr< pit::Entry > pitEntry)
	Method that implements logic to distinguish between new and retransmitted interest. More...
virtual void	SatisfyPendingInterest (Ptr< Face > inFace, Ptr< const Data > data, Ptr< pit::Entry > pitEntry)
	Actual procedure to satisfy Interest. More...
virtual void	DidSendOutData (Ptr< Face > inFace, Ptr< Face > outFace, Ptr< const Data > data, Ptr< pit::Entry > pitEntry)
	Event which is fired just after data was send out on the face. More...
virtual void	DidReceiveSolicitedData (Ptr< Face > inFace, Ptr< const Data > data, bool didCreateCacheEntry)
	Event which is fired every time a requested (solicited) DATA packet (there is an active PIT entry) is received. More...
virtual void	DidReceiveUnsolicitedData (Ptr< Face > inFace, Ptr< const Data > data, bool didCreateCacheEntry)
	Event which is fired every time an unsolicited DATA packet (no active PIT entry) is received. More...
virtual bool	ShouldSuppressIncomingInterest (Ptr< Face > inFace, Ptr< const Interest > interest, Ptr< pit::Entry > pitEntry)
	Method implementing logic to suppress (collapse) similar Interests. More...
virtual bool	TrySendOutInterest (Ptr< Face > inFace, Ptr< Face > outFace, Ptr< const Interest > interest, Ptr< pit::Entry > pitEntry)
	Method implementing actual interest forwarding, taking into account CanSendOutInterest decision. More...
virtual void	DidSendOutInterest (Ptr< Face > inFace, Ptr< Face > outFace, Ptr< const Interest > interest, Ptr< pit::Entry > pitEntry)
	Event fired just after forwarding the Interest. More...
virtual void	PropagateInterest (Ptr< Face > inFace, Ptr< const Interest > interest, Ptr< pit::Entry > pitEntry)
	Wrapper method, which performs general tasks and calls DoPropagateInterest method. More...
virtual void	NotifyNewAggregate ()
	Even when object is aggregated to another Object.
virtual void	DoDispose ()
	Do cleanup.
Protected Attributes inherited from ns3::ndn::fw::Nacks
bool	m_nacksEnabled
TracedCallback< Ptr< const Interest >, Ptr< const Face > >	m_outNacks
	trace of outgoing NACKs
TracedCallback< Ptr< const Interest >, Ptr< const Face > >	m_inNacks
	trace of incoming NACKs
TracedCallback< Ptr< const Interest >, Ptr< const Face > >	m_dropNacks
	trace of dropped NACKs
Protected Attributes inherited from ns3::ndn::ForwardingStrategy
Ptr< Pit >	m_pit
	Reference to PIT to which this forwarding strategy is associated.
Ptr< Fib >	m_fib
	FIB.
Ptr< ContentStore >	m_contentStore
	Content store (for caching purposes only)
bool	m_cacheUnsolicitedDataFromApps
bool	m_cacheUnsolicitedData
bool	m_detectRetransmissions
TracedCallback< Ptr< const Interest >, Ptr< const Face > >	m_outInterests
	Transmitted interests trace.
TracedCallback< Ptr< const Interest >, Ptr< const Face > >	m_inInterests
	trace of incoming Interests
TracedCallback< Ptr< const Interest >, Ptr< const Face > >	m_dropInterests
	trace of dropped Interests
TracedCallback< Ptr< const Data >, bool, Ptr< const Face > >	m_outData
	trace of outgoing Data
TracedCallback< Ptr< const Data >, Ptr< const Face > >	m_inData
	trace of incoming Data
TracedCallback< Ptr< const Data >, Ptr< const Face > >	m_dropData
	trace of dropped Data
TracedCallback< Ptr< const pit::Entry > >	m_satisfiedInterests
TracedCallback< Ptr< const pit::Entry > >	m_timedOutInterests
Static Protected Attributes inherited from ns3::ndn::fw::PerOutFaceLimits< BestRoute >
static LogComponent	g_log
	Logging variable.
Static Protected Attributes inherited from ns3::ndn::fw::BestRoute
static LogComponent	g_log = LogComponent (BestRoute::GetLogName ().c_str ())

Detailed Description

Strategy implementing per-out-face limits on top of BestRoute strategy.

Doxygen introspection did not find any typical Config paths.

Attributes

• Limit: Limit type to be used (e.g., ns3::ndn::Limits::Window or ns3::ndn::Limits::Rate)
  • Set with class: StringValue
  • Underlying type:
  • Initial value: ns3::ndn::Limits::Window
  • Flags: construct write read

Attributes defined in parent class ns3::ndn::fw::Nacks

• EnableNACKs: Enabling support of NACKs
  • Set with class: BooleanValue
  • Underlying type: bool
  • Initial value: false
  • Flags: construct write read

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

• CacheUnsolicitedDataFromApps: Cache unsolicited data that has been pushed from applications
  • Set with class: BooleanValue
  • Underlying type: bool
  • Initial value: true
  • Flags: construct write read
• CacheUnsolicitedData: Cache overheard data that have not been requested
  • Set with class: BooleanValue
  • Underlying type: bool
  • Initial value: false
  • Flags: construct write read
• DetectRetransmissions: If non-duplicate interest is received on the same face more than once, it is considered a retransmission
  • Set with class: BooleanValue
  • Underlying type: bool
  • Initial value: true
  • Flags: construct write read

No TraceSources are defined for this type.

TraceSources defined in parent class ns3::ndn::fw::Nacks

• OutNacks: OutNacks
• InNacks: InNacks
• DropNacks: DropNacks

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

• OutInterests: OutInterests
• InInterests: InInterests
• DropInterests: DropInterests
• OutData: OutData
• InData: InData
• DropData: DropData
• SatisfiedInterests: SatisfiedInterests
• TimedOutInterests: TimedOutInterests

Definition at line 51 of file per-out-face-limits.cc.

---

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

• ndnSIM/model/fw/per-out-face-limits.cc