Botan  1.10.9
Public Member Functions | Protected Member Functions | List of all members
Botan::Chain Class Reference

#include <basefilt.h>

Inheritance diagram for Botan::Chain:
Botan::Fanout_Filter Botan::Filter

Public Member Functions

virtual bool attachable ()
 
 Chain (Filter *=0, Filter *=0, Filter *=0, Filter *=0)
 
 Chain (Filter *filter_arr[], size_t length)
 
virtual void end_msg ()
 
std::string name () const
 
virtual void start_msg ()
 
void write (const byte input[], size_t length)
 

Protected Member Functions

void attach (Filter *f)
 
void incr_owns ()
 
void send (const byte in[], size_t length)
 
void send (byte in)
 
void send (const MemoryRegion< byte > &in)
 
void send (const MemoryRegion< byte > &in, size_t length)
 
void set_next (Filter *f[], size_t n)
 
void set_port (size_t n)
 

Detailed Description

This class represents Filter chains. A Filter chain is an ordered concatenation of Filters, the input to a Chain sequentially passes through all the Filters contained in the Chain.

Definition at line 31 of file basefilt.h.

Constructor & Destructor Documentation

Botan::Chain::Chain ( Filter f1 = 0,
Filter f2 = 0,
Filter f3 = 0,
Filter f4 = 0 
)

Construct a chain of up to four filters. The filters are set up in the same order as the arguments.

Definition at line 22 of file basefilt.cpp.

References Botan::Fanout_Filter::attach(), and Botan::Fanout_Filter::incr_owns().

23  {
24  if(f1) { attach(f1); incr_owns(); }
25  if(f2) { attach(f2); incr_owns(); }
26  if(f3) { attach(f3); incr_owns(); }
27  if(f4) { attach(f4); incr_owns(); }
28  }
void attach(Filter *f)
Definition: filter.h:146
Botan::Chain::Chain ( Filter filter_arr[],
size_t  length 
)

Construct a chain from range of filters

Parameters
filter_arrthe list of filters
lengthhow many filters

Definition at line 33 of file basefilt.cpp.

References Botan::Fanout_Filter::attach(), and Botan::Fanout_Filter::incr_owns().

34  {
35  for(size_t j = 0; j != count; ++j)
36  if(filters[j])
37  {
38  attach(filters[j]);
39  incr_owns();
40  }
41  }
void attach(Filter *f)
Definition: filter.h:146

Member Function Documentation

void Botan::Fanout_Filter::attach ( Filter f)
inlineprotectedinherited

Definition at line 146 of file filter.h.

Referenced by Chain().

146 { Filter::attach(f); }
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 50 of file filter.h.

50 { return true; }
virtual void Botan::Filter::end_msg ( )
inlinevirtualinherited
void Botan::Fanout_Filter::incr_owns ( )
inlineprotectedinherited

Increment the number of filters past us that we own

Definition at line 140 of file filter.h.

Referenced by Chain().

140 { ++filter_owns; }
std::string Botan::Chain::name ( ) const
virtual
Returns
descriptive name for this filter

Implements Botan::Filter.

Definition at line 43 of file basefilt.cpp.

44  {
45  return "Chain";
46  }
void Botan::Filter::send ( const byte  in[],
size_t  length 
)
protectedinherited
Parameters
insome input for the filter
lengththe length of in

Definition at line 28 of file filter.cpp.

References Botan::MemoryRegion< T >::clear(), Botan::MemoryRegion< T >::size(), and Botan::Filter::write().

Referenced by Botan::PK_Encryptor_Filter::end_msg(), Botan::Zlib_Compression::end_msg(), Botan::Bzip_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::Zlib_Decompression::end_msg(), Botan::PK_Signer_Filter::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(), Botan::Zlib_Compression::flush(), Botan::Bzip_Compression::write(), Botan::Zlib_Compression::write(), Botan::StreamCipher_Filter::write(), Botan::Bzip_Decompression::write(), Botan::Zlib_Decompression::write(), Botan::Hex_Decoder::write(), and Botan::Base64_Decoder::write().

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

Definition at line 63 of file filter.h.

References Botan::Filter::send().

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

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

Definition at line 68 of file filter.h.

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

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

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

Definition at line 74 of file filter.h.

75  {
76  send(&in[0], length);
77  }
void send(const byte in[], size_t length)
Definition: filter.cpp:28
void Botan::Fanout_Filter::set_next ( Filter f[],
size_t  n 
)
inlineprotectedinherited

Definition at line 144 of file filter.h.

Referenced by Botan::Fork::Fork(), and Botan::SecureQueue::SecureQueue().

144 { Filter::set_next(f, n); }
BigInt n
Definition: numthry.cpp:26
void Botan::Fanout_Filter::set_port ( size_t  n)
inlineprotectedinherited

Definition at line 142 of file filter.h.

Referenced by Botan::Fork::set_port().

142 { Filter::set_port(n); }
BigInt n
Definition: numthry.cpp:26
virtual void Botan::Filter::start_msg ( )
inlinevirtualinherited

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

Reimplemented in Botan::Zlib_Decompression, Botan::EAX_Base, Botan::Bzip_Decompression, Botan::PBE_PKCS5v20, Botan::PBE_PKCS5v15, Botan::Bzip_Compression, and Botan::Zlib_Compression.

Definition at line 38 of file filter.h.

38 {}
void Botan::Chain::write ( const byte  input[],
size_t  length 
)
inlinevirtual

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 34 of file basefilt.h.

34 { send(input, length); }
void send(const byte in[], size_t length)
Definition: filter.cpp:28

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