Sophie

Sophie

distrib > Fedora > 18 > x86_64 > media > updates > by-pkgid > 749e483016bbc41594aeb77eb13e3491 > files > 573

xrootd-doc-3.3.5-1.fc18.noarch.rpm

<!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: XrdCl::CopyProgressHandler 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&#160;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&#160;List</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceXrdCl.html">XrdCl</a></li><li class="navelem"><a class="el" href="classXrdCl_1_1CopyProgressHandler.html">CopyProgressHandler</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classXrdCl_1_1CopyProgressHandler-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">XrdCl::CopyProgressHandler Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Interface for copy progress notification.  
 <a href="classXrdCl_1_1CopyProgressHandler.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="XrdClCopyProcess_8hh_source.html">XrdClCopyProcess.hh</a>&gt;</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:a1ba807a269b65fcd1a09124986c38649"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1CopyProgressHandler.html#a1ba807a269b65fcd1a09124986c38649">~CopyProgressHandler</a> ()</td></tr>
<tr class="separator:a1ba807a269b65fcd1a09124986c38649"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d5ad9b19adc1bda3c73b12855d4a9b3"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1CopyProgressHandler.html#a0d5ad9b19adc1bda3c73b12855d4a9b3">BeginJob</a> (uint16_t jobNum, uint16_t jobTotal, const <a class="el" href="classXrdCl_1_1URL.html">URL</a> *source, const <a class="el" href="classXrdCl_1_1URL.html">URL</a> *destination)=0</td></tr>
<tr class="separator:a0d5ad9b19adc1bda3c73b12855d4a9b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51eafcf5e8108524a810e226e2c58abd"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1CopyProgressHandler.html#a51eafcf5e8108524a810e226e2c58abd">EndJob</a> (const <a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> &amp;status)=0</td></tr>
<tr class="separator:a51eafcf5e8108524a810e226e2c58abd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfc951c0de3c26c0916b717e07a497dc"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1CopyProgressHandler.html#abfc951c0de3c26c0916b717e07a497dc">JobProgress</a> (uint64_t bytesProcessed, uint64_t bytesTotal)=0</td></tr>
<tr class="separator:abfc951c0de3c26c0916b717e07a497dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Interface for copy progress notification. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a1ba807a269b65fcd1a09124986c38649"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual XrdCl::CopyProgressHandler::~CopyProgressHandler </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">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a0d5ad9b19adc1bda3c73b12855d4a9b3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void XrdCl::CopyProgressHandler::BeginJob </td>
          <td>(</td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>jobNum</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>jobTotal</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classXrdCl_1_1URL.html">URL</a> *&#160;</td>
          <td class="paramname"><em>source</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classXrdCl_1_1URL.html">URL</a> *&#160;</td>
          <td class="paramname"><em>destination</em>&#160;</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>Notify when a new job is about to start</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">jobNum</td><td>the job number of the copy job concerned </td></tr>
    <tr><td class="paramname">jobTotal</td><td>total number of jobs being processed </td></tr>
    <tr><td class="paramname">source</td><td>the source url of the current job </td></tr>
    <tr><td class="paramname">destination</td><td>the destination url of the current job </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a51eafcf5e8108524a810e226e2c58abd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void XrdCl::CopyProgressHandler::EndJob </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> &amp;&#160;</td>
          <td class="paramname"><em>status</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>Notify when the previous job has finished</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">status</td><td>status of the job </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="abfc951c0de3c26c0916b717e07a497dc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void XrdCl::CopyProgressHandler::JobProgress </td>
          <td>(</td>
          <td class="paramtype">uint64_t&#160;</td>
          <td class="paramname"><em>bytesProcessed</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint64_t&#160;</td>
          <td class="paramname"><em>bytesTotal</em>&#160;</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>Notify about the progress of the current job</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">bytesProcessed</td><td>bytes processed by the current job </td></tr>
    <tr><td class="paramname">bytesTotal</td><td>total number of bytes to be processed by the current job </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XrdClCopyProcess_8hh_source.html">XrdClCopyProcess.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional