Botan::Fanout_Filter Class Reference

#include <filter.h>

Inheritance diagram for Botan::Fanout_Filter:

List of all members.

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[], u32bit length)=0

Protected Member Functions

void attach (Filter *f)

void incr_owns ()

void send (const MemoryRegion< byte > &in)

void send (byte in)

void send (const byte in[], u32bit length)

void set_next (Filter *f[], u32bit n)

void set_port (u32bit n)

Detailed Description

This is the abstract Fanout_Filter base class.

Definition at line 124 of file filter.h.

Member Function Documentation

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

Attach another filter to this one

Parameters:

f

filter to attach

Reimplemented from Botan::Filter.

Definition at line 136 of file filter.h.

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

00136 { Filter::attach(f); }

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::DataSink, and Botan::SecureQueue.

Definition at line 50 of file filter.h.

00050 { 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::Base64_Encoder, Botan::Base64_Decoder, Botan::Bzip_Compression, Botan::Bzip_Decompression, Botan::Hash_Filter, Botan::MAC_Filter, Botan::Hex_Encoder, Botan::Hex_Decoder, Botan::PK_Encryptor_Filter, Botan::PK_Decryptor_Filter, Botan::PK_Signer_Filter, Botan::PK_Verifier_Filter, Botan::Zlib_Compression, Botan::Zlib_Decompression, Botan::PBE_PKCS5v15, and Botan::PBE_PKCS5v20.

Definition at line 44 of file filter.h.

00044 {}

void Botan::Fanout_Filter::incr_owns ( ) [inline, protected]

Increment the number of filters past us that we own

Definition at line 130 of file filter.h.

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

00130 { ++filter_owns; }

virtual std::string Botan::Filter::name ( ) const [pure virtual, inherited]

void Botan::Filter::send ( const MemoryRegion< byte > & in ) [inline, protected, inherited]

Parameters:

in

some input for the filter

Definition at line 68 of file filter.h.

References Botan::MemoryRegion< T >::begin(), Botan::Filter::send(), and Botan::MemoryRegion< T >::size().

Referenced by Botan::Filter::send().

00068 { send(in.begin(), in.size()); }

void Botan::Filter::send ( byte in ) [inline, protected, inherited]

Parameters:

in

some input for the filter

Definition at line 63 of file filter.h.

References Botan::Filter::send().

Referenced by Botan::Filter::send().

00063 { send(&in, 1); }

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

Parameters:

	in	some input for the filter
	length	the length of in

Definition at line 28 of file filter.cpp.

References Botan::MemoryRegion< T >::append(), Botan::MemoryRegion< T >::destroy(), Botan::MemoryRegion< T >::size(), and Botan::Filter::write().

00029    {
00030    bool nothing_attached = true;
00031    for(u32bit j = 0; j != total_ports(); ++j)
00032       if(next[j])
00033          {
00034          if(write_queue.size())
00035             next[j]->write(write_queue, write_queue.size());
00036          next[j]->write(input, length);
00037          nothing_attached = false;
00038          }
00039 
00040    if(nothing_attached)
00041       write_queue.append(input, length);
00042    else
00043       write_queue.destroy();
00044    }

void Botan::Fanout_Filter::set_next	(	Filter *	filters[],
		u32bit	count
	)			`[inline, protected]`

Parameters:

	filters	the filters to set
	count	number of items in filters

Reimplemented from Botan::Filter.

Definition at line 134 of file filter.h.

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

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

void Botan::Fanout_Filter::set_port ( u32bit new_port ) [inline, protected]

Set the active port

Parameters:

new_port

the new value

Reimplemented from Botan::Filter.

Reimplemented in Botan::Fork.

Definition at line 132 of file filter.h.

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

00132 { 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::Bzip_Compression, Botan::Bzip_Decompression, Botan::EAX_Base, Botan::Zlib_Compression, Botan::Zlib_Decompression, Botan::PBE_PKCS5v15, and Botan::PBE_PKCS5v20.

Definition at line 38 of file filter.h.

00038 {}

virtual void Botan::Filter::write	(	const byte	input[],
		u32bit	length
	)			`[pure virtual, inherited]`

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

Implemented in Botan::Base64_Encoder, Botan::Base64_Decoder, Botan::BitBucket, Botan::Chain, Botan::Fork, Botan::Bzip_Compression, Botan::Bzip_Decompression, Botan::DataSink_Stream, Botan::StreamCipher_Filter, Botan::Hash_Filter, Botan::MAC_Filter, Botan::Hex_Encoder, Botan::Hex_Decoder, Botan::PK_Encryptor_Filter, Botan::PK_Decryptor_Filter, Botan::PK_Signer_Filter, Botan::PK_Verifier_Filter, Botan::SecureQueue, Botan::Zlib_Compression, Botan::Zlib_Decompression, Botan::PBE_PKCS5v15, and Botan::PBE_PKCS5v20.

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

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

src/filters/filter.h


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[], u32bit length)=0
Protected Member Functions
void	attach (Filter *f)
void	incr_owns ()
void	send (const MemoryRegion< byte > &in)
void	send (byte in)
void	send (const byte in[], u32bit length)
void	set_next (Filter *f[], u32bit n)
void	set_port (u32bit n)