NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.3: NDN, CCN, CCNx, content centric networks
API Documentation
ndn::security::transform::Source Class Referenceabstract

Abstraction of the transformation source module. More...

#include <transform-base.hpp>

Inheritance diagram for ndn::security::transform::Source:
Collaboration diagram for ndn::security::transform::Source:

Public Member Functions

Sourceoperator>> (unique_ptr< Transform > transform)
 Connect to an intermediate transformation module. More...
 
void operator>> (unique_ptr< Sink > sink)
 Connect to the last transformation module. More...
 
- Public Member Functions inherited from ndn::security::transform::Upstream
virtual ~Upstream ()=default
 

Protected Member Functions

 Source ()
 
void pump ()
 Pump all data into next transformation module. More...
 
size_t getIndex () const
 Get the source module index (should always be 0). More...
 
- Protected Member Functions inherited from ndn::security::transform::Upstream
 Upstream ()
 
void appendChain (unique_ptr< Downstream > tail)
 connect to next transformation module More...
 
DownstreamgetNext ()
 

Additional Inherited Members

- Protected Attributes inherited from ndn::security::transform::Upstream
unique_ptr< Downstreamm_next
 

Detailed Description

Abstraction of the transformation source module.

This module can only accept input data from constructor

Definition at line 288 of file transform-base.hpp.

Constructor & Destructor Documentation

◆ Source()

ndn::security::transform::Source::Source ( )
protected

Definition at line 154 of file transform-base.cpp.

Member Function Documentation

◆ operator>>() [1/2]

Source & ndn::security::transform::Source::operator>> ( unique_ptr< Transform transform)

Connect to an intermediate transformation module.

Definition at line 166 of file transform-base.cpp.

References ndn::security::transform::Upstream::appendChain().

◆ operator>>() [2/2]

void ndn::security::transform::Source::operator>> ( unique_ptr< Sink sink)

Connect to the last transformation module.

This method will trigger the source to pump data into the transformation pipeline.

Definition at line 176 of file transform-base.cpp.

References ndn::security::transform::Upstream::appendChain(), and pump().

◆ pump()

void ndn::security::transform::Source::pump ( )
protected

Pump all data into next transformation module.

Definition at line 160 of file transform-base.cpp.

Referenced by operator>>().

◆ getIndex()

size_t ndn::security::transform::Source::getIndex ( ) const
inlineprotected

Get the source module index (should always be 0).

Definition at line 319 of file transform-base.hpp.

Referenced by ndn::security::transform::StreamSource::StreamSource().


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