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

The module to perform hexadecimal encoding transformation. More...

#include <hex-encode.hpp>

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

Public Member Functions

 HexEncode (bool useUpperCase=false)
 Create a hex encoding module. More...
 
- 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...
 

Additional Inherited Members

- Protected Types inherited from ndn::security::transform::Transform
using OBuffer = std::vector< uint8_t >
 
- Protected Member Functions inherited from ndn::security::transform::Transform
 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
 
- Protected Attributes inherited from ndn::security::transform::Upstream
unique_ptr< Downstreamm_next
 

Detailed Description

The module to perform hexadecimal encoding transformation.

For example, if the input is a byte stream 0x01, 0x23, 0x45, the output will be a string "012345".

Definition at line 37 of file hex-encode.hpp.

Constructor & Destructor Documentation

◆ HexEncode()

ndn::security::transform::HexEncode::HexEncode ( bool  useUpperCase = false)
explicit

Create a hex encoding module.

Parameters
useUpperCaseif true, use upper case letters, otherwise lower case

Definition at line 41 of file hex-encode.cpp.

References ndn::security::transform::H2CL, ndn::security::transform::H2CU, and ndn::security::transform::Transform::setOutputBuffer().


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