Botan::Filter Class Reference

#include <filter.h>

Inheritance diagram for Botan::Filter:

Public Member Functions
virtual bool	attachable ()
virtual void	end_msg ()
	Filter (const Filter &)=delete
	Filter (Filter &&)=delete
virtual std::string	name () const =0
Filter &	operator= (const Filter &)=delete
Filter &	operator= (Filter &&)=delete
virtual void	start_msg ()
virtual void	write (const uint8_t input[], size_t length)=0
virtual	~Filter ()=default

Protected Member Functions
	Filter ()
virtual void	send (const uint8_t in[], size_t length)
void	send (std::span< const uint8_t > in)
void	send (std::span< const uint8_t > in, size_t length)
void	send (uint8_t in)

Friends
class	Fanout_Filter
class	Pipe
class	Threaded_Fork

Detailed Description

This class represents general abstract filter objects.

Definition at line 22 of file filter.h.

Constructor & Destructor Documentation

~Filter()

virtual Botan::Filter::~Filter ( )

virtualdefault

Filter() [1/3]

Botan::Filter::Filter ( const Filter & )

delete

References Filter().

Referenced by Botan::Fanout_Filter::attach(), Filter(), Filter(), operator=(), operator=(), and Botan::Fanout_Filter::set_next().

Filter() [2/3]

Botan::Filter::Filter ( Filter && )

delete

References Filter().

Filter() [3/3]

Botan::Filter::Filter ( )

protected

Definition at line 18 of file filter.cpp.

               {
   m_next.resize(1);
}

Member Function Documentation

attachable()

virtual bool Botan::Filter::attachable ( )

inlinevirtual

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 54 of file filter.h.

{ return true; }

end_msg()

virtual void Botan::Filter::end_msg ( )

inlinevirtual

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::DataSink_Stream, Botan::Hex_Decoder, and Botan::Hex_Encoder.

Definition at line 47 of file filter.h.

                             { /* default empty */
      }

name()

virtual std::string Botan::Filter::name ( ) const

pure virtual

Returns

descriptive name for this filter

Implemented in Botan::Base64_Decoder, Botan::Base64_Encoder, Botan::BitBucket, Botan::Chain, Botan::Cipher_Mode_Filter, Botan::DataSink_Stream, Botan::Fork, Botan::Hex_Decoder, Botan::Hex_Encoder, and Botan::SecureQueue.

Referenced by Botan::Keyed_Filter::set_iv().

operator=() [1/2]

Filter & Botan::Filter::operator= ( const Filter & )

delete

References Filter().

operator=() [2/2]

Filter & Botan::Filter::operator= ( Filter && )

delete

References Filter(), and send().

send() [1/4]

void Botan::Filter::send ( const uint8_t in[], size_t length )

protectedvirtual

Parameters

in	some input for the filter
length	the length of in

Definition at line 30 of file filter.cpp.

                                                      {
   if(length == 0) {
      return;
   }
 
   bool nothing_attached = true;
   for(size_t j = 0; j != total_ports(); ++j) {
      if(m_next[j] != nullptr) {
         if(!m_write_queue.empty()) {
            m_next[j]->write(m_write_queue.data(), m_write_queue.size());
         }
         m_next[j]->write(input, length);
         nothing_attached = false;
      }
   }
 
   if(nothing_attached) {
      m_write_queue += std::make_pair(input, length);
   } else {
      m_write_queue.clear();
   }
}

Referenced by Botan::Base64_Decoder::end_msg(), Botan::Base64_Encoder::end_msg(), Botan::Hex_Decoder::end_msg(), Botan::Hex_Encoder::end_msg(), operator=(), send(), Botan::Base64_Decoder::write(), Botan::Chain::write(), Botan::Fork::write(), and Botan::Hex_Decoder::write().

send() [2/4]

void Botan::Filter::send ( std::span< const uint8_t > in )

inlineprotected

Parameters

in	some input for the filter

Definition at line 78 of file filter.h.

{ send(in.data(), in.size()); }

References send().

Referenced by send().

send() [3/4]

void Botan::Filter::send ( std::span< const uint8_t > in, size_t length )

protected

Parameters

in	some input for the filter
length	the number of bytes of in to send

This previously took a std::vector, for which the length field (allowing using just a prefix of the vector) somewhat made sense. It makes less sense now that we are using a span here; you can just use first to get a prefix.

Definition at line 22 of file filter.cpp.

                                                          {
   BOTAN_ASSERT_NOMSG(length <= in.size());
   send(in.data(), length);
}

References BOTAN_ASSERT_NOMSG, and send().

send() [4/4]

void Botan::Filter::send ( uint8_t in )

inlineprotected

Parameters

in	some input for the filter

Definition at line 73 of file filter.h.

{ send(&in, 1); }

References send().

Referenced by send().

start_msg()

virtual void Botan::Filter::start_msg ( )

inlinevirtual

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

Definition at line 40 of file filter.h.

                               { /* default empty */
      }

write()

virtual void Botan::Filter::write ( const uint8_t input[], size_t length )

pure virtual

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

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

Friends And Related Symbol Documentation

Fanout_Filter

friend class Fanout_Filter

friend

Definition at line 107 of file filter.h.

References Fanout_Filter.

Referenced by Fanout_Filter.

Pipe

friend class Pipe

friend

Definition at line 106 of file filter.h.

References Pipe.

Referenced by Pipe.

Threaded_Fork

friend class Threaded_Fork

friend

Definition at line 108 of file filter.h.

References Threaded_Fork.

Referenced by Threaded_Fork.

---

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

• src/lib/filters/filter.h
• src/lib/filters/filter.cpp