Botan::DataSink_Stream Class Reference

#include <data_snk.h>

Inheritance diagram for Botan::DataSink_Stream:

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

Protected Member Functions
template<typename Alloc >
void	send (const std::vector< uint8_t, Alloc > &in)
template<typename Alloc >
void	send (const std::vector< uint8_t, Alloc > &in, size_t length)
virtual void	send (const uint8_t in[], size_t length)
void	send (uint8_t in)

Detailed Description

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

Definition at line 35 of file data_snk.h.

Constructor & Destructor Documentation

DataSink_Stream()

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

Construct a DataSink_Stream from a stream.

Parameters

stream	the stream to write to
name	identifier

Definition at line 43 of file data_snk.cpp.

                                                      :
   m_identifier(name),
   m_sink(out)
   {
   }

~DataSink_Stream()

Botan::DataSink_Stream::~DataSink_Stream ( )

default

Member Function Documentation

attachable()

bool Botan::DataSink::attachable ( )

inlineoverridevirtualinherited

Check whether this filter is an attachable filter.

Returns

true if this filter is attachable, false otherwise

Reimplemented from Botan::Filter.

Definition at line 24 of file data_snk.h.

{ return false; }

end_msg()

void Botan::DataSink_Stream::end_msg ( )

overridevirtual

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

Reimplemented from Botan::Filter.

Definition at line 35 of file data_snk.cpp.

   {
   m_sink.flush();
   }

name()

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

inlineoverridevirtual

Returns

descriptive name for this filter

Implements Botan::Filter.

Definition at line 58 of file data_snk.h.

{ return m_identifier; }

send() [1/4]

template<typename Alloc >

void Botan::Filter::send ( const std::vector< uint8_t, Alloc > &  in )

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 71 of file filter.h.

         {
         send(in.data(), in.size());
         }

send() [2/4]

template<typename Alloc >

void Botan::Filter::send ( const std::vector< uint8_t, Alloc > &  in, size_t  length  )

inlineprotectedinherited

Parameters

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

Definition at line 81 of file filter.h.

         {
         BOTAN_ASSERT_NOMSG(length <= in.size());
         send(in.data(), length);
         }

References BOTAN_ASSERT_NOMSG.

send() [3/4]

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

protectedvirtualinherited

Parameters

in	some input for the filter
length	the length of in

Definition at line 27 of file filter.cpp.

   {
   if(!length)
      return;
 
   bool nothing_attached = true;
   for(size_t j = 0; j != total_ports(); ++j)
      if(m_next[j])
         {
         if(!m_write_queue.empty())
            m_next[j]->write(m_write_queue.data(), m_write_queue.size());
         m_next[j]->write(input, length);
         nothing_attached = false;
         }
 
   if(nothing_attached)
      m_write_queue += std::make_pair(input, length);
   else
      m_write_queue.clear();
   }

References Botan::Filter::write().

Referenced by Botan::Base64_Encoder::end_msg(), Botan::Base64_Decoder::end_msg(), Botan::Hex_Encoder::end_msg(), Botan::Hex_Decoder::end_msg(), Botan::Base64_Decoder::write(), and Botan::Hex_Decoder::write().

send() [4/4]

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

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 65 of file filter.h.

{ send(&in, 1); }

References Botan::Filter::send().

Referenced by Botan::Filter::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.

Definition at line 40 of file filter.h.

{ /* default empty */ }

write()

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

overridevirtual

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

   {
   m_sink.write(cast_uint8_ptr_to_char(out), length);
   if(!m_sink.good())
      throw Stream_IO_Error("DataSink_Stream: Failure writing to " +
                            m_identifier);
   }

References Botan::cast_uint8_ptr_to_char().

---

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

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