Sophie

Sophie

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

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::Monitor 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_1Monitor.html">Monitor</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classXrdCl_1_1Monitor-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">XrdCl::Monitor Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>An abstract class to describe the client-side monitoring plugin interface.  
 <a href="classXrdCl_1_1Monitor.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="XrdClMonitor_8hh_source.html">XrdClMonitor.hh</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXrdCl_1_1Monitor_1_1CheckSumInfo.html">CheckSumInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Describe a checksum event.  <a href="structXrdCl_1_1Monitor_1_1CheckSumInfo.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXrdCl_1_1Monitor_1_1CloseInfo.html">CloseInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Describe a file close event.  <a href="structXrdCl_1_1Monitor_1_1CloseInfo.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXrdCl_1_1Monitor_1_1ConnectInfo.html">ConnectInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Describe a server login event.  <a href="structXrdCl_1_1Monitor_1_1ConnectInfo.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXrdCl_1_1Monitor_1_1CopyBInfo.html">CopyBInfo</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXrdCl_1_1Monitor_1_1CopyEInfo.html">CopyEInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Describe an end of copy event.  <a href="structXrdCl_1_1Monitor_1_1CopyEInfo.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXrdCl_1_1Monitor_1_1DisconnectInfo.html">DisconnectInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Describe a server logout event.  <a href="structXrdCl_1_1Monitor_1_1DisconnectInfo.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXrdCl_1_1Monitor_1_1ErrorInfo.html">ErrorInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Describe an encountered file-based error.  <a href="structXrdCl_1_1Monitor_1_1ErrorInfo.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXrdCl_1_1Monitor_1_1OpenInfo.html">OpenInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Describe a file open event to the monitor.  <a href="structXrdCl_1_1Monitor_1_1OpenInfo.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXrdCl_1_1Monitor_1_1TransferInfo.html">TransferInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Describe the transfer.  <a href="structXrdCl_1_1Monitor_1_1TransferInfo.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aed73f723ecfbcd32bd6a35242919b991"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1Monitor.html#aed73f723ecfbcd32bd6a35242919b991">EventCode</a> { <br/>
&#160;&#160;<a class="el" href="classXrdCl_1_1Monitor.html#aed73f723ecfbcd32bd6a35242919b991a1a221433c374a896487970bef2521e7a">EvCopyBeg</a>, 
<a class="el" href="classXrdCl_1_1Monitor.html#aed73f723ecfbcd32bd6a35242919b991a7cb92047ca3e010411fce3f6a3780bd9">EvCopyEnd</a>, 
<a class="el" href="classXrdCl_1_1Monitor.html#aed73f723ecfbcd32bd6a35242919b991a7e0d890f890ea21adea85ff8e52bae22">EvCheckSum</a>, 
<a class="el" href="classXrdCl_1_1Monitor.html#aed73f723ecfbcd32bd6a35242919b991a9d41c6f521a763dd7578d7610f305e05">EvOpen</a>, 
<br/>
&#160;&#160;<a class="el" href="classXrdCl_1_1Monitor.html#aed73f723ecfbcd32bd6a35242919b991a46120165fa7a31129d30b42c3ad62d93">EvClose</a>, 
<a class="el" href="classXrdCl_1_1Monitor.html#aed73f723ecfbcd32bd6a35242919b991a914b706b01a06856c7a56ad3d5a7e6b1">EvErrIO</a>, 
<a class="el" href="classXrdCl_1_1Monitor.html#aed73f723ecfbcd32bd6a35242919b991add9617dbff18744fd27a740a899d146a">EvConnect</a>, 
<a class="el" href="classXrdCl_1_1Monitor.html#aed73f723ecfbcd32bd6a35242919b991a3291500590ff5ca0eddbfe7ae64c9c2c">EvDisconnect</a>
<br/>
 }</td></tr>
<tr class="separator:aed73f723ecfbcd32bd6a35242919b991"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:ab873d512b39577a333e163e8afea6d1f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1Monitor.html#ab873d512b39577a333e163e8afea6d1f">Monitor</a> ()</td></tr>
<tr class="memdesc:ab873d512b39577a333e163e8afea6d1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#ab873d512b39577a333e163e8afea6d1f">More...</a><br/></td></tr>
<tr class="separator:ab873d512b39577a333e163e8afea6d1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa8ffc223d37336813736856e946a470"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1Monitor.html#aaa8ffc223d37336813736856e946a470">~Monitor</a> ()</td></tr>
<tr class="memdesc:aaa8ffc223d37336813736856e946a470"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#aaa8ffc223d37336813736856e946a470">More...</a><br/></td></tr>
<tr class="separator:aaa8ffc223d37336813736856e946a470"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb7a921ef75098104471d02dfffc66e7"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1Monitor.html#afb7a921ef75098104471d02dfffc66e7">Event</a> (<a class="el" href="classXrdCl_1_1Monitor.html#aed73f723ecfbcd32bd6a35242919b991">EventCode</a> evCode, void *evData)=0</td></tr>
<tr class="separator:afb7a921ef75098104471d02dfffc66e7"><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>An abstract class to describe the client-side monitoring plugin interface. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="aed73f723ecfbcd32bd6a35242919b991"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classXrdCl_1_1Monitor.html#aed73f723ecfbcd32bd6a35242919b991">XrdCl::Monitor::EventCode</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Event codes passed to the <a class="el" href="classXrdCl_1_1Monitor.html#afb7a921ef75098104471d02dfffc66e7">Event()</a> method. Event code values not listed here, if encountered, should be ignored. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="aed73f723ecfbcd32bd6a35242919b991a1a221433c374a896487970bef2521e7a"></a>EvCopyBeg</em>&nbsp;</td><td class="fielddoc">
<p><a class="el" href="structXrdCl_1_1Monitor_1_1CopyBInfo.html">CopyBInfo</a>: Copy operation started. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="aed73f723ecfbcd32bd6a35242919b991a7cb92047ca3e010411fce3f6a3780bd9"></a>EvCopyEnd</em>&nbsp;</td><td class="fielddoc">
<p><a class="el" href="structXrdCl_1_1Monitor_1_1CopyEInfo.html" title="Describe an end of copy event.">CopyEInfo</a>: Copy operation ended. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="aed73f723ecfbcd32bd6a35242919b991a7e0d890f890ea21adea85ff8e52bae22"></a>EvCheckSum</em>&nbsp;</td><td class="fielddoc">
<p><a class="el" href="structXrdCl_1_1Monitor_1_1CheckSumInfo.html" title="Describe a checksum event.">CheckSumInfo</a>: <a class="el" href="classXrdCl_1_1File.html" title="A file.">File</a> checksummed. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="aed73f723ecfbcd32bd6a35242919b991a9d41c6f521a763dd7578d7610f305e05"></a>EvOpen</em>&nbsp;</td><td class="fielddoc">
<p><a class="el" href="structXrdCl_1_1Monitor_1_1OpenInfo.html" title="Describe a file open event to the monitor.">OpenInfo</a>: <a class="el" href="classXrdCl_1_1File.html" title="A file.">File</a> opened. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="aed73f723ecfbcd32bd6a35242919b991a46120165fa7a31129d30b42c3ad62d93"></a>EvClose</em>&nbsp;</td><td class="fielddoc">
<p><a class="el" href="structXrdCl_1_1Monitor_1_1CloseInfo.html" title="Describe a file close event.">CloseInfo</a>: <a class="el" href="classXrdCl_1_1File.html" title="A file.">File</a> closed. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="aed73f723ecfbcd32bd6a35242919b991a914b706b01a06856c7a56ad3d5a7e6b1"></a>EvErrIO</em>&nbsp;</td><td class="fielddoc">
<p><a class="el" href="structXrdCl_1_1Monitor_1_1ErrorInfo.html" title="Describe an encountered file-based error.">ErrorInfo</a>: An I/O error occurred. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="aed73f723ecfbcd32bd6a35242919b991add9617dbff18744fd27a740a899d146a"></a>EvConnect</em>&nbsp;</td><td class="fielddoc">
<p><a class="el" href="structXrdCl_1_1Monitor_1_1ConnectInfo.html" title="Describe a server login event.">ConnectInfo</a>: Login into a server. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="aed73f723ecfbcd32bd6a35242919b991a3291500590ff5ca0eddbfe7ae64c9c2c"></a>EvDisconnect</em>&nbsp;</td><td class="fielddoc">
<p><a class="el" href="structXrdCl_1_1Monitor_1_1DisconnectInfo.html" title="Describe a server logout event.">DisconnectInfo</a>: Logout from a server. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ab873d512b39577a333e163e8afea6d1f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">XrdCl::Monitor::Monitor </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="aaa8ffc223d37336813736856e946a470"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual XrdCl::Monitor::~Monitor </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="afb7a921ef75098104471d02dfffc66e7"></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::Monitor::Event </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classXrdCl_1_1Monitor.html#aed73f723ecfbcd32bd6a35242919b991">EventCode</a>&#160;</td>
          <td class="paramname"><em>evCode</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>evData</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>Inform the monitor of an event.</p>
<p>evCode is the event that occurred (see enum evNum)  evInfo is the event information structure describing the event it is cast to (void *) so that one method can be used and should be recast to the correct corresponding struct </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XrdClMonitor_8hh_source.html">XrdClMonitor.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