Botan::DataSink_Stream Class Reference

#include <data_snk.h>

Inheritance diagram for Botan::DataSink_Stream:

Public Member Functions
bool	attachable ()
	DataSink_Stream (const std::string &pathname, bool use_binary=false)
	DataSink_Stream (std::ostream &stream, const std::string &name="<std::ostream>")
virtual void	end_msg ()
std::string	name () const
virtual void	start_msg ()
void	write (const byte[], size_t)
	~DataSink_Stream ()

Protected Member Functions
void	send (byte in)
void	send (const byte in[], size_t length)
void	send (const MemoryRegion< byte > &in)
void	send (const MemoryRegion< byte > &in, size_t length)

Detailed Description

This class represents a data sink which writes its output to a stream.

Definition at line 33 of file data_snk.h.

Constructor & Destructor Documentation

DataSink_Stream() [1/2]

Botan::DataSink_Stream::DataSink_Stream	(	std::ostream &	stream,
		const std::string &	name = "<std::ostream>" )

Construct a DataSink_Stream from a stream.

Parameters

stream	the stream to write to
name	identifier

Definition at line 29 of file data_snk.cpp.

                                                        :
   identifier(name),
   sink_p(0),
   sink(out)
   {
   }

References name().

DataSink_Stream() [2/2]

Botan::DataSink_Stream::DataSink_Stream	(	const std::string &	pathname,
		bool	use_binary = false )

Construct a DataSink_Stream from a stream.

Parameters

pathname	the name of the file to open a stream to
use_binary	indicates whether to treat the file as a binary file or not

Definition at line 40 of file data_snk.cpp.

                                                  :
   identifier(path),
   sink_p(new std::ofstream(
             path.c_str(),
             use_binary ? std::ios::binary : std::ios::out)),
   sink(*sink_p)
   {
   if(!sink.good())
      {
      delete sink_p;
      throw Stream_IO_Error("DataSink_Stream: Failure opening " + path);
      }
   }

~DataSink_Stream()

Botan::DataSink_Stream::~DataSink_Stream

(

)

Definition at line 58 of file data_snk.cpp.

   {
   delete sink_p;
   }

Member Function Documentation

attachable()

bool Botan::DataSink::attachable ( )

inlinevirtualinherited

Check whether this filter is an attachable filter.

Returns

true if this filter is attachable, false otherwise

Reimplemented from Botan::Filter.

Definition at line 22 of file data_snk.h.

{ return false; }

end_msg()

virtual void Botan::Filter::end_msg ( )

inlinevirtualinherited

Notify that the current message is finished; flush buffers and do end-of-message processing (if any).

Reimplemented in Botan::Base64_Decoder, Botan::Base64_Encoder, Botan::Bzip_Compression, Botan::Bzip_Decompression, Botan::Hash_Filter, Botan::Hex_Decoder, Botan::Hex_Encoder, Botan::MAC_Filter, Botan::PBE_PKCS5v15, Botan::PBE_PKCS5v20, Botan::PK_Decryptor_Filter, Botan::PK_Encryptor_Filter, Botan::PK_Signer_Filter, Botan::PK_Verifier_Filter, Botan::Zlib_Compression, and Botan::Zlib_Decompression.

Definition at line 44 of file filter.h.

{}

name()

std::string Botan::DataSink_Stream::name ( ) const

inlinevirtual

Returns

descriptive name for this filter

Implements Botan::Filter.

Definition at line 36 of file data_snk.h.

{ return identifier; }

Referenced by DataSink_Stream().

send() [1/4]

void Botan::Filter::send ( byte in )

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 63 of file filter.h.

{ send(&in, 1); }

References send().

Referenced by send().

send() [2/4]

void Botan::Filter::send ( const byte in[], size_t length )

protectedinherited

Parameters

in	some input for the filter
length	the length of in

Definition at line 28 of file filter.cpp.

   {
   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();
   }

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

send() [3/4]

void Botan::Filter::send ( const MemoryRegion< byte > & in )

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 68 of file filter.h.

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

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

Referenced by send().

send() [4/4]

void Botan::Filter::send ( const MemoryRegion< byte > & in, size_t length )

inlineprotectedinherited

Parameters

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

Definition at line 74 of file filter.h.

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

References send().

start_msg()

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

Definition at line 38 of file filter.h.

{}

write()

void Botan::DataSink_Stream::write ( const byte input[], size_t length )

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 18 of file data_snk.cpp.

   {
   sink.write(reinterpret_cast<const char*>(out), length);
   if(!sink.good())
      throw Stream_IO_Error("DataSink_Stream: Failure writing to " +
                            identifier);
   }

References Botan::Stream_IO_Error::Stream_IO_Error().

---

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

• src/filters/data_snk.h
• src/filters/data_snk.cpp