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

Abstraction of an intermediate transformation module. More...

#include <transform-base.hpp>

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

Protected Types

using OBuffer = std::vector< uint8_t >
 

Protected Member Functions

 Transform ()=default
 
void flushOutputBuffer ()
 Read the content from output buffer and write it into next module. More...
 
void flushAllOutput ()
 Read the all the content from output buffer and write it into next module. More...
 
void setOutputBuffer (unique_ptr< OBuffer > buffer)
 Set output buffer to buffer. More...
 
bool isOutputBufferEmpty () const
 Check if output buffer is empty. More...
 
- Protected Member Functions inherited from ndn::security::transform::Upstream
 Upstream ()=default
 
void appendChain (unique_ptr< Downstream > tail)
 Connect to the next transformation module. More...
 
DownstreamgetNext ()
 
- Protected Member Functions inherited from ndn::security::transform::Downstream
 Downstream ()=default
 

Additional Inherited Members

- Public Member Functions inherited from ndn::security::transform::Upstream
virtual ~Upstream ()=default
 
- Public Member Functions inherited from ndn::security::transform::Downstream
virtual ~Downstream ()=default
 
size_t write (span< const uint8_t > buf)
 Accept input data and perform transformation. More...
 
void end ()
 Close the input interface of a module. More...
 
bool isEnd () const
 Check if the input interface of a module is closed. More...
 
void setIndex (size_t index)
 Set the module index. More...
 
size_t getIndex () const
 Get the module index. More...
 
- Protected Attributes inherited from ndn::security::transform::Upstream
unique_ptr< Downstreamm_next
 

Detailed Description

Abstraction of an intermediate transformation module.

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

Member Typedef Documentation

◆ OBuffer

using ndn::security::transform::Transform::OBuffer = std::vector<uint8_t>
protected

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

Constructor & Destructor Documentation

◆ Transform()

ndn::security::transform::Transform::Transform ( )
protecteddefault

Member Function Documentation

◆ flushOutputBuffer()

void ndn::security::transform::Transform::flushOutputBuffer ( )
protected

Read the content from output buffer and write it into next module.

It is not guaranteed that all the content in output buffer will be flushed to next module.

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

Referenced by ndn::security::transform::Base64Decode::Base64Decode(), ndn::security::transform::Base64Encode::Base64Encode(), and ndn::security::transform::BlockCipher::BlockCipher().

◆ flushAllOutput()

void ndn::security::transform::Transform::flushAllOutput ( )
protected

Read the all the content from output buffer and write it into next module.

Postcondition
isOutputBufferEmpty() returns true.

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

Referenced by ndn::security::transform::DigestFilter::DigestFilter(), ndn::security::transform::SignerFilter::SignerFilter(), and ndn::security::transform::VerifierFilter::VerifierFilter().

◆ setOutputBuffer()

◆ isOutputBufferEmpty()

bool ndn::security::transform::Transform::isOutputBufferEmpty ( ) const
protected

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