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

#include <basefilt.h>

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

List of all members.

Public Member Functions

virtual bool attachable ()
 Chain (Filter *=nullptr, Filter *=nullptr, Filter *=nullptr, Filter *=nullptr)
 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 ()
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)
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 33 of file basefilt.h.


Constructor & Destructor Documentation

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

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

   {
   if(f1) { attach(f1); incr_owns(); }
   if(f2) { attach(f2); incr_owns(); }
   if(f3) { attach(f3); incr_owns(); }
   if(f4) { attach(f4); incr_owns(); }
   }
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().

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

Member Function Documentation

void Botan::Fanout_Filter::attach ( Filter f) [inline, protected, inherited]

Attach another filter to this one

Parameters:
ffilter to attach

Reimplemented from Botan::Filter.

Definition at line 164 of file filter.h.

Referenced by Chain().

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; }
virtual void Botan::Filter::end_msg ( ) [inline, virtual, inherited]

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

Reimplemented in Botan::MAC_Filter, Botan::Hash_Filter, Botan::Base64_Decoder, Botan::Hex_Decoder, Botan::Base64_Encoder, Botan::Hex_Encoder, and Botan::Compression_Decompression_Filter.

Definition at line 46 of file filter.h.

{}
void Botan::Fanout_Filter::incr_owns ( ) [inline, protected, inherited]

Increment the number of filters past us that we own

Definition at line 158 of file filter.h.

Referenced by Chain().

{ ++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.

   {
   return "Chain";
   }
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::Fanout_Filter::set_next ( Filter filters[],
size_t  count 
) [inline, protected, inherited]
Parameters:
filtersthe filters to set
countnumber of items in filters

Reimplemented from Botan::Filter.

Reimplemented in Botan::Threaded_Fork.

Definition at line 162 of file filter.h.

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

void Botan::Fanout_Filter::set_port ( size_t  new_port) [inline, protected, inherited]

Set the active port

Parameters:
new_portthe new value

Reimplemented from Botan::Filter.

Reimplemented in Botan::Fork.

Definition at line 160 of file filter.h.

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

virtual void Botan::Filter::start_msg ( ) [inline, virtual, inherited]

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

Reimplemented in Botan::Compression_Decompression_Filter.

Definition at line 40 of file filter.h.

{}
void Botan::Chain::write ( const byte  input[],
size_t  length 
) [inline, 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 36 of file basefilt.h.

{ send(input, length); }

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