<!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: XrdClientAbsMonIntf.hh Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_a463079fa6e81dce85c7d5903b67b82e.html">XrdClient</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">XrdClientAbsMonIntf.hh</div> </div>
</div><!--header-->
<div class="contents">
<a href="XrdClientAbsMonIntf_8hh.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef __XRDCLIABSMONINTF_H__</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor"></span><span class="preprocessor">#define __XRDCLIABSMONINTF_H__</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor"></span><span class="comment">/******************************************************************************/</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/* */</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">/* X r d C l i e n t A b s M o n I n t f . h h */</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">/* */</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">/* This file is part of the XRootD software suite. */</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">/* */</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">/* XRootD is free software: you can redistribute it and/or modify it under */</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">/* the terms of the GNU Lesser General Public License as published by the */</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">/* Free Software Foundation, either version 3 of the License, or (at your */</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">/* option) any later version. */</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">/* */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">/* XRootD is distributed in the hope that it will be useful, but WITHOUT */</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">/* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or */</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">/* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public */</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">/* License for more details. */</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">/* */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">/* You should have received a copy of the GNU Lesser General Public License */</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file */</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">/* COPYING (GPL license). If not, see <http://www.gnu.org/licenses/>. */</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">/* */</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">/* The copyright holder's institutional names and contributor's names may not */</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">/* be used to endorse or promote products derived from this software without */</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/* specific prior written permission of the institution or contributor. */</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">/******************************************************************************/</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// XrdClientAbsMonIntf</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// Public interface to generic monitoring systems</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">//</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="code" href="classXrdClientAbsMonIntf.html"> 32</a></span> <span class="keyword">class </span><a class="code" href="classXrdClientAbsMonIntf.html">XrdClientAbsMonIntf</a> {</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="comment">// Initialization of the external library</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classXrdClientAbsMonIntf.html#a3537dba015e82d20ffd098e474020ecb">Init</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *src, <span class="keyword">const</span> <span class="keywordtype">char</span> *dest, <span class="keywordtype">int</span> debug=0, <span class="keywordtype">void</span> *parm=0) = 0;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classXrdClientAbsMonIntf.html#af780b452e04304fc1da8bfb97c5675af">DeInit</a>() = 0;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="comment">// To get the name of the library and other info</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classXrdClientAbsMonIntf.html#a62d92a4b0ea3ea2fcc29eaeb4773f4a1">GetMonLibInfo</a>(<span class="keywordtype">char</span> **name, <span class="keywordtype">char</span> **version, <span class="keywordtype">char</span> **remarks) = 0;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="comment">// To submit a set of info about the progress of something</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="comment">// Set force to true to be sure that the info is sent and not eventually skipped</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classXrdClientAbsMonIntf.html#a698599286030d310bac25b2242f4ff32">PutProgressInfo</a>(<span class="keywordtype">long</span> <span class="keywordtype">long</span> bytecount=0,</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">long</span> <span class="keywordtype">long</span> size=0,</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">float</span> percentage=0.0,</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">bool</span> force=<span class="keyword">false</span>) = 0;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="code" href="classXrdClientAbsMonIntf.html#a1186633062661d3346cd15cd4d37401b"> 52</a></span>  <a class="code" href="classXrdClientAbsMonIntf.html#a1186633062661d3346cd15cd4d37401b">XrdClientAbsMonIntf</a>() {};</div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="code" href="classXrdClientAbsMonIntf.html#af62df806ae7324d56b84fe68a163cc69"> 53</a></span>  <span class="keyword">virtual</span> <a class="code" href="classXrdClientAbsMonIntf.html#af62df806ae7324d56b84fe68a163cc69">~XrdClientAbsMonIntf</a>() {};</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> };</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">/******************************************************************************/</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">/* X r d C l i e n t A b s M o n I n t f . h h */</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">/******************************************************************************/</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">// The XrdClientMonIntf() function is called when the shared library containing</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">// implementation of this class is loaded. It must exist in the library as an</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment">// 'extern "C"' defined function.</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a name="l00068"></a><span class="lineno"><a class="code" href="XrdClientAbsMonIntf_8hh.html#aaff8a39092a7fecd87f4227c3d94758d"> 68</a></span> <span class="preprocessor">#define XrdClientMonIntfArgs const char *src, const char *dst</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
<div class="line"><a name="l00071"></a><span class="lineno"><a class="code" href="XrdClientAbsMonIntf_8hh.html#aa9451aec21f9f35463a3c7f6a8b412b3"> 71</a></span>  <span class="keyword">typedef</span> <a class="code" href="classXrdClientAbsMonIntf.html">XrdClientAbsMonIntf</a> *(*XrdClientMonIntfHook)(<a class="code" href="XrdClientAbsMonIntf_8hh.html#aaff8a39092a7fecd87f4227c3d94758d">XrdClientMonIntfArgs</a>);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <a class="code" href="classXrdClientAbsMonIntf.html">XrdClientAbsMonIntf</a> *<a class="code" href="XrdClientAbsMonIntf_8hh.html#a87572537d682af52630fdc7c836bad92">XrdClientgetMonIntf</a>(<a class="code" href="XrdClientAbsMonIntf_8hh.html#aaff8a39092a7fecd87f4227c3d94758d">XrdClientMonIntfArgs</a>);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> }</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></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
>
159
