Botan::Chain Class Reference

#include <basefilt.h>

Inheritance diagram for Botan::Chain:

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 (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)
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

Chain() [1/2]

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.

   {
   if(f1) { attach(f1); incr_owns(); }
   if(f2) { attach(f2); incr_owns(); }
   if(f3) { attach(f3); incr_owns(); }
   if(f4) { attach(f4); incr_owns(); }
   }

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

Referenced by Botan::PGP_decode(), and Botan::PGP_encode().

Chain() [2/2]

Botan::Chain::Chain	(	Filter *	filter_arr[],
		size_t	length )

Construct a chain from range of filters

Parameters

filter_arr	the list of filters
length	how many filters

Definition at line 33 of file basefilt.cpp.

   {
   for(size_t j = 0; j != count; ++j)
      if(filters[j])
         {
         attach(filters[j]);
         incr_owns();
         }
   }

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

Member Function Documentation

attach()

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

inlineprotectedinherited

Definition at line 146 of file filter.h.

{ Filter::attach(f); }

References Botan::Filter::Filter().

Referenced by Botan::Chain::Chain(), and Botan::Chain::Chain().

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()

virtual void Botan::Filter::end_msg ( )

inlinevirtualinherited

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

Reimplemented in Botan::Base64_Decoder, Botan::Base64_Encoder, Botan::Bzip_Compression, Botan::Bzip_Decompression, Botan::Hash_Filter, Botan::Hex_Decoder, Botan::Hex_Encoder, Botan::MAC_Filter, Botan::PBE_PKCS5v15, Botan::PBE_PKCS5v20, Botan::PK_Decryptor_Filter, Botan::PK_Encryptor_Filter, Botan::PK_Signer_Filter, Botan::PK_Verifier_Filter, Botan::Zlib_Compression, and Botan::Zlib_Decompression.

Definition at line 44 of file filter.h.

{}

incr_owns()

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.

{ ++filter_owns; }

Referenced by Botan::Chain::Chain(), and Botan::Chain::Chain().

name()

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

virtual

Returns

descriptive name for this filter

Implements Botan::Filter.

Definition at line 43 of file basefilt.cpp.

   {
   return "Chain";
   }

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().

set_next()

void Botan::Fanout_Filter::set_next ( Filter * f[], size_t n )

inlineprotectedinherited

Definition at line 144 of file filter.h.

{ Filter::set_next(f, n); }

References Botan::Filter::Filter().

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

set_port()

void Botan::Fanout_Filter::set_port ( size_t n )

inlineprotectedinherited

Definition at line 142 of file filter.h.

{ Filter::set_port(n); }

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

start_msg()

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::Bzip_Compression, Botan::Bzip_Decompression, Botan::EAX_Base, Botan::PBE_PKCS5v15, Botan::PBE_PKCS5v20, Botan::Zlib_Compression, and Botan::Zlib_Decompression.

Definition at line 38 of file filter.h.

{}

write()

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

inlinevirtual

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

{ send(input, length); }

References Botan::Filter::send().

---

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

• src/filters/basefilt.h
• src/filters/basefilt.cpp