Botan  1.11.15
Public Member Functions | Protected Member Functions
Botan::Threaded_Fork Class Reference

#include <basefilt.h>

Inheritance diagram for Botan::Threaded_Fork:
Botan::Fork Botan::Fanout_Filter Botan::Filter

List of all members.

Public Member Functions

virtual bool attachable ()
virtual void end_msg ()
std::string name () const
void set_port (size_t n)
virtual void start_msg ()
 Threaded_Fork (Filter *, Filter *, Filter *=nullptr, Filter *=nullptr)
 Threaded_Fork (Filter *filter_arr[], size_t length)
void write (const byte input[], size_t length)
 ~Threaded_Fork ()

Protected Member Functions

void attach (Filter *f)
void incr_owns ()
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 send (const byte in[], size_t length)
void set_next (Filter *f[], size_t n)

Detailed Description

This class is a threaded version of the Fork filter. While this uses threads, the class itself is NOT thread-safe. This is meant as a drop- in replacement for Fork where performance gains are possible.

Definition at line 86 of file basefilt.h.


Constructor & Destructor Documentation

Botan::Threaded_Fork::Threaded_Fork ( Filter f1,
Filter f2,
Filter f3 = nullptr,
Filter f4 = nullptr 
)

Construct a Threaded_Fork filter with up to four forks.

Definition at line 43 of file threaded_fork.cpp.

References set_next().

                                                                           :
   Fork(nullptr, static_cast<size_t>(0)),
   m_thread_data(new Threaded_Fork_Data)
   {
   Filter* filters[4] = { f1, f2, f3, f4 };
   set_next(filters, 4);
   }
Botan::Threaded_Fork::Threaded_Fork ( Filter filter_arr[],
size_t  length 
)

Construct a Threaded_Fork from range of filters

Parameters:
filter_arrthe list of filters
lengthhow many filters

Definition at line 54 of file threaded_fork.cpp.

References set_next().

                                                            :
   Fork(nullptr, static_cast<size_t>(0)),
   m_thread_data(new Threaded_Fork_Data)
   {
   set_next(filters, count);
   }

Definition at line 61 of file threaded_fork.cpp.

   {
   m_thread_data->m_input = nullptr;
   m_thread_data->m_input_length = 0;

   m_thread_data->m_input_ready_semaphore.release(m_threads.size());

   for(auto& thread : m_threads)
     thread->join();
   }

Member Function Documentation

void Botan::Fanout_Filter::attach ( Filter f) [inline, protected, inherited]

Attach another filter to this one

Parameters:
ffilter to attach

Reimplemented from Botan::Filter.

Definition at line 164 of file filter.h.

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

virtual bool Botan::Filter::attachable ( ) [inline, virtual, inherited]

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.

{ 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::Threaded_Fork::name ( ) const [virtual]
Returns:
descriptive name for this filter

Reimplemented from Botan::Fork.

Definition at line 72 of file threaded_fork.cpp.

   {
   return "Threaded Fork";
   }
void Botan::Filter::send ( byte  in) [inline, protected, inherited]
Parameters:
insome 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]
Parameters:
insome 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]
Parameters:
insome 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]
Parameters:
insome input for the filter
lengththe number of bytes of in to send

Definition at line 81 of file filter.h.

         {
         send(&in[0], length);
         }
void Botan::Filter::send ( const std::vector< byte > &  in,
size_t  length 
) [inline, protected, inherited]
Parameters:
insome input for the filter
lengththe number of bytes of in to send

Definition at line 90 of file filter.h.

         {
         send(&in[0], length);
         }
void Botan::Threaded_Fork::send ( const byte  in[],
size_t  length 
) [protected, virtual]
Parameters:
insome input for the filter
lengththe length of in

Reimplemented from Botan::Filter.

Definition at line 97 of file threaded_fork.cpp.

   {
   if(write_queue.size())
      thread_delegate_work(&write_queue[0], write_queue.size());
   thread_delegate_work(input, length);

   bool nothing_attached = true;
   for(size_t j = 0; j != total_ports(); ++j)
      if(next[j])
         nothing_attached = false;

   if(nothing_attached)
      write_queue += std::make_pair(input, length);
   else
      write_queue.clear();
   }
void Botan::Threaded_Fork::set_next ( Filter filters[],
size_t  count 
) [protected]
Parameters:
filtersthe filters to set
countnumber of items in filters

Reimplemented from Botan::Fanout_Filter.

Definition at line 77 of file threaded_fork.cpp.

References n.

Referenced by Threaded_Fork().

   {
   Fork::set_next(f, n);
   n = next.size();

   if(n < m_threads.size())
      m_threads.resize(n);
   else
      {
      m_threads.reserve(n);
      for(size_t i = m_threads.size(); i != n; ++i)
         {
         m_threads.push_back(
            std::shared_ptr<std::thread>(
               new std::thread(
                  std::bind(&Threaded_Fork::thread_entry, this, next[i]))));
         }
      }
   }
void Botan::Fork::set_port ( size_t  new_port) [inline, inherited]

Set the active port

Parameters:
new_portthe new value

Reimplemented from Botan::Fanout_Filter.

Definition at line 64 of file basefilt.h.

References Botan::Fanout_Filter::set_port().

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, inherited]

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 63 of file basefilt.h.

{ send(input, length); }

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