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

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

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

Inheritance diagram for ndn::util::InMemoryStorageEntry:
Collaboration diagram for ndn::util::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< 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 35 of file in-memory-storage-entry.hpp.

Constructor & Destructor Documentation

◆ InMemoryStorageEntry()

ndn::util::InMemoryStorageEntry::InMemoryStorageEntry ( )

Create an entry.

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

Member Function Documentation

◆ release()

void ndn::util::InMemoryStorageEntry::release ( )

Releases reference counts on shared objects.

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

◆ getName()

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

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

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

◆ getFullName()

const Name& ndn::util::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 60 of file in-memory-storage-entry.hpp.

◆ getData()

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

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

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

References markStale(), setData(), and setMarkStaleEventId().

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

◆ setData()

void ndn::util::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 40 of file in-memory-storage-entry.cpp.

Referenced by getData().

◆ setMarkStaleEventId()

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

Set eventId for the markStale event.

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

Referenced by getData().

◆ markStale()

void ndn::util::InMemoryStorageEntry::markStale ( )

Disable the data from satisfying interest with MustBeFresh.

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

Referenced by getData(), and ndn::util::InMemoryStorage::insert().

◆ isFresh()

bool ndn::util::InMemoryStorageEntry::isFresh ( )
inline

Check if the data can satisfy an interest with MustBeFresh.

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


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