Sophie

Sophie

distrib > Mandriva > 2007.0 > i586 > by-pkgid > ad1ba1135a9c9eeffc2e538163e00373 > files > 653

libCommonC++2_1.4-devel-1.4.1-1mdv2007.0.i586.rpm

\section{ost::Digest Class Reference}
\label{classost_1_1_digest}\index{ost::Digest@{ost::Digest}}
The digest base class is used for implementing and deriving one way hashing functions.base class for hashing services.  


{\tt \#include $<$digest.h$>$}

Inheritance diagram for ost::Digest::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2cm]{classost_1_1_digest}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
virtual void {\bf init\-Digest} (void)=0
\begin{CompactList}\small\item\em Reset the digest table to an initial default value. \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
{\bf Digest} ()
\item 
virtual unsigned {\bf get\-Size} (void)=0
\begin{CompactList}\small\item\em Get the size of a digest in octets. \item\end{CompactList}\item 
virtual unsigned {\bf get\-Digest} (unsigned char $\ast$buffer)=0
\begin{CompactList}\small\item\em Copy the binary digest buffer to user memory. \item\end{CompactList}\item 
virtual void {\bf put\-Digest} (const unsigned char $\ast$buffer, unsigned length)=0
\begin{CompactList}\small\item\em Put data into the digest bypassing the stream subsystem. \item\end{CompactList}\item 
virtual std::ostream \& {\bf str\-Digest} (std::ostream \&os)=0
\begin{CompactList}\small\item\em print a digest string for export. \item\end{CompactList}\end{CompactItemize}
\subsection*{Friends}
\begin{CompactItemize}
\item 
std::ostream \& {\bf operator$<$$<$} (std::ostream \&os, {\bf Digest} \&ia)
\end{CompactItemize}


\subsection{Detailed Description}
The digest base class is used for implementing and deriving one way hashing functions.base class for hashing services. 

\begin{Desc}
\item[Author:]David Sugar $<${\tt dyfet@ostel.com}$>$ \end{Desc}




\subsection{Constructor \& Destructor Documentation}
\index{ost::Digest@{ost::Digest}!Digest@{Digest}}
\index{Digest@{Digest}!ost::Digest@{ost::Digest}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::Digest::Digest ()\hspace{0.3cm}{\tt  [protected]}}\label{classost_1_1_digest_5f74be470aaaa4a9208553de6dfce274}




\subsection{Member Function Documentation}
\index{ost::Digest@{ost::Digest}!getDigest@{getDigest}}
\index{getDigest@{getDigest}!ost::Digest@{ost::Digest}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual unsigned ost::Digest::get\-Digest (unsigned char $\ast$ {\em buffer})\hspace{0.3cm}{\tt  [protected, pure virtual]}}\label{classost_1_1_digest_afe56b139e7fb543945b7350a59f44fd}


Copy the binary digest buffer to user memory. 

\begin{Desc}
\item[Returns:]number of bytes in digest. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buffer}]to write into. \end{description}
\end{Desc}


Implemented in {\bf ost::Checksum\-Digest} {\rm (p.\,\pageref{classost_1_1_checksum_digest_49ebb38c76a9997042a1ed46f53c12a4})}, {\bf ost::CRC16Digest} {\rm (p.\,\pageref{classost_1_1_c_r_c16_digest_57217e64cec5486587e88265aa2d78bf})}, {\bf ost::CRC32Digest} {\rm (p.\,\pageref{classost_1_1_c_r_c32_digest_b04d7ae0a9ab46351f441d3a62b6ca98})}, and {\bf ost::MD5Digest} {\rm (p.\,\pageref{classost_1_1_m_d5_digest_1ebd81f1541d9654e8590e478ed3c74b})}.\index{ost::Digest@{ost::Digest}!getSize@{getSize}}
\index{getSize@{getSize}!ost::Digest@{ost::Digest}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual unsigned ost::Digest::get\-Size (void)\hspace{0.3cm}{\tt  [protected, pure virtual]}}\label{classost_1_1_digest_54bddba60131f47fab334a10b31e0850}


Get the size of a digest in octets. 

\begin{Desc}
\item[Returns:]number of bytes in digest. \end{Desc}


Implemented in {\bf ost::Checksum\-Digest} {\rm (p.\,\pageref{classost_1_1_checksum_digest_3db2b1aba8155a14a046f39bd3747a20})}, {\bf ost::CRC16Digest} {\rm (p.\,\pageref{classost_1_1_c_r_c16_digest_a26d12f656b4ed185ed5680e4197faa4})}, {\bf ost::CRC32Digest} {\rm (p.\,\pageref{classost_1_1_c_r_c32_digest_10305cfa59bebc37b56d779493dbc4be})}, and {\bf ost::MD5Digest} {\rm (p.\,\pageref{classost_1_1_m_d5_digest_3b8651f97cfc44fafa597f758eb79a20})}.\index{ost::Digest@{ost::Digest}!initDigest@{initDigest}}
\index{initDigest@{initDigest}!ost::Digest@{ost::Digest}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void ost::Digest::init\-Digest (void)\hspace{0.3cm}{\tt  [pure virtual]}}\label{classost_1_1_digest_fb83ec064689f9351be8b23b76137584}


Reset the digest table to an initial default value. 



Implemented in {\bf ost::Checksum\-Digest} {\rm (p.\,\pageref{classost_1_1_checksum_digest_379e8216ad09a5943d07cb51b6c945e7})}, {\bf ost::CRC16Digest} {\rm (p.\,\pageref{classost_1_1_c_r_c16_digest_92728e477621a3ce53bd2bb84f7c0c16})}, {\bf ost::CRC32Digest} {\rm (p.\,\pageref{classost_1_1_c_r_c32_digest_f5db909388169c71b241aa80468aca19})}, and {\bf ost::MD5Digest} {\rm (p.\,\pageref{classost_1_1_m_d5_digest_bb49416f33a850620bb6e7ad70d77af6})}.\index{ost::Digest@{ost::Digest}!putDigest@{putDigest}}
\index{putDigest@{putDigest}!ost::Digest@{ost::Digest}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void ost::Digest::put\-Digest (const unsigned char $\ast$ {\em buffer}, unsigned {\em length})\hspace{0.3cm}{\tt  [protected, pure virtual]}}\label{classost_1_1_digest_a7d1b98a1a6c5c81c730dae029ef33b6}


Put data into the digest bypassing the stream subsystem. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buffer}]to read from. \item[{\em length}]of data. \end{description}
\end{Desc}


Implemented in {\bf ost::Checksum\-Digest} {\rm (p.\,\pageref{classost_1_1_checksum_digest_084929691dbd2bbaad34da37bde01321})}, {\bf ost::CRC16Digest} {\rm (p.\,\pageref{classost_1_1_c_r_c16_digest_a572b17f2451a0f0a4c67e77cf25a0c0})}, {\bf ost::CRC32Digest} {\rm (p.\,\pageref{classost_1_1_c_r_c32_digest_2eaff9b0e5fa824b8f16c69b673b3174})}, and {\bf ost::MD5Digest} {\rm (p.\,\pageref{classost_1_1_m_d5_digest_95b392cae2a51f06a98278f001593dd7})}.\index{ost::Digest@{ost::Digest}!strDigest@{strDigest}}
\index{strDigest@{strDigest}!ost::Digest@{ost::Digest}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual std::ostream\& ost::Digest::str\-Digest (std::ostream \& {\em os})\hspace{0.3cm}{\tt  [protected, pure virtual]}}\label{classost_1_1_digest_f47d1d12e4a3a17949475d0619dbfedc}


print a digest string for export. 

\begin{Desc}
\item[Returns:]string representation of digest. \end{Desc}


Implemented in {\bf ost::Checksum\-Digest} {\rm (p.\,\pageref{classost_1_1_checksum_digest_33a2c583faa4757ff07ce705f8761328})}, {\bf ost::CRC16Digest} {\rm (p.\,\pageref{classost_1_1_c_r_c16_digest_7c5edf77e4f78ae9f556e3ba9dbcb0fd})}, {\bf ost::CRC32Digest} {\rm (p.\,\pageref{classost_1_1_c_r_c32_digest_942cace7a6d62b8758357649648174a8})}, and {\bf ost::MD5Digest} {\rm (p.\,\pageref{classost_1_1_m_d5_digest_da86b9bb0c35de81622c2ace92d543ad})}.

\subsection{Friends And Related Function Documentation}
\index{ost::Digest@{ost::Digest}!operator<<@{operator$<$$<$}}
\index{operator<<@{operator$<$$<$}!ost::Digest@{ost::Digest}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}std::ostream\& operator$<$$<$ (std::ostream \& {\em os}, {\bf Digest} \& {\em ia})\hspace{0.3cm}{\tt  [friend]}}\label{classost_1_1_digest_f2324d0c454efb54bf984dcd75761c1e}




The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
{\bf digest.h}\end{CompactItemize}