Botan  1.11.15
Public Member Functions | Protected Member Functions
Botan::Decompression_Filter Class Reference

#include <comp_filter.h>

Inheritance diagram for Botan::Decompression_Filter:
Botan::Compression_Decompression_Filter Botan::Filter

List of all members.

Public Member Functions

virtual bool attachable ()
 Decompression_Filter (const std::string &type)
void end_msg () override
std::string name () const override
void start_msg () override
void write (const byte input[], size_t input_length) override

Protected Member Functions

void flush ()
virtual void send (const byte in[], size_t length)
void send (byte in)
void send (const secure_vector< byte > &in)
void send (const std::vector< byte > &in)
void send (const secure_vector< byte > &in, size_t length)
void send (const std::vector< byte > &in, size_t length)

Detailed Description

Definition at line 47 of file comp_filter.h.


Constructor & Destructor Documentation

Definition at line 18 of file comp_filter.cpp.


Member Function Documentation

virtual bool Botan::Filter::attachable ( ) [inline, virtual, inherited]

Check whether this filter is an attachable filter.

Returns:
true if this filter is attachable, false otherwise

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

Definition at line 52 of file filter.h.

{ return true; }
void Botan::Compression_Decompression_Filter::end_msg ( ) [override, virtual, inherited]

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

Reimplemented from Botan::Filter.

Definition at line 63 of file comp_filter.cpp.

References Botan::Filter::send().

   {
   m_buffer.clear();
   m_transform->finish(m_buffer);
   send(m_buffer);
   }
void Botan::Compression_Decompression_Filter::flush ( ) [protected, inherited]

Definition at line 56 of file comp_filter.cpp.

References Botan::Filter::send().

   {
   m_buffer.clear();
   m_transform->flush(m_buffer);
   send(m_buffer);
   }
std::string Botan::Compression_Decompression_Filter::name ( ) const [override, virtual, inherited]
Returns:
descriptive name for this filter

Implements Botan::Filter.

Definition at line 30 of file comp_filter.cpp.

   {
   return m_transform->name();
   }
void Botan::Filter::send ( const byte  in[],
size_t  length 
) [protected, virtual, inherited]
Parameters:
insome input for the filter
lengththe length of in

Reimplemented in Botan::Threaded_Fork.

Definition at line 28 of file filter.cpp.

References Botan::Filter::write().

Referenced by Botan::Compression_Decompression_Filter::end_msg(), Botan::Hex_Encoder::end_msg(), Botan::Base64_Encoder::end_msg(), Botan::Hex_Decoder::end_msg(), Botan::Base64_Decoder::end_msg(), Botan::Hash_Filter::end_msg(), Botan::MAC_Filter::end_msg(), Botan::Compression_Decompression_Filter::flush(), Botan::Compression_Decompression_Filter::start_msg(), Botan::Compression_Decompression_Filter::write(), Botan::StreamCipher_Filter::write(), Botan::Hex_Decoder::write(), and Botan::Base64_Decoder::write().

   {
   if(!length)
      return;

   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();
   }
void Botan::Filter::send ( byte  in) [inline, protected, inherited]
Parameters:
insome input for the filter

Definition at line 65 of file filter.h.

References Botan::Filter::send().

Referenced by Botan::Filter::send().

{ send(&in, 1); }
void Botan::Filter::send ( const secure_vector< byte > &  in) [inline, protected, inherited]
Parameters:
insome input for the filter

Definition at line 70 of file filter.h.

References Botan::Filter::send().

Referenced by Botan::Filter::send().

{ send(&in[0], in.size()); }
void Botan::Filter::send ( const std::vector< byte > &  in) [inline, protected, inherited]
Parameters:
insome input for the filter

Definition at line 75 of file filter.h.

References Botan::Filter::send().

Referenced by Botan::Filter::send().

{ send(&in[0], in.size()); }
void Botan::Filter::send ( const secure_vector< byte > &  in,
size_t  length 
) [inline, protected, inherited]
Parameters:
insome input for the filter
lengththe number of bytes of in to send

Definition at line 81 of file filter.h.

         {
         send(&in[0], length);
         }
void Botan::Filter::send ( const std::vector< byte > &  in,
size_t  length 
) [inline, protected, inherited]
Parameters:
insome input for the filter
lengththe number of bytes of in to send

Definition at line 90 of file filter.h.

         {
         send(&in[0], length);
         }
void Botan::Compression_Decompression_Filter::start_msg ( ) [override, virtual, inherited]

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

Reimplemented from Botan::Filter.

Definition at line 35 of file comp_filter.cpp.

References Botan::Filter::send().

   {
   send(m_transform->start());
   }
void Botan::Compression_Decompression_Filter::write ( const byte  input[],
size_t  length 
) [override, virtual, inherited]

Write a portion of a message to this filter.

Parameters:
inputthe input as a byte array
lengththe length of the byte array input

Implements Botan::Filter.

Definition at line 40 of file comp_filter.cpp.

References Botan::Filter::send().

   {
   while(input_length)
      {
      const size_t take = std::min<size_t>({4096, m_buffer.capacity(), input_length});

      m_buffer.assign(input, input + take);
      m_transform->update(m_buffer);

      send(m_buffer);

      input += take;
      input_length -= take;
      }
   }

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