Botan::TLS_Data_Reader Class Reference

#include <tls_reader.h>

Public Member Functions
void	discard_next (size_t bytes)
byte	get_byte ()
template<typename T, typename Container>
Container	get_elem (size_t num_elems)
template<typename T>
SecureVector< T >	get_fixed (size_t size)
template<typename T>
SecureVector< T >	get_range (size_t len_bytes, size_t min_elems, size_t max_elems)
template<typename T>
std::vector< T >	get_range_vector (size_t len_bytes, size_t min_elems, size_t max_elems)
u16bit	get_u16bit ()
bool	has_remaining () const
size_t	remaining_bytes () const
	TLS_Data_Reader (const MemoryRegion< byte > &buf_in)

Detailed Description

Helper class for decoding TLS protocol messages

Definition at line 19 of file tls_reader.h.

Constructor & Destructor Documentation

TLS_Data_Reader()

Botan::TLS_Data_Reader::TLS_Data_Reader ( const MemoryRegion< byte > & buf_in )

inline

Definition at line 22 of file tls_reader.h.

                                                        :
         buf(buf_in), offset(0) {}

Member Function Documentation

discard_next()

void Botan::TLS_Data_Reader::discard_next ( size_t bytes )

inline

Definition at line 35 of file tls_reader.h.

         {
         assert_at_least(bytes);
         offset += bytes;
         }

get_byte()

byte Botan::TLS_Data_Reader::get_byte ( )

inline

Definition at line 49 of file tls_reader.h.

         {
         assert_at_least(1);
         byte result = buf[offset];
         offset += 1;
         return result;
         }

get_elem()

template<typename T, typename Container>

Container Botan::TLS_Data_Reader::get_elem ( size_t num_elems )

inline

Definition at line 58 of file tls_reader.h.

         {
         assert_at_least(num_elems * sizeof(T));
 
         Container result(num_elems);
 
         for(size_t i = 0; i != num_elems; ++i)
            result[i] = load_be<T>(&buf[offset], i);
 
         offset += num_elems * sizeof(T);
 
         return result;
         }

References Botan::load_be().

Referenced by get_fixed(), get_range(), and get_range_vector().

get_fixed()

template<typename T>

SecureVector< T > Botan::TLS_Data_Reader::get_fixed ( size_t size )

inline

Definition at line 95 of file tls_reader.h.

         {
         return get_elem<T, SecureVector<T> >(size);
         }

References get_elem().

get_range()

template<typename T>

SecureVector< T > Botan::TLS_Data_Reader::get_range ( size_t len_bytes, size_t min_elems, size_t max_elems )

inline

Definition at line 73 of file tls_reader.h.

         {
         const size_t num_elems =
            get_num_elems(len_bytes, sizeof(T), min_elems, max_elems);
 
         return get_elem<T, SecureVector<T> >(num_elems);
         }

References get_elem().

get_range_vector()

template<typename T>

std::vector< T > Botan::TLS_Data_Reader::get_range_vector ( size_t len_bytes, size_t min_elems, size_t max_elems )

inline

Definition at line 84 of file tls_reader.h.

         {
         const size_t num_elems =
            get_num_elems(len_bytes, sizeof(T), min_elems, max_elems);
 
         return get_elem<T, std::vector<T> >(num_elems);
         }

References get_elem().

get_u16bit()

u16bit Botan::TLS_Data_Reader::get_u16bit ( )

inline

Definition at line 41 of file tls_reader.h.

         {
         assert_at_least(2);
         u16bit result = make_u16bit(buf[offset], buf[offset+1]);
         offset += 2;
         return result;
         }

References Botan::make_u16bit().

has_remaining()

bool Botan::TLS_Data_Reader::has_remaining ( ) const

inline

Definition at line 30 of file tls_reader.h.

         {
         return (remaining_bytes() > 0);
         }

References remaining_bytes().

remaining_bytes()

size_t Botan::TLS_Data_Reader::remaining_bytes ( ) const

inline

Definition at line 25 of file tls_reader.h.

         {
         return buf.size() - offset;
         }

Referenced by has_remaining().

---

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

• src/ssl/tls_reader.h