Botan::Stream_Compression Class Reference

#include <compression.h>

Inheritance diagram for Botan::Stream_Compression:

Public Member Functions
void	clear () finaloverride
void	finish (secure_vector< uint8_t > &buf, size_t offset) finaloverride
virtual std::string	name () const =0
void	update (secure_vector< uint8_t > &buf, size_t offset, bool flush) finaloverride

Detailed Description

Used to implement compression using Compression_Stream

Definition at line 132 of file compression.h.

Member Function Documentation

void Botan::Stream_Compression::clear ( )

finaloverridevirtual

Reset the state and abort the current message; start can be called again to process a new message.

Implements Botan::Compression_Algorithm.

Definition at line 55 of file compress_utils.cpp.

Referenced by finish().

   {
   m_stream.reset();
   }

void Botan::Stream_Compression::finish ( secure_vector< uint8_t > &  final_block, size_t  offset  )

finaloverridevirtual

Finish compressing

Parameters

final_block	in/out parameter
offset	an offset into final_block to begin processing

Implements Botan::Compression_Algorithm.

Definition at line 111 of file compress_utils.cpp.

References BOTAN_ASSERT, and clear().

   {
   BOTAN_ASSERT(m_stream, "Initialized");
   process(buf, offset, m_stream->finish_flag());
   clear();
   }

virtual std::string Botan::Compression_Algorithm::name ( ) const

pure virtualinherited

Returns

name of the compression algorithm

Implemented in Botan::Gzip_Compression, Botan::Deflate_Compression, Botan::LZMA_Compression, Botan::Bzip2_Compression, and Botan::Zlib_Compression.

void Botan::Stream_Compression::update ( secure_vector< uint8_t > &  buf, size_t  offset, bool  flush  )

finaloverridevirtual

Process some data. Input must be in size update_granularity() uint8_t blocks.

Parameters

buf	in/out parameter which will possibly be resized or swapped
offset	an offset into blocks to begin processing
flush	if true the compressor will be told to flush state

Implements Botan::Compression_Algorithm.

Definition at line 105 of file compress_utils.cpp.

References BOTAN_ASSERT.

   {
   BOTAN_ASSERT(m_stream, "Initialized");
   process(buf, offset, flush ? m_stream->flush_flag() : m_stream->run_flag());
   }

---

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

• src/lib/compression/compression.h
• src/lib/compression/compress_utils.cpp