IFS::FWFS::IBlockEncoder Class Referenceabstract

Virtual base class to support (file) data encryption and compression. More...

#include <BlockEncoder.h>

Inheritance diagram for IFS::FWFS::IBlockEncoder:
[legend]

Public Member Functions

virtual ~IBlockEncoder ()
 
virtual IDataSourceStreamgetNextStream ()=0
 

Detailed Description

Virtual base class to support (file) data encryption and compression.

Encryption and compression are typically done in blocks of a fixed size. To support these operations an instance of this class is created which encodes data one block at a time. Each block is stored separately and the resulting file consists of a chain of these blocks. This is natively supported by FWFS.

If the final data size is known in advance then the implementation will return just a single data stream.

Constructor & Destructor Documentation

◆ ~IBlockEncoder()

virtual IFS::FWFS::IBlockEncoder::~IBlockEncoder ( )
inlinevirtual

Member Function Documentation

◆ getNextStream()

virtual IDataSourceStream* IFS::FWFS::IBlockEncoder::getNextStream ( )
pure virtual

this method and return nullptr when all blocks have been encoded.

The stream returned must know it's size (i.e. available() must not return -1). The encoder owns any stream objects created so is responsible for destroying them when finished. This allows them to be re-used if appropriate.

Implemented in IFS::FWFS::BasicEncoder.


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