Botan  1.11.10
Public Member Functions | Protected Member Functions | List of all members
Botan::Zlib_Compression Class Reference

#include <zlib.h>

Inheritance diagram for Botan::Zlib_Compression:
Botan::Filter

Public Member Functions

virtual bool attachable ()
 
void end_msg ()
 
void flush ()
 
std::string name () const
 
void start_msg ()
 
void write (const byte input[], size_t length)
 
 Zlib_Compression (size_t level=6, bool raw_deflate=false)
 
 ~Zlib_Compression ()
 

Protected Member Functions

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

Zlib Compression Filter

Definition at line 19 of file zlib.h.

Constructor & Destructor Documentation

Botan::Zlib_Compression::Zlib_Compression ( size_t  level = 6,
bool  raw_deflate = false 
)
Parameters
levelhow much effort to use on compressing (0 to 9); higher levels are slower but tend to give better compression
raw_deflateif true no zlib header/trailer will be used

Definition at line 97 of file zlib.cpp.

97  :
98  level((l >= 9) ? 9 : l),
99  raw_deflate(raw_deflate),
100  buffer(DEFAULT_BUFFERSIZE),
101  zlib(0)
102  {
103  }
Botan::Zlib_Compression::~Zlib_Compression ( )
inline

Definition at line 42 of file zlib.h.

42 { clear(); }

Member Function Documentation

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::SecureQueue, and Botan::DataSink.

Definition at line 52 of file filter.h.

52 { return true; }
void Botan::Zlib_Compression::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 146 of file zlib.cpp.

References Botan::Filter::send().

147  {
148  zlib->stream.next_in = 0;
149  zlib->stream.avail_in = 0;
150 
151  int rc = Z_OK;
152  while(rc != Z_STREAM_END)
153  {
154  zlib->stream.next_out = reinterpret_cast<Bytef*>(&buffer[0]);
155  zlib->stream.avail_out = buffer.size();
156 
157  rc = deflate(&(zlib->stream), Z_FINISH);
158  send(&buffer[0], buffer.size() - zlib->stream.avail_out);
159  }
160 
161  clear();
162  }
virtual void send(const byte in[], size_t length)
Definition: filter.cpp:28
void Botan::Zlib_Compression::flush ( )

Flush the compressor

Definition at line 167 of file zlib.cpp.

References Botan::Filter::send().

168  {
169  zlib->stream.next_in = 0;
170  zlib->stream.avail_in = 0;
171 
172  while(true)
173  {
174  zlib->stream.avail_out = buffer.size();
175  zlib->stream.next_out = reinterpret_cast<Bytef*>(&buffer[0]);
176 
177  deflate(&(zlib->stream), Z_FULL_FLUSH);
178  send(&buffer[0], buffer.size() - zlib->stream.avail_out);
179 
180  if(zlib->stream.avail_out == buffer.size())
181  break;
182  }
183  }
virtual void send(const byte in[], size_t length)
Definition: filter.cpp:28
std::string Botan::Zlib_Compression::name ( ) const
inlinevirtual
Returns
descriptive name for this filter

Implements Botan::Filter.

Definition at line 22 of file zlib.h.

22 { return "Zlib_Compression"; }
void Botan::Filter::send ( const byte  in[],
size_t  length 
)
protectedvirtualinherited
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::PK_Encryptor_Filter::end_msg(), end_msg(), Botan::Bzip_Compression::end_msg(), Botan::Lzma_Compression::end_msg(), Botan::Hex_Encoder::end_msg(), Botan::Base64_Encoder::end_msg(), Botan::PK_Decryptor_Filter::end_msg(), Botan::Bzip_Decompression::end_msg(), Botan::PK_Signer_Filter::end_msg(), Botan::Lzma_Decompression::end_msg(), Botan::Zlib_Decompression::end_msg(), Botan::Hex_Decoder::end_msg(), Botan::Base64_Decoder::end_msg(), Botan::PK_Verifier_Filter::end_msg(), Botan::Hash_Filter::end_msg(), Botan::MAC_Filter::end_msg(), Botan::Bzip_Compression::flush(), flush(), Botan::Lzma_Compression::flush(), Botan::Bzip_Compression::write(), write(), Botan::Lzma_Compression::write(), Botan::StreamCipher_Filter::write(), Botan::Bzip_Decompression::write(), Botan::Lzma_Decompression::write(), Botan::Zlib_Decompression::write(), Botan::Hex_Decoder::write(), and Botan::Base64_Decoder::write().

29  {
30  if(!length)
31  return;
32 
33  bool nothing_attached = true;
34  for(size_t j = 0; j != total_ports(); ++j)
35  if(next[j])
36  {
37  if(write_queue.size())
38  next[j]->write(&write_queue[0], write_queue.size());
39  next[j]->write(input, length);
40  nothing_attached = false;
41  }
42 
43  if(nothing_attached)
44  write_queue += std::make_pair(input, length);
45  else
46  write_queue.clear();
47  }
virtual void write(const byte input[], size_t length)=0
void Botan::Filter::send ( byte  in)
inlineprotectedinherited
Parameters
insome input for the filter

Definition at line 65 of file filter.h.

References Botan::Filter::send().

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

65 { send(&in, 1); }
virtual void send(const byte in[], size_t length)
Definition: filter.cpp:28
void Botan::Filter::send ( const secure_vector< byte > &  in)
inlineprotectedinherited
Parameters
insome input for the filter

Definition at line 70 of file filter.h.

References Botan::Filter::send().

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

70 { send(&in[0], in.size()); }
virtual void send(const byte in[], size_t length)
Definition: filter.cpp:28
void Botan::Filter::send ( const std::vector< byte > &  in)
inlineprotectedinherited
Parameters
insome input for the filter

Definition at line 75 of file filter.h.

References Botan::Filter::send().

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

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

Definition at line 81 of file filter.h.

82  {
83  send(&in[0], length);
84  }
virtual void send(const byte in[], size_t length)
Definition: filter.cpp:28
void Botan::Filter::send ( const std::vector< byte > &  in,
size_t  length 
)
inlineprotectedinherited
Parameters
insome input for the filter
lengththe number of bytes of in to send

Definition at line 90 of file filter.h.

91  {
92  send(&in[0], length);
93  }
virtual void send(const byte in[], size_t length)
Definition: filter.cpp:28
void Botan::Zlib_Compression::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 108 of file zlib.cpp.

109  {
110  clear();
111  zlib = new Zlib_Stream;
112 
113  int res = deflateInit2(&(zlib->stream),
114  level,
115  Z_DEFLATED,
116  (raw_deflate ? -15 : 15),
117  8,
118  Z_DEFAULT_STRATEGY);
119 
120  if(res == Z_STREAM_ERROR)
121  throw Invalid_Argument("Bad setting in deflateInit2");
122  else if(res != Z_OK)
123  throw Memory_Exhaustion();
124  }
std::invalid_argument Invalid_Argument
Definition: exceptn.h:20
void Botan::Zlib_Compression::write ( const byte  input[],
size_t  length 
)
virtual

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 129 of file zlib.cpp.

References Botan::Filter::send().

130  {
131  zlib->stream.next_in = static_cast<Bytef*>(const_cast<byte*>(input));
132  zlib->stream.avail_in = length;
133 
134  while(zlib->stream.avail_in != 0)
135  {
136  zlib->stream.next_out = static_cast<Bytef*>(&buffer[0]);
137  zlib->stream.avail_out = buffer.size();
138  deflate(&(zlib->stream), Z_NO_FLUSH);
139  send(&buffer[0], buffer.size() - zlib->stream.avail_out);
140  }
141  }
virtual void send(const byte in[], size_t length)
Definition: filter.cpp:28
uint8_t byte
Definition: types.h:30

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