Botan::Chain Class Reference

#include <filters.h>

Inheritance diagram for Botan::Chain:

Public Member Functions
virtual bool	attachable ()
BOTAN_FUTURE_EXPLICIT	Chain (Filter *f1=nullptr, Filter *f2=nullptr, Filter *f3=nullptr, Filter *f4=nullptr)
	Chain (Filter *filter_arr[], size_t length)
virtual void	end_msg ()
std::string	name () const override
virtual void	start_msg ()
void	write (const uint8_t input[], size_t length) override

Protected Member Functions
void	attach (Filter *f)
void	incr_owns ()
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)
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 634 of file filters.h.

Constructor & Destructor Documentation

Chain() [1/2]

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 14 of file basefilt.cpp.

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

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

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 36 of file basefilt.cpp.

                                            {
   for(size_t j = 0; j != count; ++j) {
      if(filters[j] != nullptr) {
         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 158 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 54 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::DataSink_Stream, Botan::Hex_Decoder, and Botan::Hex_Encoder.

Definition at line 47 of file filter.h.

                             { /* default empty */
      }

incr_owns()

void Botan::Fanout_Filter::incr_owns ( )

inlineprotectedinherited

Increment the number of filters past us that we own

Definition at line 152 of file filter.h.

{ ++m_filter_owns; }

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

name()

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

inlineoverridevirtual

Returns

descriptive name for this filter

Implements Botan::Filter.

Definition at line 638 of file filters.h.

{ return "Chain"; }

send() [1/4]

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

protectedvirtualinherited

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 )

inlineprotectedinherited

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 )

protectedinherited

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 )

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 73 of file filter.h.

{ send(&in, 1); }

References send().

Referenced by send().

set_next()

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

inlineprotectedinherited

Definition at line 156 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 154 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.

Definition at line 40 of file filter.h.

                               { /* default empty */
      }

write()

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

inlineoverridevirtual

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 636 of file filters.h.

{ send(input, length); }

References Botan::Filter::send().

---

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

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