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

#include <data_snk.h>

Inheritance diagram for Botan::DataSink_Stream:
Botan::DataSink Botan::Filter

List of all members.

Public Member Functions

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

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

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

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

Construct a DataSink_Stream from a stream.

Parameters:
streamthe stream to write to
nameidentifier

Definition at line 29 of file data_snk.cpp.

                                                        :
   identifier(name),
   sink_p(nullptr),
   sink(out)
   {
   }
Botan::DataSink_Stream::DataSink_Stream ( const std::string &  pathname,
bool  use_binary = false 
)

Construct a DataSink_Stream from a stream.

Parameters:
pathnamethe name of the file to open a stream to
use_binaryindicates 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);
      }
   }

Definition at line 58 of file data_snk.cpp.

   {
   delete sink_p;
   }

Member Function Documentation

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

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; }
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::DataSink_Stream::name ( ) const [inline, virtual]
Returns:
descriptive name for this filter

Implements Botan::Filter.

Definition at line 36 of file data_snk.h.

{ return identifier; }
void Botan::Filter::send ( const byte  in[],
size_t  length 
) [protected, virtual, inherited]
Parameters:
insome input for the filter
lengththe 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:
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);
         }
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::DataSink_Stream::write ( const byte  input[],
size_t  length 
) [virtual]

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

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