Botan::DataSink Class Reference

#include <data_snk.h>

Inheritance diagram for Botan::DataSink:

Public Member Functions
bool	attachable () override
	DataSink ()=default
	DataSink (const DataSink &)=delete
virtual void	end_msg ()
virtual std::string	name () const =0
DataSink &	operator= (const DataSink &)=delete
virtual void	start_msg ()
virtual void	write (const uint8_t input[], size_t length)=0
	~DataSink () override=default

Protected Member Functions
virtual void	send (const uint8_t in[], size_t length)
void	send (std::span< const uint8_t > in)
void	send (std::span< const uint8_t > in, size_t length)
void	send (uint8_t in)

Detailed Description

This class represents abstract data sink objects.

Definition at line 21 of file data_snk.h.

Constructor & Destructor Documentation

DataSink() [1/2]

Botan::DataSink::DataSink ( )

default

Referenced by DataSink(), and operator=().

~DataSink()

Botan::DataSink::~DataSink ( )

overridedefault

DataSink() [2/2]

Botan::DataSink::DataSink ( const DataSink & )

delete

References DataSink().

Member Function Documentation

attachable()

bool Botan::DataSink::attachable ( )

inlineoverridevirtual

Check whether this filter is an attachable filter.

Returns

true if this filter is attachable, false otherwise

Reimplemented from Botan::Filter.

Definition at line 23 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::DataSink_Stream, Botan::Hex_Decoder, and Botan::Hex_Encoder.

Definition at line 47 of file filter.h.

                             { /* default empty */
      }

name()

virtual std::string Botan::Filter::name ( ) const

pure virtualinherited

Returns

descriptive name for this filter

Implemented in Botan::Base64_Decoder, Botan::Base64_Encoder, Botan::BitBucket, Botan::Chain, Botan::Cipher_Mode_Filter, Botan::DataSink_Stream, Botan::Fork, Botan::Hex_Decoder, Botan::Hex_Encoder, and Botan::SecureQueue.

Referenced by Botan::Keyed_Filter::set_iv().

operator=()

DataSink & Botan::DataSink::operator= ( const DataSink & )

delete

References DataSink().

send() [1/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 33 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();
   }
}

Referenced by Botan::Base64_Decoder::end_msg(), Botan::Base64_Encoder::end_msg(), Botan::Hex_Decoder::end_msg(), Botan::Hex_Encoder::end_msg(), operator=(), send(), Botan::Base64_Decoder::write(), Botan::Chain::write(), Botan::Fork::write(), and Botan::Hex_Decoder::write().

send() [2/4]

void Botan::Filter::send ( std::span< const uint8_t > in )

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 76 of file filter.h.

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

References send().

Referenced by send().

send() [3/4]

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

protectedinherited

Parameters

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

This previously took a std::vector, for which the length field (allowing using just a prefix of the vector) somewhat made sense. It makes less sense now that we are using a span here; you can just use first to get a prefix.

Definition at line 25 of file filter.cpp.

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

References BOTAN_ASSERT_NOMSG, and send().

send() [4/4]

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

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 71 of file filter.h.

{ send(&in, 1); }

References send().

Referenced by 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()

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

pure virtualinherited

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_Decoder, Botan::Base64_Encoder, Botan::BitBucket, Botan::Chain, Botan::DataSink_Stream, Botan::Fork, Botan::Hex_Decoder, Botan::Hex_Encoder, and Botan::SecureQueue.

---

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

• src/lib/filters/data_snk.h