Botan  2.7.0
Crypto and TLS for C++11
Public Member Functions | Protected Member Functions | List of all members
Botan::Chain Class Referencefinal

#include <basefilt.h>

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

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 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 (uint8_t in)
 
void send (const secure_vector< uint8_t > &in)
 
void send (const std::vector< uint8_t > &in)
 
void send (const secure_vector< uint8_t > &in, size_t length)
 
void send (const std::vector< uint8_t > &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 37 of file basefilt.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 22 of file basefilt.cpp.

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

23  {
24  if(f1) { attach(f1); incr_owns(); }
25  if(f2) { attach(f2); incr_owns(); }
26  if(f3) { attach(f3); incr_owns(); }
27  if(f4) { attach(f4); incr_owns(); }
28  }
void attach(Filter *f)
Definition: filter.h:164

◆ Chain() [2/2]

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

34  {
35  for(size_t j = 0; j != count; ++j)
36  if(filters[j])
37  {
38  attach(filters[j]);
39  incr_owns();
40  }
41  }
void attach(Filter *f)
Definition: filter.h:164

Member Function Documentation

◆ attach()

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

Definition at line 164 of file filter.h.

Referenced by Chain().

164 { Filter::attach(f); }

◆ 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::SecureQueue, and Botan::DataSink.

Definition at line 52 of file filter.h.

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

Definition at line 46 of file filter.h.

46 { /* default empty */ }

◆ incr_owns()

void Botan::Fanout_Filter::incr_owns ( )
inlineprotectedinherited

Increment the number of filters past us that we own

Definition at line 158 of file filter.h.

Referenced by Chain().

158 { ++m_filter_owns; }

◆ name()

std::string Botan::Chain::name ( ) const
overridevirtual
Returns
descriptive name for this filter

Implements Botan::Filter.

Definition at line 43 of file basefilt.cpp.

44  {
45  return "Chain";
46  }

◆ send() [1/6]

void Botan::Filter::send ( const uint8_t  in[],
size_t  length 
)
protectedvirtualinherited
Parameters
insome input for the filter
lengththe length of in

Definition at line 27 of file filter.cpp.

References Botan::Filter::write().

Referenced by Botan::Hex_Encoder::end_msg(), Botan::Base64_Encoder::end_msg(), Botan::Hex_Decoder::end_msg(), Botan::Base64_Decoder::end_msg(), Botan::Hex_Decoder::write(), and Botan::Base64_Decoder::write().

28  {
29  if(!length)
30  return;
31 
32  bool nothing_attached = true;
33  for(size_t j = 0; j != total_ports(); ++j)
34  if(m_next[j])
35  {
36  if(m_write_queue.size())
37  m_next[j]->write(m_write_queue.data(), m_write_queue.size());
38  m_next[j]->write(input, length);
39  nothing_attached = false;
40  }
41 
42  if(nothing_attached)
43  m_write_queue += std::make_pair(input, length);
44  else
45  m_write_queue.clear();
46  }
virtual void write(const uint8_t input[], size_t length)=0

◆ send() [2/6]

void Botan::Filter::send ( uint8_t  in)
inlineprotectedinherited
Parameters
insome input for the filter

Definition at line 65 of file filter.h.

References Botan::Filter::send().

Referenced by Botan::Filter::send().

65 { send(&in, 1); }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27

◆ send() [3/6]

void Botan::Filter::send ( const secure_vector< uint8_t > &  in)
inlineprotectedinherited
Parameters
insome input for the filter

Definition at line 70 of file filter.h.

References Botan::Filter::send().

Referenced by Botan::Filter::send().

70 { send(in.data(), in.size()); }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27

◆ send() [4/6]

void Botan::Filter::send ( const std::vector< uint8_t > &  in)
inlineprotectedinherited
Parameters
insome input for the filter

Definition at line 75 of file filter.h.

References Botan::Filter::send().

Referenced by Botan::Filter::send().

75 { send(in.data(), in.size()); }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27

◆ send() [5/6]

void Botan::Filter::send ( const secure_vector< uint8_t > &  in,
size_t  length 
)
inlineprotectedinherited
Parameters
insome input for the filter
lengththe number of bytes of in to send

Definition at line 81 of file filter.h.

82  {
83  send(in.data(), length);
84  }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27

◆ send() [6/6]

void Botan::Filter::send ( const std::vector< uint8_t > &  in,
size_t  length 
)
inlineprotectedinherited
Parameters
insome input for the filter
lengththe number of bytes of in to send

Definition at line 90 of file filter.h.

91  {
92  send(in.data(), length);
93  }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27

◆ set_next()

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

Definition at line 162 of file filter.h.

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

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

◆ set_port()

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

Definition at line 160 of file filter.h.

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

160 { Filter::set_port(n); }

◆ 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.

40 { /* 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
inputthe input as a byte array
lengththe length of the byte array input

Implements Botan::Filter.

Definition at line 40 of file basefilt.h.

40 { send(input, length); }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27

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