NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
ndn::InMemoryStorageEntry Class Reference

Represents an in-memory storage entry. More...

#include <in-memory-storage-entry.hpp>

Inheritance diagram for ndn::InMemoryStorageEntry:
Collaboration diagram for ndn::InMemoryStorageEntry:

Public Member Functions

 InMemoryStorageEntry ()
 Create an entry. More...
 
void release ()
 Releases reference counts on shared objects. More...
 
const NamegetName () const
 Returns the name of the Data packet stored in the in-memory storage entry. More...
 
const NamegetFullName () const
 Returns the full name (including implicit digest) of the Data packet stored in the in-memory storage entry. More...
 
const DatagetData () const
 Returns the Data packet stored in the in-memory storage entry. More...
 
void setData (const Data &data)
 Changes the content of in-memory storage entry. More...
 
void setMarkStaleEventId (unique_ptr< util::scheduler::ScopedEventId > eventId)
 Set eventId for the markStale event. More...
 
void markStale ()
 Disable the data from satisfying interest with MustBeFresh. More...
 
bool isFresh ()
 Check if the data can satisfy an interest with MustBeFresh. More...
 

Detailed Description

Represents an in-memory storage entry.

Definition at line 33 of file in-memory-storage-entry.hpp.

Constructor & Destructor Documentation

◆ InMemoryStorageEntry()

ndn::InMemoryStorageEntry::InMemoryStorageEntry ( )

Create an entry.

Definition at line 26 of file in-memory-storage-entry.cpp.

Member Function Documentation

◆ release()

void ndn::InMemoryStorageEntry::release ( )

Releases reference counts on shared objects.

Definition at line 32 of file in-memory-storage-entry.cpp.

◆ getName()

const Name& ndn::InMemoryStorageEntry::getName ( ) const
inline

Returns the name of the Data packet stored in the in-memory storage entry.

Definition at line 48 of file in-memory-storage-entry.hpp.

◆ getFullName()

const Name& ndn::InMemoryStorageEntry::getFullName ( ) const
inline

Returns the full name (including implicit digest) of the Data packet stored in the in-memory storage entry.

Definition at line 57 of file in-memory-storage-entry.hpp.

◆ getData()

const Data& ndn::InMemoryStorageEntry::getData ( ) const
inline

Returns the Data packet stored in the in-memory storage entry.

Definition at line 65 of file in-memory-storage-entry.hpp.

Referenced by ndn::InMemoryStorage::find().

◆ setData()

void ndn::InMemoryStorageEntry::setData ( const Data data)

Changes the content of in-memory storage entry.

This method also allows data to satisfy Interest with MustBeFresh

Definition at line 39 of file in-memory-storage-entry.cpp.

◆ setMarkStaleEventId()

void ndn::InMemoryStorageEntry::setMarkStaleEventId ( unique_ptr< util::scheduler::ScopedEventId eventId)

Set eventId for the markStale event.

Definition at line 46 of file in-memory-storage-entry.cpp.

◆ markStale()

void ndn::InMemoryStorageEntry::markStale ( )

Disable the data from satisfying interest with MustBeFresh.

Definition at line 52 of file in-memory-storage-entry.cpp.

Referenced by ndn::InMemoryStorage::insert().

◆ isFresh()

bool ndn::InMemoryStorageEntry::isFresh ( )
inline

Check if the data can satisfy an interest with MustBeFresh.

Definition at line 90 of file in-memory-storage-entry.hpp.


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