<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>xrootd: XrdCksCalc Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">xrootd
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classXrdCksCalc-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">XrdCksCalc Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="XrdCksCalc_8hh_source.html">XrdCksCalc.hh</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a541bada360ea97aa5940fbd52d76984d"><td class="memItemLeft" align="right" valign="top">virtual char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCksCalc.html#a541bada360ea97aa5940fbd52d76984d">Calc</a> (const char *Buff, int BLen)</td></tr>
<tr class="separator:a541bada360ea97aa5940fbd52d76984d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a644f843a78444815d39165e130f10406"><td class="memItemLeft" align="right" valign="top">virtual char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCksCalc.html#a644f843a78444815d39165e130f10406">Current</a> ()</td></tr>
<tr class="separator:a644f843a78444815d39165e130f10406"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0032ff367bfc84b095249d2537d3348a"><td class="memItemLeft" align="right" valign="top">virtual char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCksCalc.html#a0032ff367bfc84b095249d2537d3348a">Final</a> ()=0</td></tr>
<tr class="separator:a0032ff367bfc84b095249d2537d3348a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa7180c05f044f4c7be77f5c64a99031d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCksCalc.html#aa7180c05f044f4c7be77f5c64a99031d">Init</a> ()=0</td></tr>
<tr class="separator:aa7180c05f044f4c7be77f5c64a99031d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab854918d4d91d390a4723bf5d12bd8f6"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classXrdCksCalc.html">XrdCksCalc</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCksCalc.html#ab854918d4d91d390a4723bf5d12bd8f6">New</a> ()=0</td></tr>
<tr class="separator:ab854918d4d91d390a4723bf5d12bd8f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9690fac85e9c2eddf6590f698ce6bc99"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCksCalc.html#a9690fac85e9c2eddf6590f698ce6bc99">Recycle</a> ()</td></tr>
<tr class="memdesc:a9690fac85e9c2eddf6590f698ce6bc99"><td class="mdescLeft"> </td><td class="mdescRight">Recycle the checksum object as it is no longer needed. A default is given. <a href="#a9690fac85e9c2eddf6590f698ce6bc99">More...</a><br/></td></tr>
<tr class="separator:a9690fac85e9c2eddf6590f698ce6bc99"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a64375eac4cacadcab8fa158bfdc38ab3"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCksCalc.html#a64375eac4cacadcab8fa158bfdc38ab3">Type</a> (int &csSize)=0</td></tr>
<tr class="separator:a64375eac4cacadcab8fa158bfdc38ab3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b5258650fe6dda176592325e108d976"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCksCalc.html#a1b5258650fe6dda176592325e108d976">Update</a> (const char *Buff, int BLen)=0</td></tr>
<tr class="separator:a1b5258650fe6dda176592325e108d976"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ade72fe59207fef0578e59f4c85a2af21"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCksCalc.html#ade72fe59207fef0578e59f4c85a2af21">XrdCksCalc</a> ()</td></tr>
<tr class="memdesc:ade72fe59207fef0578e59f4c85a2af21"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#ade72fe59207fef0578e59f4c85a2af21">More...</a><br/></td></tr>
<tr class="separator:ade72fe59207fef0578e59f4c85a2af21"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac31b0a5d93ca9700b3c92108e0dddde3"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCksCalc.html#ac31b0a5d93ca9700b3c92108e0dddde3">~XrdCksCalc</a> ()</td></tr>
<tr class="memdesc:ac31b0a5d93ca9700b3c92108e0dddde3"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ac31b0a5d93ca9700b3c92108e0dddde3">More...</a><br/></td></tr>
<tr class="separator:ac31b0a5d93ca9700b3c92108e0dddde3"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class defines the interface to a checksum computation. When this class is used to define a plugin computation, the initial <a class="el" href="classXrdCksCalc.html">XrdCksCalc</a> computation object is created by the XrdCksCalcInit() function defined at the end of this file. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="ade72fe59207fef0578e59f4c85a2af21"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">XrdCksCalc::XrdCksCalc </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<a class="anchor" id="ac31b0a5d93ca9700b3c92108e0dddde3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual XrdCksCalc::~XrdCksCalc </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a541bada360ea97aa5940fbd52d76984d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual char* XrdCksCalc::Calc </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>Buff</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>BLen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculate a one-time checksum. The obvious default implementation is provided and assumes that <a class="el" href="classXrdCksCalc.html#aa7180c05f044f4c7be77f5c64a99031d">Init()</a> may be called more than once.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Buff</td><td>-> Data to be checksummed. </td></tr>
<tr><td class="paramname">BLen</td><td>-> Length of the data in Buff.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the checksum value in binary format. The pointer to the value becomes invalid once the associated object is deleted. </dd></dl>
<p>References <a class="el" href="classXrdCksCalc.html#a0032ff367bfc84b095249d2537d3348a">Final()</a>, <a class="el" href="classXrdCksCalc.html#aa7180c05f044f4c7be77f5c64a99031d">Init()</a>, and <a class="el" href="classXrdCksCalc.html#a1b5258650fe6dda176592325e108d976">Update()</a>.</p>
</div>
</div>
<a class="anchor" id="a644f843a78444815d39165e130f10406"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual char* XrdCksCalc::Current </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current binary checksum value (defaults to final). However, the final checksum result is not affected.</p>
<dl class="section return"><dt>Returns</dt><dd>the checksum value in binary format. The pointer to the value becomes invalid once the associated object is deleted. </dd></dl>
<p>References <a class="el" href="classXrdCksCalc.html#a0032ff367bfc84b095249d2537d3348a">Final()</a>.</p>
</div>
</div>
<a class="anchor" id="a0032ff367bfc84b095249d2537d3348a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual char* XrdCksCalc::Final </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the actual checksum in binary format.</p>
<dl class="section return"><dt>Returns</dt><dd>the checksum value in binary format. The pointer to the value becomes invalid once the associated object is deleted. </dd></dl>
<p>Referenced by <a class="el" href="classXrdCksCalc.html#a541bada360ea97aa5940fbd52d76984d">Calc()</a>, and <a class="el" href="classXrdCksCalc.html#a644f843a78444815d39165e130f10406">Current()</a>.</p>
</div>
</div>
<a class="anchor" id="aa7180c05f044f4c7be77f5c64a99031d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void XrdCksCalc::Init </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes data structures (must be called by constructor). This is always called to reuse the object for a new checksum. </p>
<p>Referenced by <a class="el" href="classXrdCksCalc.html#a541bada360ea97aa5940fbd52d76984d">Calc()</a>.</p>
</div>
</div>
<a class="anchor" id="ab854918d4d91d390a4723bf5d12bd8f6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classXrdCksCalc.html">XrdCksCalc</a>* XrdCksCalc::New </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a new instance of the underlying checksum calculation object.</p>
<dl class="section return"><dt>Returns</dt><dd>the checksum calculation object. </dd></dl>
</div>
</div>
<a class="anchor" id="a9690fac85e9c2eddf6590f698ce6bc99"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void XrdCksCalc::Recycle </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Recycle the checksum object as it is no longer needed. A default is given. </p>
</div>
</div>
<a class="anchor" id="a64375eac4cacadcab8fa158bfdc38ab3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* XrdCksCalc::Type </td>
<td>(</td>
<td class="paramtype">int & </td>
<td class="paramname"><em>csSize</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the checksum object algorithm name and the number bytes (i.e. size) required for the checksum value.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">csSize</td><td>-> Parameter to hold the size of the checksum value.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the checksum algorithm's name. The name persists event after the checksum object is deleted. </dd></dl>
</div>
</div>
<a class="anchor" id="a1b5258650fe6dda176592325e108d976"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void XrdCksCalc::Update </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>Buff</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>BLen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Compute a running checksum. This method may be called repeatedly for data segments; with <a class="el" href="classXrdCksCalc.html#a0032ff367bfc84b095249d2537d3348a">Final()</a> returning the full checksum.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Buff</td><td>-> Data to be checksummed. </td></tr>
<tr><td class="paramname">BLen</td><td>-> Length of the data in Buff. </td></tr>
</table>
</dd>
</dl>
<p>Referenced by <a class="el" href="classXrdCksCalc.html#a541bada360ea97aa5940fbd52d76984d">Calc()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XrdCksCalc_8hh_source.html">XrdCksCalc.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
distrib
>
Fedora
>
18
>
x86_64
>
media
>
updates
>
by-pkgid
>
749e483016bbc41594aeb77eb13e3491
>
files
>
523
