Sophie

Sophie

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

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::CopyJob 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_1CopyJob.html">CopyJob</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classXrdCl_1_1CopyJob-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">XrdCl::CopyJob Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Copy job.  
 <a href="classXrdCl_1_1CopyJob.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="XrdClCopyProcess_8hh_source.html">XrdClCopyProcess.hh</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for XrdCl::CopyJob:</div>
<div class="dyncontent">
<div class="center"><img src="classXrdCl_1_1CopyJob__coll__graph.png" border="0" usemap="#XrdCl_1_1CopyJob_coll__map" alt="Collaboration graph"/></div>
<map name="XrdCl_1_1CopyJob_coll__map" id="XrdCl_1_1CopyJob_coll__map">
<area shape="rect" id="node2" href="structXrdCl_1_1JobDescriptor.html" title="Job description." alt="" coords="36,203,180,229"/><area shape="rect" id="node4" href="classXrdCl_1_1URL.html" title="URL representation." alt="" coords="5,83,96,109"/><area shape="rect" id="node6" href="classXrdCl_1_1XRootDStatus.html" title="Request status." alt="" coords="121,83,268,109"/><area shape="rect" id="node8" href="structXrdCl_1_1Status.html" title="Procedure execution status." alt="" coords="144,5,245,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:a815a8c531c93488049ec978dcc65629e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1CopyJob.html#a815a8c531c93488049ec978dcc65629e">CopyJob</a> (<a class="el" href="structXrdCl_1_1JobDescriptor.html">JobDescriptor</a> *jobDesc)</td></tr>
<tr class="memdesc:a815a8c531c93488049ec978dcc65629e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a815a8c531c93488049ec978dcc65629e">More...</a><br/></td></tr>
<tr class="separator:a815a8c531c93488049ec978dcc65629e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15eb4e06717a7ddbf9dc740abe71324b"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1CopyJob.html#a15eb4e06717a7ddbf9dc740abe71324b">~CopyJob</a> ()</td></tr>
<tr class="memdesc:a15eb4e06717a7ddbf9dc740abe71324b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor.  <a href="#a15eb4e06717a7ddbf9dc740abe71324b">More...</a><br/></td></tr>
<tr class="separator:a15eb4e06717a7ddbf9dc740abe71324b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b7b6605c4657474af7d82cd17458477"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1CopyJob.html#a5b7b6605c4657474af7d82cd17458477">Run</a> (<a class="el" href="classXrdCl_1_1CopyProgressHandler.html">CopyProgressHandler</a> *progress=0)=0</td></tr>
<tr class="separator:a5b7b6605c4657474af7d82cd17458477"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a420941f2564b5bd2688a0736a258447b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structXrdCl_1_1JobDescriptor.html">JobDescriptor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1CopyJob.html#a420941f2564b5bd2688a0736a258447b">GetDescriptor</a> () const </td></tr>
<tr class="memdesc:a420941f2564b5bd2688a0736a258447b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the job descriptor.  <a href="#a420941f2564b5bd2688a0736a258447b">More...</a><br/></td></tr>
<tr class="separator:a420941f2564b5bd2688a0736a258447b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:aaf96d358a329a387645d3ca3405838ec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structXrdCl_1_1JobDescriptor.html">JobDescriptor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1CopyJob.html#aaf96d358a329a387645d3ca3405838ec">pJob</a></td></tr>
<tr class="separator:aaf96d358a329a387645d3ca3405838ec"><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>Copy job. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a815a8c531c93488049ec978dcc65629e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">XrdCl::CopyJob::CopyJob </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structXrdCl_1_1JobDescriptor.html">JobDescriptor</a> *&#160;</td>
          <td class="paramname"><em>jobDesc</em></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="a15eb4e06717a7ddbf9dc740abe71324b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual XrdCl::CopyJob::~CopyJob </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>Virtual destructor. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a420941f2564b5bd2688a0736a258447b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structXrdCl_1_1JobDescriptor.html">JobDescriptor</a>* XrdCl::CopyJob::GetDescriptor </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</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>Get the job descriptor. </p>

<p>References <a class="el" href="classXrdCl_1_1CopyJob.html#aaf96d358a329a387645d3ca3405838ec">pJob</a>.</p>

</div>
</div>
<a class="anchor" id="a5b7b6605c4657474af7d82cd17458477"></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="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> XrdCl::CopyJob::Run </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classXrdCl_1_1CopyProgressHandler.html">CopyProgressHandler</a> *&#160;</td>
          <td class="paramname"><em>progress</em> = <code>0</code></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>Run the copy job</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">progress</td><td>the handler to be notified about the copy progress </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status of the copy operation </dd></dl>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aaf96d358a329a387645d3ca3405838ec"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structXrdCl_1_1JobDescriptor.html">JobDescriptor</a>* XrdCl::CopyJob::pJob</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Referenced by <a class="el" href="classXrdCl_1_1CopyJob.html#a420941f2564b5bd2688a0736a258447b">GetDescriptor()</a>.</p>

</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>