Botan::Zlib_Decompression Class Reference

#include <zlib.h>

Inheritance diagram for Botan::Zlib_Decompression:

Public Member Functions
virtual bool	attachable ()
void	end_msg ()
std::string	name () const
void	start_msg ()
void	write (const byte input[], size_t length)
	Zlib_Decompression ()
	~Zlib_Decompression ()

Protected Member Functions
void	send (byte in)
void	send (const byte in[], size_t length)
void	send (const MemoryRegion< byte > &in)
void	send (const MemoryRegion< byte > &in, size_t length)

Detailed Description

Zlib Decompression Filter

Definition at line 50 of file zlib.h.

Constructor & Destructor Documentation

Zlib_Decompression()

Botan::Zlib_Decompression::Zlib_Decompression

(

)

Definition at line 188 of file zlib.cpp.

                                       : buffer(DEFAULT_BUFFERSIZE)
   {
   zlib = 0;
   no_writes = true;
   }

~Zlib_Decompression()

Botan::Zlib_Decompression::~Zlib_Decompression ( )

inline

Definition at line 60 of file zlib.h.

{ clear(); }

Member Function Documentation

attachable()

virtual bool Botan::Filter::attachable ( )

inlinevirtualinherited

Check whether this filter is an attachable filter.

Returns

true if this filter is attachable, false otherwise

Reimplemented in Botan::DataSink, and Botan::SecureQueue.

Definition at line 50 of file filter.h.

{ return true; }

end_msg()

void Botan::Zlib_Decompression::end_msg ( )

virtual

Notify that the current message is finished; flush buffers and do end-of-message processing (if any).

Reimplemented from Botan::Filter.

Definition at line 257 of file zlib.cpp.

   {
   if(no_writes) return;
   zlib->stream.next_in = 0;
   zlib->stream.avail_in = 0;
 
   int rc = Z_OK;
 
   while(rc != Z_STREAM_END)
      {
      zlib->stream.next_out = reinterpret_cast<Bytef*>(buffer.begin());
      zlib->stream.avail_out = buffer.size();
      rc = inflate(&(zlib->stream), Z_SYNC_FLUSH);
 
      if(rc != Z_OK && rc != Z_STREAM_END)
         {
         clear();
         throw Decoding_Error("Zlib_Decompression: Error finalizing");
         }
 
      send(buffer.begin(), buffer.size() - zlib->stream.avail_out);
      }
 
   clear();
   }

References Botan::Decoding_Error::Decoding_Error(), and Botan::Filter::send().

name()

std::string Botan::Zlib_Decompression::name ( ) const

inlinevirtual

Returns

descriptive name for this filter

Implements Botan::Filter.

Definition at line 53 of file zlib.h.

{ return "Zlib_Decompression"; }

send() [1/4]

void Botan::Filter::send ( byte in )

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 63 of file filter.h.

{ send(&in, 1); }

References send().

Referenced by send().

send() [2/4]

void Botan::Filter::send ( const byte in[], size_t length )

protectedinherited

Parameters

in	some input for the filter
length	the length of in

Definition at line 28 of file filter.cpp.

   {
   bool nothing_attached = true;
   for(size_t j = 0; j != total_ports(); ++j)
      if(next[j])
         {
         if(write_queue.size())
            next[j]->write(&write_queue[0], write_queue.size());
         next[j]->write(input, length);
         nothing_attached = false;
         }
 
   if(nothing_attached)
      write_queue += std::make_pair(input, length);
   else
      write_queue.clear();
   }

Referenced by Botan::Base64_Decoder::end_msg(), Botan::Base64_Encoder::end_msg(), Botan::Bzip_Compression::end_msg(), Botan::Bzip_Decompression::end_msg(), Botan::Hash_Filter::end_msg(), Botan::Hex_Decoder::end_msg(), Botan::Hex_Encoder::end_msg(), Botan::MAC_Filter::end_msg(), Botan::PK_Decryptor_Filter::end_msg(), Botan::PK_Encryptor_Filter::end_msg(), Botan::PK_Signer_Filter::end_msg(), Botan::PK_Verifier_Filter::end_msg(), Botan::Zlib_Compression::end_msg(), Botan::Zlib_Decompression::end_msg(), Botan::Bzip_Compression::flush(), Botan::Zlib_Compression::flush(), send(), Botan::Base64_Decoder::write(), Botan::Bzip_Compression::write(), Botan::Bzip_Decompression::write(), Botan::Chain::write(), Botan::Fork::write(), Botan::Hex_Decoder::write(), Botan::StreamCipher_Filter::write(), Botan::Zlib_Compression::write(), and Botan::Zlib_Decompression::write().

send() [3/4]

void Botan::Filter::send ( const MemoryRegion< byte > & in )

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 68 of file filter.h.

{ send(&in[0], in.size()); }

References send(), and Botan::MemoryRegion< T >::size().

Referenced by send().

send() [4/4]

void Botan::Filter::send ( const MemoryRegion< byte > & in, size_t length )

inlineprotectedinherited

Parameters

in	some input for the filter
length	the number of bytes of in to send

Definition at line 74 of file filter.h.

         {
         send(&in[0], length);
         }

References send().

start_msg()

void Botan::Zlib_Decompression::start_msg ( )

virtual

Start a new message. Must be closed by end_msg() before another message can be started.

Reimplemented from Botan::Filter.

Definition at line 197 of file zlib.cpp.

   {
   clear();
   zlib = new Zlib_Stream;
   if(inflateInit(&(zlib->stream)) != Z_OK)
      throw Memory_Exhaustion();
   }

Referenced by write().

write()

void Botan::Zlib_Decompression::write ( const byte input[], size_t length )

virtual

Write a portion of a message to this filter.

Parameters

input	the input as a byte array
length	the length of the byte array input

Implements Botan::Filter.

Definition at line 208 of file zlib.cpp.

   {
   if(length) no_writes = false;
 
   // non-const needed by zlib api :(
   Bytef* input = reinterpret_cast<Bytef*>(const_cast<byte*>(input_arr));
 
   zlib->stream.next_in = input;
   zlib->stream.avail_in = length;
 
   while(zlib->stream.avail_in != 0)
      {
      zlib->stream.next_out = reinterpret_cast<Bytef*>(buffer.begin());
      zlib->stream.avail_out = buffer.size();
 
      int rc = inflate(&(zlib->stream), Z_SYNC_FLUSH);
 
      if(rc != Z_OK && rc != Z_STREAM_END)
         {
         clear();
         if(rc == Z_DATA_ERROR)
            throw Decoding_Error("Zlib_Decompression: Data integrity error");
         else if(rc == Z_NEED_DICT)
            throw Decoding_Error("Zlib_Decompression: Need preset dictionary");
         else if(rc == Z_MEM_ERROR)
            throw Memory_Exhaustion();
         else
            throw std::runtime_error("Zlib decompression: Unknown error");
         }
 
      send(buffer.begin(), buffer.size() - zlib->stream.avail_out);
 
      if(rc == Z_STREAM_END)
         {
         size_t read_from_block = length - zlib->stream.avail_in;
         start_msg();
 
         zlib->stream.next_in = input + read_from_block;
         zlib->stream.avail_in = length - read_from_block;
 
         input += read_from_block;
         length -= read_from_block;
         }
      }
   }

References Botan::Decoding_Error::Decoding_Error(), Botan::Filter::send(), and start_msg().

---

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

• src/filters/zlib/zlib.h
• src/filters/zlib/zlib.cpp