#include <basefilt.h>

Inheritance diagram for Botan::BitBucket:

Public Member Functions
virtual bool	attachable ()
virtual void	end_msg ()
std::string	name () const
virtual void	start_msg ()
void	write (const byte[], size_t)
Protected Member Functions
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)

Detailed Description

BitBucket is a filter which simply discards all inputs

Definition at line 20 of file basefilt.h.

Member Function Documentation

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.

{}

std::string Botan::BitBucket::name ( ) const [inline, virtual]

Returns:: descriptive name for this filter

Implements Botan::Filter.

Definition at line 24 of file basefilt.h.

{ return "BitBucket"; }

void Botan::Filter::send	(	const byte	in[],
		size_t	length
	)		`[protected, virtual, inherited]`

Parameters:

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]

Parameters:

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]

Parameters:

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]

Parameters:

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]`

Parameters:

in	some input for the filter
length	the 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:

in	some input for the filter
length	the number of bytes of in to send

Definition at line 90 of file filter.h.

         {
         send(&in[0], length);
         }

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::BitBucket::write	(	const byte	input[],
		size_t	length
	)		`[inline, virtual]`

Write a portion of a message to this filter.

Parameters:

input	the input as a byte array
length	the length of the byte array input

Implements Botan::Filter.

Definition at line 22 of file basefilt.h.

{}

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

src/lib/filters/basefilt.h

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation