Hall-D Software  alpha
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
xstream::digest::common< digest_type > Class Template Referenceabstract

Digest base class. More...

#include <digest.h>

+ Inheritance diagram for xstream::digest::common< digest_type >:

Public Member Functions

 common (size_t s)
 
virtual digest_type digest ()=0
 return the digest value More...
 
digest_type reset ()
 resets the digest calculation More...
 

Protected Member Functions

int sync ()
 update digest with as much data as possible (overloaded from streambuf) More...
 
virtual void calculate_digest ()=0
 updates the digest must be inplemented by classes that implement this interface More...
 
virtual void reset_digest ()=0
 resets digest to it's initial value More...
 
std::streamsize available () const
 remaining characters in the buffer More...
 
std::streamsize taken () const
 number of characters in the buffer More...
 

Protected Attributes

xstream::buffer buf
 
uint64_t length
 

Detailed Description

template<typename digest_type>
class xstream::digest::common< digest_type >

Digest base class.

general interface for digest functions

Definition at line 102 of file digest.h.

Constructor & Destructor Documentation

template<typename digest_type >
xstream::digest::common< digest_type >::common ( size_t  s)
inline

Definition at line 111 of file digest.h.

Member Function Documentation

std::streamsize xstream::ostreambuf::available ( ) const
inlineprotectedinherited

remaining characters in the buffer

Definition at line 28 of file common.h.

Referenced by xstream::base64::ostreambuf::~ostreambuf().

virtual void xstream::digest::stream::calculate_digest ( )
protectedpure virtualinherited

updates the digest must be inplemented by classes that implement this interface

Referenced by xstream::digest::stream::sync().

template<typename digest_type >
virtual digest_type xstream::digest::common< digest_type >::digest ( )
pure virtual

return the digest value

Referenced by xstream::digest::common< digest_type >::reset().

template<typename digest_type >
digest_type xstream::digest::common< digest_type >::reset ( )
inline

resets the digest calculation

returns the digest of data so far and for future calculations only considers data entered from now on

Definition at line 128 of file digest.h.

References xstream::digest::common< digest_type >::digest(), xstream::digest::stream::reset_digest(), and xstream::digest::stream::sync().

virtual void xstream::digest::stream::reset_digest ( )
protectedpure virtualinherited

resets digest to it's initial value

Referenced by xstream::digest::common< digest_type >::reset().

int xstream::digest::stream::sync ( )
protectedinherited
std::streamsize xstream::ostreambuf::taken ( ) const
inlineprotectedinherited

number of characters in the buffer

Definition at line 36 of file common.h.

Referenced by xstream::digest::stream::xsputn().

Member Data Documentation

xstream::buffer xstream::digest::stream::buf
protectedinherited

buffer data to calculate digest

Definition at line 59 of file digest.h.

Referenced by xstream::digest::stream::stream(), and xstream::digest::stream::sync().

uint64_t xstream::digest::stream::length
protectedinherited

number of bytes read so far

Definition at line 60 of file digest.h.

Referenced by xstream::digest::stream::sync().


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