Botan  1.11.10
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 Botan::Threaded_Fork

Public Member Functions

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

Protected Member Functions

void attach (Filter *f)
 
void incr_owns ()
 
virtual void send (const byte in[], size_t length)
 
void send (byte in)
 
void send (const secure_vector< byte > &in)
 
void send (const std::vector< byte > &in)
 
void send (const secure_vector< byte > &in, size_t length)
 
void send (const std::vector< byte > &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 152 of file filter.h.

Member Function Documentation

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

Definition at line 164 of file filter.h.

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

164 { Filter::attach(f); }
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; }
virtual void Botan::Filter::end_msg ( )
inlinevirtualinherited
void Botan::Fanout_Filter::incr_owns ( )
inlineprotected

Increment the number of filters past us that we own

Definition at line 158 of file filter.h.

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

158 { ++filter_owns; }
virtual std::string Botan::Filter::name ( ) const
pure virtualinherited
void Botan::Filter::send ( const byte  in[],
size_t  length 
)
protectedvirtualinherited
Parameters
insome input for the filter
lengththe length of in

Reimplemented in Botan::Threaded_Fork.

Definition at line 28 of file filter.cpp.

References Botan::Filter::write().

Referenced by Botan::PK_Encryptor_Filter::end_msg(), Botan::Zlib_Compression::end_msg(), Botan::Bzip_Compression::end_msg(), Botan::Lzma_Compression::end_msg(), Botan::Hex_Encoder::end_msg(), Botan::Base64_Encoder::end_msg(), Botan::PK_Decryptor_Filter::end_msg(), Botan::Bzip_Decompression::end_msg(), Botan::PK_Signer_Filter::end_msg(), Botan::Lzma_Decompression::end_msg(), Botan::Zlib_Decompression::end_msg(), Botan::Hex_Decoder::end_msg(), Botan::Base64_Decoder::end_msg(), Botan::PK_Verifier_Filter::end_msg(), Botan::Hash_Filter::end_msg(), Botan::MAC_Filter::end_msg(), Botan::Bzip_Compression::flush(), Botan::Zlib_Compression::flush(), Botan::Lzma_Compression::flush(), Botan::Zlib_Compression::write(), Botan::Bzip_Compression::write(), Botan::Lzma_Compression::write(), Botan::StreamCipher_Filter::write(), Botan::Bzip_Decompression::write(), Botan::Lzma_Decompression::write(), Botan::Zlib_Decompression::write(), Botan::Hex_Decoder::write(), and Botan::Base64_Decoder::write().

29  {
30  if(!length)
31  return;
32 
33  bool nothing_attached = true;
34  for(size_t j = 0; j != total_ports(); ++j)
35  if(next[j])
36  {
37  if(write_queue.size())
38  next[j]->write(&write_queue[0], write_queue.size());
39  next[j]->write(input, length);
40  nothing_attached = false;
41  }
42 
43  if(nothing_attached)
44  write_queue += std::make_pair(input, length);
45  else
46  write_queue.clear();
47  }
virtual void write(const byte input[], size_t length)=0
void Botan::Filter::send ( byte  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 byte in[], size_t length)
Definition: filter.cpp:28
void Botan::Filter::send ( const secure_vector< byte > &  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[0], in.size()); }
virtual void send(const byte in[], size_t length)
Definition: filter.cpp:28
void Botan::Filter::send ( const std::vector< byte > &  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[0], in.size()); }
virtual void send(const byte in[], size_t length)
Definition: filter.cpp:28
void Botan::Filter::send ( const secure_vector< byte > &  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[0], length);
84  }
virtual void send(const byte in[], size_t length)
Definition: filter.cpp:28
void Botan::Filter::send ( const std::vector< byte > &  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[0], length);
93  }
virtual void send(const byte in[], size_t length)
Definition: filter.cpp:28
void Botan::Fanout_Filter::set_next ( Filter f[],
size_t  n 
)
inlineprotected

Definition at line 162 of file filter.h.

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

162 { Filter::set_next(f, n); }
void Botan::Fanout_Filter::set_port ( size_t  n)
inlineprotected

Definition at line 160 of file filter.h.

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

160 { Filter::set_port(n); }
virtual void Botan::Filter::start_msg ( )
inlinevirtualinherited

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

Reimplemented in Botan::Zlib_Decompression, Botan::Lzma_Decompression, Botan::Bzip_Decompression, Botan::PBE_PKCS5v20, Botan::Lzma_Compression, Botan::Bzip_Compression, and Botan::Zlib_Compression.

Definition at line 40 of file filter.h.

40 {}
virtual void Botan::Filter::write ( const byte  input[],
size_t  length 
)
pure virtualinherited

Friends And Related Function Documentation

friend class Threaded_Fork
friend

Definition at line 167 of file filter.h.


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