ndn::security::transform::Base64Encode Class Reference

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

#include <base64-encode.hpp>

Inheritance diagram for ndn::security::transform::Base64Encode:

Collaboration diagram for ndn::security::transform::Base64Encode:

Classes
class	Impl

Public Member Functions
	Base64Encode (bool needBreak=true)
	Create a base64 encoding module. More...
	~Base64Encode () final
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...
Downstream *	getNext ()
Protected Member Functions inherited from ndn::security::transform::Downstream
	Downstream ()=default
Protected Attributes inherited from ndn::security::transform::Upstream
unique_ptr< Downstream >	m_next

Detailed Description

The module to perform Base64 encoding transformation.

Definition at line 34 of file base64-encode.hpp.

Constructor & Destructor Documentation

Base64Encode()

ndn::security::transform::Base64Encode::Base64Encode ( bool  needBreak = true )

explicit

Create a base64 encoding module.

Parameters

needBreak

if true, insert newline after every 64 bytes, otherwise no newline is inserted

Definition at line 51 of file base64-encode.cpp.

References ndn::security::transform::Transform::flushOutputBuffer(), ndn::security::transform::Downstream::getIndex(), ndn::security::transform::Transform::isOutputBufferEmpty(), nonstd::optional_lite::std11::move(), NDN_THROW, ndn::security::transform::Transform::setOutputBuffer(), and ~Base64Encode().

~Base64Encode()

ndn::security::transform::Base64Encode::~Base64Encode ( )

finaldefault

Referenced by Base64Encode().

---

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

• ndnSIM/ndn-cxx/ndn-cxx/security/transform/base64-encode.hpp
• ndnSIM/ndn-cxx/ndn-cxx/security/transform/base64-encode.cpp