Botan  1.11.15
Public Types | Public Member Functions | Protected Member Functions
Botan::Hex_Encoder Class Reference

#include <hex_filt.h>

Inheritance diagram for Botan::Hex_Encoder:
Botan::Filter

List of all members.

Public Types

enum  Case { Uppercase, Lowercase }

Public Member Functions

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

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

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

Definition at line 19 of file hex_filt.h.


Member Enumeration Documentation

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

Enumerator:
Uppercase 
Lowercase 

Definition at line 25 of file hex_filt.h.


Constructor & Destructor Documentation

Create a hex encoder.

Parameters:
the_casethe case to use in the encoded strings.

Definition at line 36 of file hex_filt.cpp.

References Botan::HEX_CODEC_BUFFER_SIZE.

                               : casing(c), line_length(0)
   {
   in.resize(HEX_CODEC_BUFFER_SIZE);
   out.resize(2*in.size());
   counter = position = 0;
   }
Botan::Hex_Encoder::Hex_Encoder ( bool  newlines = false,
size_t  line_length = 72,
Case  the_case = Uppercase 
)

Create a hex encoder.

Parameters:
newlinesshould newlines be used
line_lengthif newlines are used, how long are lines
the_casethe case to use in the encoded strings

Definition at line 25 of file hex_filt.cpp.

References Botan::HEX_CODEC_BUFFER_SIZE.

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

Member Function Documentation

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

Check whether this filter is an attachable filter.

Returns:
true if this filter is attachable, false otherwise

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

Definition at line 52 of file filter.h.

{ return true; }
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.

References Botan::Filter::send().

   {
   encode_and_send(&in[0], position);
   if(counter && line_length)
      send('\n');
   counter = position = 0;
   }
std::string Botan::Hex_Encoder::name ( ) const [inline, virtual]
Returns:
descriptive name for this filter

Implements Botan::Filter.

Definition at line 27 of file hex_filt.h.

{ return "Hex_Encoder"; }
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(), 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::Hex_Encoder::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 76 of file hex_filt.cpp.

References Botan::buffer_insert(), and Botan::copy_mem().

   {
   buffer_insert(in, 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();
         }
      copy_mem(&in[0], input, length);
      position = 0;
      }
   position += length;
   }

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