Botan::Hex_Encoder Class Reference

#include <hex_filt.h>

Inheritance diagram for Botan::Hex_Encoder:

Public Types
enum	Case { Uppercase , Lowercase }

Public Member Functions
virtual bool	attachable ()
void	end_msg ()
	Hex_Encoder (bool newlines=false, size_t line_length=72, Case the_case=Uppercase)
	Hex_Encoder (Case the_case)
std::string	name () const
virtual void	start_msg ()
void	write (const byte in[], size_t length)

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

Converts arbitrary binary data to hex strings, optionally with newlines inserted

Definition at line 19 of file hex_filt.h.

Member Enumeration Documentation

Case

enum Botan::Hex_Encoder::Case

Whether to use uppercase or lowercase letters for the encoded string.

Enumerator
Uppercase
Lowercase

Definition at line 25 of file hex_filt.h.

{ Uppercase, Lowercase };

Constructor & Destructor Documentation

Hex_Encoder() [1/2]

Botan::Hex_Encoder::Hex_Encoder

(

Case

the_case

)

Create a hex encoder.

Parameters

the_case

the case to use in the encoded strings.

Definition at line 36 of file hex_filt.cpp.

                               : casing(c), line_length(0)
   {
   in.resize(HEX_CODEC_BUFFER_SIZE);
   out.resize(2*in.size());
   counter = position = 0;
   }

References Botan::HEX_CODEC_BUFFER_SIZE.

Hex_Encoder() [2/2]

Botan::Hex_Encoder::Hex_Encoder	(	bool	newlines = false,
		size_t	line_length = 72,
		Case	the_case = Uppercase )

Create a hex encoder.

Parameters

newlines	should newlines be used
line_length	if newlines are used, how long are lines
the_case	the case to use in the encoded strings

Definition at line 25 of file hex_filt.cpp.

                                                           :
   casing(c), line_length(breaks ? length : 0)
   {
   in.resize(HEX_CODEC_BUFFER_SIZE);
   out.resize(2*in.size());
   counter = position = 0;
   }

References Botan::HEX_CODEC_BUFFER_SIZE.

Member Function Documentation

attachable()

virtual bool Botan::Filter::attachable ( )

inlinevirtualinherited

Check whether this filter is an attachable filter.

Returns

true if this filter is attachable, false otherwise

Reimplemented in Botan::DataSink, and Botan::SecureQueue.

Definition at line 50 of file filter.h.

{ return true; }

end_msg()

void Botan::Hex_Encoder::end_msg ( )

virtual

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

Reimplemented from Botan::Filter.

Definition at line 99 of file hex_filt.cpp.

   {
   encode_and_send(&in[0], position);
   if(counter && line_length)
      send('\n');
   counter = position = 0;
   }

References Botan::Filter::send().

name()

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

inlinevirtual

Returns

descriptive name for this filter

Implements Botan::Filter.

Definition at line 27 of file hex_filt.h.

{ return "Hex_Encoder"; }

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::Hex_Encoder::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 76 of file hex_filt.cpp.

   {
   in.copy(position, input, length);
   if(position + length >= in.size())
      {
      encode_and_send(&in[0], in.size());
      input += (in.size() - position);
      length -= (in.size() - position);
      while(length >= in.size())
         {
         encode_and_send(input, in.size());
         input += in.size();
         length -= in.size();
         }
      in.copy(input, length);
      position = 0;
      }
   position += length;
   }

---

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

• src/filters/codec_filt/hex_filt.h
• src/filters/codec_filt/hex_filt.cpp