Botan  1.11.15
Public Member Functions | Protected Member Functions | Friends
Botan::Filter Class Reference

#include <filter.h>

Inheritance diagram for Botan::Filter:
Botan::Base64_Decoder Botan::Base64_Encoder Botan::BitBucket Botan::Compression_Decompression_Filter Botan::DataSink Botan::Fanout_Filter Botan::Hash_Filter Botan::Hex_Decoder Botan::Hex_Encoder Botan::Keyed_Filter

List of all members.

Public Member Functions

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

Protected Member Functions

 Filter ()
 Filter (const Filter &)
Filteroperator= (const Filter &)
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)

Friends

class Fanout_Filter
class Pipe

Detailed Description

This class represents general abstract filter objects.

Definition at line 21 of file filter.h.


Constructor & Destructor Documentation

virtual Botan::Filter::~Filter ( ) [inline, virtual]

Definition at line 54 of file filter.h.

{}
Botan::Filter::Filter ( ) [protected]

Definition at line 17 of file filter.cpp.

   {
   next.resize(1);
   port_num = 0;
   filter_owns = 0;
   owned = false;
   }
Botan::Filter::Filter ( const Filter ) [protected]

Member Function Documentation

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

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]

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.

{}
virtual std::string Botan::Filter::name ( ) const [pure virtual]
Filter& Botan::Filter::operator= ( const Filter ) [protected]
void Botan::Filter::send ( const byte  in[],
size_t  length 
) [protected, virtual]
Parameters:
insome input for the filter
lengththe length of in

Reimplemented in Botan::Threaded_Fork.

Definition at line 28 of file filter.cpp.

References 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]
Parameters:
insome input for the filter

Definition at line 65 of file filter.h.

References send().

Referenced by send().

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

Definition at line 70 of file filter.h.

References send().

Referenced by send().

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

Definition at line 75 of file filter.h.

References send().

Referenced by send().

{ send(&in[0], in.size()); }
void Botan::Filter::send ( const secure_vector< byte > &  in,
size_t  length 
) [inline, protected]
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]
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);
         }
virtual void Botan::Filter::start_msg ( ) [inline, virtual]

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.

{}
virtual void Botan::Filter::write ( const byte  input[],
size_t  length 
) [pure virtual]

Write a portion of a message to this filter.

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

Implemented in Botan::MAC_Filter, Botan::Hash_Filter, Botan::Base64_Decoder, Botan::Hex_Decoder, Botan::Fork, Botan::StreamCipher_Filter, Botan::DataSink_Stream, Botan::Chain, Botan::Hex_Encoder, Botan::Base64_Encoder, Botan::Compression_Decompression_Filter, Botan::SecureQueue, and Botan::BitBucket.

Referenced by send(), and Botan::Pipe::write().


Friends And Related Function Documentation

friend class Fanout_Filter [friend]

Definition at line 115 of file filter.h.

friend class Pipe [friend]

Definition at line 114 of file filter.h.


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