Botan 3.8.1
Crypto and TLS for C&
Botan::Filter Class Referenceabstract

#include <filter.h>

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

Public Member Functions

virtual bool attachable ()
 
virtual void end_msg ()
 
 Filter (const Filter &)=delete
 
virtual std::string name () const =0
 
Filteroperator= (const 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/2]

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

◆ Filter() [2/2]

Botan::Filter::Filter ( )
protected

Definition at line 18 of file filter.cpp.

18 {
19 m_next.resize(1);
20 m_port_num = 0;
21 m_filter_owns = 0;
22 m_owned = false;
23}

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.

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

47 { /* default empty */
48 }

◆ name()

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

◆ operator=()

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

References Filter(), and send().

◆ send() [1/4]

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

Definition at line 33 of file filter.cpp.

33 {
34 if(!length) {
35 return;
36 }
37
38 bool nothing_attached = true;
39 for(size_t j = 0; j != total_ports(); ++j) {
40 if(m_next[j]) {
41 if(!m_write_queue.empty()) {
42 m_next[j]->write(m_write_queue.data(), m_write_queue.size());
43 }
44 m_next[j]->write(input, length);
45 nothing_attached = false;
46 }
47 }
48
49 if(nothing_attached) {
50 m_write_queue += std::make_pair(input, length);
51 } else {
52 m_write_queue.clear();
53 }
54}

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
insome input for the filter

Definition at line 76 of file filter.h.

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

References send().

Referenced by send().

◆ send() [3/4]

void Botan::Filter::send ( std::span< const uint8_t > in,
size_t length )
protected
Parameters
insome input for the filter
lengththe 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 25 of file filter.cpp.

25 {
26 BOTAN_ASSERT_NOMSG(length <= in.size());
27 send(in.data(), length);
28}
#define BOTAN_ASSERT_NOMSG(expr)
Definition assert.h:61

References BOTAN_ASSERT_NOMSG, and send().

◆ send() [4/4]

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

Definition at line 71 of file filter.h.

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

40 { /* default empty */
41 }

◆ 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
inputthe input as a byte array
lengththe 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 105 of file filter.h.

References Fanout_Filter.

Referenced by Fanout_Filter.

◆ Pipe

friend class Pipe
friend

Definition at line 104 of file filter.h.

References Pipe.

Referenced by Pipe.

◆ Threaded_Fork

friend class Threaded_Fork
friend

Definition at line 106 of file filter.h.

References Threaded_Fork.

Referenced by Threaded_Fork.


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