Botan  2.4.0
Crypto and TLS for C++11
Public Member Functions | Protected Member Functions | List of all members
Botan::DataSink_Stream Class Referencefinal

#include <data_snk.h>

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

Public Member Functions

bool attachable () override
 
 DataSink_Stream (std::ostream &stream, const std::string &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

virtual void send (const uint8_t in[], size_t length)
 
void send (uint8_t in)
 
void send (const secure_vector< uint8_t > &in)
 
void send (const std::vector< uint8_t > &in)
 
void send (const secure_vector< uint8_t > &in, size_t length)
 
void send (const std::vector< uint8_t > &in, size_t length)
 

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,
const std::string &  name = "<std::ostream>" 
)

Construct a DataSink_Stream from a stream.

Parameters
streamthe stream to write to
nameidentifier

Definition at line 42 of file data_snk.cpp.

43  :
44  m_identifier(name),
45  m_sink(out)
46  {
47  }
std::string name() const override
Definition: data_snk.h:58

◆ ~DataSink_Stream()

Botan::DataSink_Stream::~DataSink_Stream ( )

Definition at line 70 of file data_snk.cpp.

71  {
72  // for ~unique_ptr
73  }

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.

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

35  {
36  m_sink.flush();
37  }

◆ 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.

58 { return m_identifier; }

◆ send() [1/6]

void Botan::Filter::send ( const uint8_t  in[],
size_t  length 
)
protectedvirtualinherited
Parameters
insome input for the filter
lengththe length of in

Definition at line 27 of file filter.cpp.

References Botan::Filter::end_msg(), Botan::Filter::start_msg(), and Botan::Filter::write().

Referenced by Botan::Base64_Encoder::Base64_Encoder(), 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::Hex_Encoder::Hex_Encoder(), Botan::Cipher_Mode_Filter::valid_iv_length(), Botan::StreamCipher_Filter::write(), Botan::Hex_Decoder::write(), and Botan::Base64_Decoder::write().

28  {
29  if(!length)
30  return;
31 
32  bool nothing_attached = true;
33  for(size_t j = 0; j != total_ports(); ++j)
34  if(m_next[j])
35  {
36  if(m_write_queue.size())
37  m_next[j]->write(m_write_queue.data(), m_write_queue.size());
38  m_next[j]->write(input, length);
39  nothing_attached = false;
40  }
41 
42  if(nothing_attached)
43  m_write_queue += std::make_pair(input, length);
44  else
45  m_write_queue.clear();
46  }
virtual void write(const uint8_t input[], size_t length)=0

◆ send() [2/6]

void Botan::Filter::send ( uint8_t  in)
inlineprotectedinherited
Parameters
insome input for the filter

Definition at line 65 of file filter.h.

References Botan::Filter::send().

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

65 { send(&in, 1); }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27

◆ send() [3/6]

void Botan::Filter::send ( const secure_vector< uint8_t > &  in)
inlineprotectedinherited
Parameters
insome input for the filter

Definition at line 70 of file filter.h.

References Botan::Filter::send().

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

70 { send(in.data(), in.size()); }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27

◆ send() [4/6]

void Botan::Filter::send ( const std::vector< uint8_t > &  in)
inlineprotectedinherited
Parameters
insome input for the filter

Definition at line 75 of file filter.h.

References Botan::Filter::send().

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

75 { send(in.data(), in.size()); }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27

◆ send() [5/6]

void Botan::Filter::send ( const secure_vector< uint8_t > &  in,
size_t  length 
)
inlineprotectedinherited
Parameters
insome input for the filter
lengththe number of bytes of in to send

Definition at line 81 of file filter.h.

82  {
83  send(in.data(), length);
84  }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27

◆ send() [6/6]

void Botan::Filter::send ( const std::vector< uint8_t > &  in,
size_t  length 
)
inlineprotectedinherited
Parameters
insome input for the filter
lengththe number of bytes of in to send

Definition at line 90 of file filter.h.

91  {
92  send(in.data(), length);
93  }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27

◆ 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.

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

40 { /* 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
inputthe input as a byte array
lengththe length of the byte array input

Implements Botan::Filter.

Definition at line 23 of file data_snk.cpp.

References Botan::cast_uint8_ptr_to_char().

24  {
25  m_sink.write(cast_uint8_ptr_to_char(out), length);
26  if(!m_sink.good())
27  throw Stream_IO_Error("DataSink_Stream: Failure writing to " +
28  m_identifier);
29  }
const char * cast_uint8_ptr_to_char(const uint8_t *b)
Definition: mem_ops.h:125

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