<!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: XrdProtocol.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_2fc975d10fd046c0995d766b5e58ab38.html">Xrd</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">XrdProtocol.hh</div> </div>
</div><!--header-->
<div class="contents">
<a href="XrdProtocol_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 __XrdProtocol_H__</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor"></span><span class="preprocessor">#define __XrdProtocol_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 P r o t o c o l . 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">/* (c) 2004 by the Board of Trustees of the Leland Stanford, Jr., University */</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">/* Produced by Andrew Hanushevsky for Stanford University under contract */</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">/* DE-AC02-76-SFO0515 with the Department of Energy */</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">/* */</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">/* This file is part of the XRootD software suite. */</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">/* */</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">/* XRootD is free software: you can redistribute it and/or modify it under */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">/* the terms of the GNU Lesser General Public License as published by the */</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">/* Free Software Foundation, either version 3 of the License, or (at your */</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">/* option) any later version. */</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">/* */</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">/* XRootD is distributed in the hope that it will be useful, but WITHOUT */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">/* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or */</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">/* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public */</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">/* License for more details. */</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">/* You should have received a copy of the GNU Lesser General Public License */</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file */</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/* COPYING (GPL license). If not, see <http://www.gnu.org/licenses/>. */</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> <span class="comment">/* The copyright holder's institutional names and contributor's names may not */</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">/* be used to endorse or promote products derived from this software without */</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">/* specific prior written permission of the institution or contributor. */</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"> 32</span> <span class="preprocessor">#include "<a class="code" href="XrdJob_8hh.html">Xrd/XrdJob.hh</a>"</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">/******************************************************************************/</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">/* X r d P r o t o c o l _ C o n f i g */</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/******************************************************************************/</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">// The following class is passed to the XrdgetProtocol() and XrdgetProtocolPort()</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// functions to properly configure the protocol. This object is not stable and </span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// the protocol must copy out any values it desires to keep. It may copy the </span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// whole object using the supplied copy constructor.</span></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> <span class="keyword">class </span><a class="code" href="classXrdSysError.html">XrdSysError</a>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">class </span><a class="code" href="classXrdOucTrace.html">XrdOucTrace</a>;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">class </span><a class="code" href="classXrdBuffManager.html">XrdBuffManager</a>;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">class </span>XrdInet;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">class </span><a class="code" href="classXrdScheduler.html">XrdScheduler</a>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">class </span>XrdStats;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">struct </span>sockaddr;</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="classXrdProtocol__Config.html"> 52</a></span> <span class="keyword">class </span><a class="code" href="classXrdProtocol__Config.html">XrdProtocol_Config</a></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> {</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">public</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> <span class="comment">// The following pointers may be copied; they are stable.</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">//</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#a643f19f033729d7ef0e1ab26196b6664"> 58</a></span> <a class="code" href="classXrdSysError.html">XrdSysError</a> *<a class="code" href="classXrdProtocol__Config.html#a643f19f033729d7ef0e1ab26196b6664">eDest</a>; <span class="comment">// Stable -> Error Message/Logging Handler</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#a1a0d9fc21bf5ecdf2dec40a20b60b301"> 59</a></span> XrdInet *<a class="code" href="classXrdProtocol__Config.html#a1a0d9fc21bf5ecdf2dec40a20b60b301">NetTCP</a>; <span class="comment">// Stable -> Network Object (@ XrdgetProtocol)</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#a1171c2d3518d11de225d35a7ea8860e6"> 60</a></span> <a class="code" href="classXrdBuffManager.html">XrdBuffManager</a> *<a class="code" href="classXrdProtocol__Config.html#a1171c2d3518d11de225d35a7ea8860e6">BPool</a>; <span class="comment">// Stable -> Buffer Pool Manager</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#a14f0ba70ab90b31467b7c45596f1e32c"> 61</a></span> <a class="code" href="classXrdScheduler.html">XrdScheduler</a> *<a class="code" href="classXrdProtocol__Config.html#a14f0ba70ab90b31467b7c45596f1e32c">Sched</a>; <span class="comment">// Stable -> System Scheduler</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#add6e32bbf68a173739260bcfc66ff336"> 62</a></span> XrdStats *<a class="code" href="classXrdProtocol__Config.html#add6e32bbf68a173739260bcfc66ff336">Stats</a>; <span class="comment">// Stable -> System Statistics (@ XrdgetProtocol)</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#a045367f3afe026dd103a9dd75b149d69"> 63</a></span> <span class="keywordtype">void</span> *<a class="code" href="classXrdProtocol__Config.html#a045367f3afe026dd103a9dd75b149d69">Reserved</a>; <span class="comment">// Stable -> Previously, the thread manager</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#a91cf587d80a34034b59745b4ff4a9509"> 64</a></span> <a class="code" href="classXrdOucTrace.html">XrdOucTrace</a> *<a class="code" href="classXrdProtocol__Config.html#a91cf587d80a34034b59745b4ff4a9509">Trace</a>; <span class="comment">// Stable -> Trace Information</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment">// The following information must be duplicated; it is unstable.</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">//</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#a99c89d0f45ba6cc520e42e44c6af3b50"> 68</a></span> <span class="keywordtype">char</span> *<a class="code" href="classXrdProtocol__Config.html#a99c89d0f45ba6cc520e42e44c6af3b50">ConfigFN</a>; <span class="comment">// -> Configuration file</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#a30c6fb826e3a80f33e46346d02f68876"> 69</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdProtocol__Config.html#a30c6fb826e3a80f33e46346d02f68876">Format</a>; <span class="comment">// Binary format of this server</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#a36034b98e0df94ded0767709d49950ba"> 70</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdProtocol__Config.html#a36034b98e0df94ded0767709d49950ba">Port</a>; <span class="comment">// Port number</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#a261b78d74a6e65b71de7de8a49546463"> 71</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdProtocol__Config.html#a261b78d74a6e65b71de7de8a49546463">WSize</a>; <span class="comment">// Window size for Port</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#a53854f1569b525c6b7f8f851fb7dcb1b"> 72</a></span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classXrdProtocol__Config.html#a53854f1569b525c6b7f8f851fb7dcb1b">AdmPath</a>; <span class="comment">// Admin path</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#a459e53d11e46bf65760fa24e529592f2"> 73</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdProtocol__Config.html#a459e53d11e46bf65760fa24e529592f2">AdmMode</a>; <span class="comment">// Admin path mode</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#a9273bbbc79531bd1165b15323cf5162b"> 74</a></span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classXrdProtocol__Config.html#a9273bbbc79531bd1165b15323cf5162b">myInst</a>; <span class="comment">// Instance name</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#a0b132901cf0812e8e1602f58cbc8a235"> 75</a></span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classXrdProtocol__Config.html#a0b132901cf0812e8e1602f58cbc8a235">myName</a>; <span class="comment">// Host name</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#a8dbd9b6ba96e9f6a9343ddfbe023f7ac"> 76</a></span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classXrdProtocol__Config.html#a8dbd9b6ba96e9f6a9343ddfbe023f7ac">myProg</a>; <span class="comment">// Program name</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#a640900746d5b60a26bd0949776ddb0fc"> 77</a></span> <span class="keyword">struct </span>sockaddr *<a class="code" href="classXrdProtocol__Config.html#a640900746d5b60a26bd0949776ddb0fc">myAddr</a>; <span class="comment">// Host address</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#a595f56338c0de2b6ff680f6b2ce91959"> 78</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdProtocol__Config.html#a595f56338c0de2b6ff680f6b2ce91959">ConnMax</a>; <span class="comment">// Max connections</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#acf031ad838e66c8dda46e417021c653a"> 79</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdProtocol__Config.html#acf031ad838e66c8dda46e417021c653a">readWait</a>; <span class="comment">// Max milliseconds to wait for data</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#a52d6923945238a42c8171b977413ce4c"> 80</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdProtocol__Config.html#a52d6923945238a42c8171b977413ce4c">idleWait</a>; <span class="comment">// Max milliseconds connection may be idle</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#ac13b72a5cf47595f40a360b5e76955c4"> 81</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdProtocol__Config.html#ac13b72a5cf47595f40a360b5e76955c4">argc</a>; <span class="comment">// Number of arguments</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#aebe87e9199ee69dbaa3df1342405ab35"> 82</a></span> <span class="keywordtype">char</span> **<a class="code" href="classXrdProtocol__Config.html#aebe87e9199ee69dbaa3df1342405ab35">argv</a>; <span class="comment">// Argument array (prescreened)</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#aefcd124e92e7e2c1775d74bedd286677"> 83</a></span> <span class="keywordtype">char</span> <a class="code" href="classXrdProtocol__Config.html#aefcd124e92e7e2c1775d74bedd286677">DebugON</a>; <span class="comment">// True if started with -d option</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#aa0027263b8b05af514d444e09bd0aec2"> 84</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdProtocol__Config.html#aa0027263b8b05af514d444e09bd0aec2">WANPort</a>; <span class="comment">// Port prefered for WAN connections (0 if none)</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#aac11572bf0a58a962d6df6471b05f05b"> 85</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdProtocol__Config.html#aac11572bf0a58a962d6df6471b05f05b">WANWSize</a>; <span class="comment">// Window size for the WANPort</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#adc32b6a86247c57e8b8ca59a5f6e7f68"> 86</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdProtocol__Config.html#adc32b6a86247c57e8b8ca59a5f6e7f68">hailWait</a>; <span class="comment">// Max milliseconds to wait for data after accept</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="classXrdProtocol__Config.html#a0888d3a6c55a8691dbe3f16e72ddc280">XrdProtocol_Config</a>(<a class="code" href="classXrdProtocol__Config.html">XrdProtocol_Config</a> &rhs);</div>
<div class="line"><a name="l00089"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#a0888d3a6c55a8691dbe3f16e72ddc280"> 89</a></span>  <a class="code" href="classXrdProtocol__Config.html#a0888d3a6c55a8691dbe3f16e72ddc280">XrdProtocol_Config</a>() {}</div>
<div class="line"><a name="l00090"></a><span class="lineno"><a class="code" href="classXrdProtocol__Config.html#a5286104f2d75c06935d0e618caa24bc9"> 90</a></span>  <a class="code" href="classXrdProtocol__Config.html#a5286104f2d75c06935d0e618caa24bc9">~XrdProtocol_Config</a>() {}</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> };</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment">/******************************************************************************/</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment">/* X r d P r o t o c o l */</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment">/******************************************************************************/</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment">// This class is used by the Link object to process the input stream on a link.</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment">// At least one protocol object exists per Link object. Specific protocols are </span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment">// derived from this pure abstract class since a link can use one of several </span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment">// protocols. Indeed, startup and shutdown are handled by specialized protocols.</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment">// System configuration obtains an instance of a protocol by calling</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment">// XrdgetProtocol(), which must exist in the shared library.</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment">// This instance is used as the base pointer for Alloc(), Configure(), and</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment">// Match(). Unfortuantely, they cannot be static given the silly C++ rules.</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="keyword">class </span><a class="code" href="classXrdLink.html">XrdLink</a>;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  </div>
<div class="line"><a name="l00109"></a><span class="lineno"><a class="code" href="classXrdProtocol.html"> 109</a></span> <span class="keyword">class </span><a class="code" href="classXrdProtocol.html">XrdProtocol</a> : <span class="keyword">public</span> <a class="code" href="classXrdJob.html">XrdJob</a></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> {</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment">// Match() is invoked when a new link is created and we are trying</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment">// to determine if this protocol can handle the link. It must</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment">// return a protocol object if it can and NULL (0), otherwise.</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment">//</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="keyword">virtual</span> <a class="code" href="classXrdProtocol.html">XrdProtocol</a> *<a class="code" href="classXrdProtocol.html#a24a9feea405f1803d9832a48a8ce7adf">Match</a>(<a class="code" href="classXrdLink.html">XrdLink</a> *lp) = 0;</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment">// Process() is invoked when a link has data waiting to be read</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment">//</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classXrdProtocol.html#af4128a0e539b9e14ba842cb7d6505231">Process</a>(<a class="code" href="classXrdLink.html">XrdLink</a> *lp) = 0;</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment">// Recycle() is invoked when this object is no longer needed. The method is</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment">// passed the number of seconds the protocol was connected to the</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment">// link and the reason for the disconnection, if any.</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment">//</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classXrdProtocol.html#ab6979bc5eaff26d093a2956562513477">Recycle</a>(<a class="code" href="classXrdLink.html">XrdLink</a> *lp=0,<span class="keywordtype">int</span> consec=0,<span class="keyword">const</span> <span class="keywordtype">char</span> *reason=0)=0;</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment">// Stats() is invoked when we need statistics about all instances of the</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment">// protocol. If a buffer is supplied, it must return a null </span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment">// terminated string in the supplied buffer and the return value</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment">// is the number of bytes placed in the buffer defined by C99 for </span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment">// snprintf(). If no buffer is supplied, the method should return</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment">// the maximum number of characters that could have been returned.</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment">// Regardless of the buffer value, if do_sync is true, the method</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment">// should include any local statistics in the global data (if any)</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment">// prior to performing any action.</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment">//</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classXrdProtocol.html#ae9ca8eb8589ea5cced2f2b381c4e2f04">Stats</a>(<span class="keywordtype">char</span> *buff, <span class="keywordtype">int</span> blen, <span class="keywordtype">int</span> do_sync=0) = 0;</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div>
<div class="line"><a name="l00141"></a><span class="lineno"><a class="code" href="classXrdProtocol.html#a8d2fb678406a6dd1f4ce6f98a848595f"> 141</a></span>  <a class="code" href="classXrdProtocol.html#a8d2fb678406a6dd1f4ce6f98a848595f">XrdProtocol</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *jname): <a class="code" href="classXrdJob.html">XrdJob</a>(jname) {}</div>
<div class="line"><a name="l00142"></a><span class="lineno"><a class="code" href="classXrdProtocol.html#a09611c330c59fea27cc4101ff9a67110"> 142</a></span> <span class="keyword">virtual</span> <a class="code" href="classXrdProtocol.html#a09611c330c59fea27cc4101ff9a67110">~XrdProtocol</a>() {}</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> };</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment">/******************************************************************************/</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment">/* X r d g e t P r o t o c o l */</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment">/******************************************************************************/</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  </div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment">/* This extern "C" function must be defined in the shared library plug-in</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> implementing your protocol. It is called to obtain an instance of your</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> protocol. This allows protocols to live outside of the protocol driver</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> (i.e., to be loaded at run-time). The call is made after the call to</span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> XrdgetProtocolPort() to determine the port to be used (see below) which</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> allows e network object (NetTCP) to be proerly defined and it's pointer</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> is passed in the XrdProtocol_Config object for your use.</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"></span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> Required return values:</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> Success: Pointer to XrdProtocol object.</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> Failure: Null pointer (i.e. 0) which causes the program to exit.</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"></span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment">extern "C" // This is in a comment!</span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment">{</span></div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> XrdProtocol *XrdgetProtocol(const char *protocol_name, char *parms,</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> XrdProtocol_Config *pi) {....}</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment">}</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  </div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment">/******************************************************************************/</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment">/* X r d g e t P r o t o c o l P o r t */</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment">/******************************************************************************/</span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  </div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment">/* This extern "C" function must be defined for statically linked protocols</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> but is optional for protocols defined as a shared library plug-in if the</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> rules determining which port number to use is sufficient for your protocol.</span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> The function is called to obtain the actual port number to be used by the</span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> the protocol. The default port number is noted in XrdProtocol_Config Port.</span></div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> Initially, it has one of the fllowing values:</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> <0 -> No port was specified.</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> =0 -> An erbitrary port will be assigned.</span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> >0 -> This port number was specified.</span></div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"></span></div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> XrdgetProtoclPort() must return:</span></div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> <0 -> Failure is indicated and we terminate</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> =0 -> Use an arbitrary port (even if this equals Port)</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> >0 -> The returned port number must be used (even if it equals Port)</span></div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"></span></div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> When we finally call XrdgetProtocol(), the actual port number is indicated</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> in Port and the network object is defined in NetTCP and bound to the port.</span></div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"></span></div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> Final Caveats: 1. The network object (NetTCP) is not defined until</span></div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> XrdgetProtocol() is called.</span></div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"></span></div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> 2. The statistics object (Stats) is not defined until</span></div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"> XrdgetProtocol() is called.</span></div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"></span></div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> 3. When the protocol is loaded from a shared library, you need</span></div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> need not define XrdgetProtocolPort() if the standard port</span></div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> determination scheme is sufficient.</span></div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"></span></div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment">extern "C" // This is in a comment!</span></div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment">{</span></div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> int XrdgetProtocolPort(const char *protocol_name, char *parms,</span></div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> XrdProtocol_Config *pi) {....}</span></div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment">}</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</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
>
395
