Botan  2.8.0
Crypto and TLS for C++11
Public Member Functions | Protected Member Functions | Friends | List of all members
Botan::Fanout_Filter Class Referenceabstract

#include <filter.h>

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

Public Member Functions

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

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)
 
template<typename Alloc >
void send (const std::vector< uint8_t, Alloc > &in)
 
template<typename Alloc >
void send (const std::vector< uint8_t, Alloc > &in, size_t length)
 
void set_next (Filter *f[], size_t n)
 
void set_port (size_t n)
 

Friends

class Threaded_Fork
 

Detailed Description

This is the abstract Fanout_Filter base class.

Definition at line 144 of file filter.h.

Member Function Documentation

◆ attach()

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

Definition at line 156 of file filter.h.

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

156 { 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 ( )
inlineprotected

Increment the number of filters past us that we own

Definition at line 150 of file filter.h.

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

150 { ++m_filter_owns; }

◆ name()

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

◆ send() [1/4]

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/4]

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/4]

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

Definition at line 71 of file filter.h.

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

◆ send() [4/4]

template<typename Alloc >
void Botan::Filter::send ( const std::vector< uint8_t, Alloc > &  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.

References BOTAN_ASSERT_NOMSG.

82  {
83  BOTAN_ASSERT_NOMSG(length <= in.size());
84  send(in.data(), length);
85  }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27
#define BOTAN_ASSERT_NOMSG(expr)
Definition: assert.h:68

◆ set_next()

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

Definition at line 154 of file filter.h.

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

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

◆ set_port()

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

Definition at line 152 of file filter.h.

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

152 { 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()

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

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::Fork, Botan::Base64_Decoder, Botan::Hex_Decoder, Botan::DataSink_Stream, Botan::Chain, Botan::Hex_Encoder, Botan::Base64_Encoder, Botan::BitBucket, and Botan::SecureQueue.

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

Friends And Related Function Documentation

◆ Threaded_Fork

friend class Threaded_Fork
friend

Definition at line 159 of file filter.h.


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