Botan
1.11.15
|
#include <basefilt.h>
Public Member Functions | |
virtual bool | attachable () |
virtual void | end_msg () |
Fork (Filter *, Filter *, Filter *=nullptr, Filter *=nullptr) | |
Fork (Filter *filter_arr[], size_t length) | |
std::string | name () const |
void | set_port (size_t n) |
virtual void | start_msg () |
void | write (const byte input[], size_t length) |
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) |
This class represents a fork filter, whose purpose is to fork the flow of data. It causes an input message to result in n messages at the end of the filter, where n is the number of forks.
Definition at line 60 of file basefilt.h.
Botan::Fork::Fork | ( | Filter * | f1, |
Filter * | f2, | ||
Filter * | f3 = nullptr , |
||
Filter * | f4 = nullptr |
||
) |
Construct a Fork filter with up to four forks.
Definition at line 51 of file basefilt.cpp.
References Botan::Fanout_Filter::set_next().
Botan::Fork::Fork | ( | Filter * | filter_arr[], |
size_t | length | ||
) |
Construct a Fork from range of filters
filter_arr | the list of filters |
length | how many filters |
Definition at line 60 of file basefilt.cpp.
References Botan::Fanout_Filter::set_next().
{ set_next(filters, count); }
void Botan::Fanout_Filter::attach | ( | Filter * | f | ) | [inline, protected, inherited] |
Attach another filter to this one
f | filter to attach |
Reimplemented from Botan::Filter.
Definition at line 164 of file filter.h.
Referenced by Botan::Chain::Chain().
{ Filter::attach(f); }
virtual bool Botan::Filter::attachable | ( | ) | [inline, virtual, inherited] |
Check whether this filter is an attachable filter.
Reimplemented in Botan::SecureQueue, and Botan::DataSink.
Definition at line 52 of file filter.h.
{ return true; }
virtual void Botan::Filter::end_msg | ( | ) | [inline, virtual, inherited] |
Notify that the current message is finished; flush buffers and do end-of-message processing (if any).
Reimplemented in Botan::MAC_Filter, Botan::Hash_Filter, Botan::Base64_Decoder, Botan::Hex_Decoder, Botan::Base64_Encoder, Botan::Hex_Encoder, and Botan::Compression_Decompression_Filter.
Definition at line 46 of file filter.h.
{}
void Botan::Fanout_Filter::incr_owns | ( | ) | [inline, protected, inherited] |
Increment the number of filters past us that we own
Definition at line 158 of file filter.h.
Referenced by Botan::Chain::Chain().
{ ++filter_owns; }
std::string Botan::Fork::name | ( | ) | const [virtual] |
Implements Botan::Filter.
Reimplemented in Botan::Threaded_Fork.
Definition at line 65 of file basefilt.cpp.
{ return "Fork"; }
void Botan::Filter::send | ( | const byte | in[], |
size_t | length | ||
) | [protected, virtual, inherited] |
in | some input for the filter |
length | the length of in |
Reimplemented in Botan::Threaded_Fork.
Definition at line 28 of file filter.cpp.
References Botan::Filter::write().
Referenced by Botan::Compression_Decompression_Filter::end_msg(), Botan::Hex_Encoder::end_msg(), Botan::Base64_Encoder::end_msg(), Botan::Hex_Decoder::end_msg(), Botan::Base64_Decoder::end_msg(), Botan::Hash_Filter::end_msg(), Botan::MAC_Filter::end_msg(), Botan::Compression_Decompression_Filter::flush(), Botan::Compression_Decompression_Filter::start_msg(), Botan::Compression_Decompression_Filter::write(), Botan::StreamCipher_Filter::write(), Botan::Hex_Decoder::write(), and Botan::Base64_Decoder::write().
{ if(!length) return; bool nothing_attached = true; for(size_t j = 0; j != total_ports(); ++j) if(next[j]) { if(write_queue.size()) next[j]->write(&write_queue[0], write_queue.size()); next[j]->write(input, length); nothing_attached = false; } if(nothing_attached) write_queue += std::make_pair(input, length); else write_queue.clear(); }
void Botan::Filter::send | ( | byte | in | ) | [inline, protected, inherited] |
in | some input for the filter |
Definition at line 65 of file filter.h.
References Botan::Filter::send().
Referenced by Botan::Filter::send().
{ send(&in, 1); }
void Botan::Filter::send | ( | const secure_vector< byte > & | in | ) | [inline, protected, inherited] |
in | some input for the filter |
Definition at line 70 of file filter.h.
References Botan::Filter::send().
Referenced by Botan::Filter::send().
{ send(&in[0], in.size()); }
void Botan::Filter::send | ( | const std::vector< byte > & | in | ) | [inline, protected, inherited] |
in | some input for the filter |
Definition at line 75 of file filter.h.
References Botan::Filter::send().
Referenced by Botan::Filter::send().
{ send(&in[0], in.size()); }
void Botan::Filter::send | ( | const secure_vector< byte > & | in, |
size_t | length | ||
) | [inline, protected, inherited] |
void Botan::Filter::send | ( | const std::vector< byte > & | in, |
size_t | length | ||
) | [inline, protected, inherited] |
void Botan::Fanout_Filter::set_next | ( | Filter * | filters[], |
size_t | count | ||
) | [inline, protected, inherited] |
filters | the filters to set |
count | number of items in filters |
Reimplemented from Botan::Filter.
Reimplemented in Botan::Threaded_Fork.
Definition at line 162 of file filter.h.
Referenced by Fork(), and Botan::SecureQueue::SecureQueue().
{ Filter::set_next(f, n); }
void Botan::Fork::set_port | ( | size_t | new_port | ) | [inline] |
Set the active port
new_port | the new value |
Reimplemented from Botan::Fanout_Filter.
Definition at line 64 of file basefilt.h.
References Botan::Fanout_Filter::set_port().
{ Fanout_Filter::set_port(n); }
virtual void Botan::Filter::start_msg | ( | ) | [inline, virtual, inherited] |
Start a new message. Must be closed by end_msg() before another message can be started.
Reimplemented in Botan::Compression_Decompression_Filter.
Definition at line 40 of file filter.h.
{}
void Botan::Fork::write | ( | const byte | input[], |
size_t | length | ||
) | [inline, virtual] |
Write a portion of a message to this filter.
input | the input as a byte array |
length | the length of the byte array input |
Implements Botan::Filter.
Definition at line 63 of file basefilt.h.
{ send(input, length); }