<!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: XrdClientUnsolMsg.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">XrdClientUnsolMsg.hh</div> </div>
</div><!--header-->
<div class="contents">
<a href="XrdClientUnsolMsg_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 XRC_UNSOLMSG_H</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor"></span><span class="preprocessor">#define XRC_UNSOLMSG_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 U n s o l M s g . 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">/* Author: Fabrizio Furano (INFN Padova, 2004) */</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">/* Adapted from TXNetFile (root.cern.ch) originally done by */</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">/* Alvise Dorigo, Fabrizio Furano */</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">/* INFN Padova, 2003 */</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">/* */</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">/* This file is part of the XRootD software suite. */</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 free software: you can redistribute it and/or modify it under */</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">/* the terms of the GNU Lesser General Public License as published by the */</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">/* Free Software Foundation, either version 3 of the License, or (at your */</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">/* option) any later version. */</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">/* XRootD is distributed in the hope that it will be useful, but WITHOUT */</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">/* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or */</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">/* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public */</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">/* License for more details. */</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">/* */</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">/* You should have received a copy of the GNU Lesser General Public License */</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file */</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">/* COPYING (GPL license). If not, see <http://www.gnu.org/licenses/>. */</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">/* */</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">/* The copyright holder's institutional names and contributor's names may not */</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">/* be used to endorse or promote products derived from this software without */</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">/* specific prior written permission of the institution or contributor. */</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">/******************************************************************************/</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</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">// Base classes for unsolicited msg senders/receivers //</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// //</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">class </span>XrdClientMessage;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">class </span><a class="code" href="classXrdClientUnsolMsgSender.html">XrdClientUnsolMsgSender</a>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">// The processing result for an unsolicited response</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="code" href="XrdClientUnsolMsg_8hh.html#ac8ef7fc6b74e2fda78f14bd74a171fa4"> 43</a></span> <span class="keyword">enum</span> <a class="code" href="XrdClientUnsolMsg_8hh.html#ac8ef7fc6b74e2fda78f14bd74a171fa4">UnsolRespProcResult</a> {</div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="code" href="XrdClientUnsolMsg_8hh.html#ac8ef7fc6b74e2fda78f14bd74a171fa4a9156b04fe4cd027395597458b01179a5"> 44</a></span>  <a class="code" href="XrdClientUnsolMsg_8hh.html#ac8ef7fc6b74e2fda78f14bd74a171fa4a9156b04fe4cd027395597458b01179a5">kUNSOL_CONTINUE</a> = 0, <span class="comment">// Dispatching must continue to other interested handlers</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="code" href="XrdClientUnsolMsg_8hh.html#ac8ef7fc6b74e2fda78f14bd74a171fa4a914e0dadf07502baf7fbdd6c5889e16b"> 45</a></span>  <a class="code" href="XrdClientUnsolMsg_8hh.html#ac8ef7fc6b74e2fda78f14bd74a171fa4a914e0dadf07502baf7fbdd6c5889e16b">kUNSOL_KEEP</a>, <span class="comment">// Dispatching ended, but stream still alive (must keep the SID)</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="code" href="XrdClientUnsolMsg_8hh.html#ac8ef7fc6b74e2fda78f14bd74a171fa4a0e060ec0b794d0393b3ae5cd09205bc6"> 46</a></span>  <a class="code" href="XrdClientUnsolMsg_8hh.html#ac8ef7fc6b74e2fda78f14bd74a171fa4a0e060ec0b794d0393b3ae5cd09205bc6">kUNSOL_DISPOSE</a> <span class="comment">// Dispatching ended, stream no more to be used</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> };</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">// Handler</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="code" href="classXrdClientAbsUnsolMsgHandler.html"> 51</a></span> <span class="keyword">class </span><a class="code" href="classXrdClientAbsUnsolMsgHandler.html">XrdClientAbsUnsolMsgHandler</a> {</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="code" href="classXrdClientAbsUnsolMsgHandler.html#a29cbc35bfe2c4e458072a75ac3c49bd5"> 54</a></span>  <span class="keyword">virtual</span> <a class="code" href="classXrdClientAbsUnsolMsgHandler.html#a29cbc35bfe2c4e458072a75ac3c49bd5">~XrdClientAbsUnsolMsgHandler</a>() { }</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// To be called when an unsolicited response arrives from the lower layers</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">virtual</span> <a class="code" href="XrdClientUnsolMsg_8hh.html#ac8ef7fc6b74e2fda78f14bd74a171fa4">UnsolRespProcResult</a> <a class="code" href="classXrdClientAbsUnsolMsgHandler.html#a0f968c3d9efbde37b6fe99f062d243f9">ProcessUnsolicitedMsg</a>(<a class="code" href="classXrdClientUnsolMsgSender.html">XrdClientUnsolMsgSender</a> *sender, </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  XrdClientMessage *unsolmsg) = 0;</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> };</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">// Sender</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"><a class="code" href="classXrdClientUnsolMsgSender.html"> 63</a></span> <span class="keyword">class </span><a class="code" href="classXrdClientUnsolMsgSender.html">XrdClientUnsolMsgSender</a> {</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">public</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"><a class="code" href="classXrdClientUnsolMsgSender.html#a7903e5b9cb0883c62afe4fb2ce2a8586"> 67</a></span>  <span class="keyword">virtual</span> <a class="code" href="classXrdClientUnsolMsgSender.html#a7903e5b9cb0883c62afe4fb2ce2a8586">~XrdClientUnsolMsgSender</a>() { }</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="comment">// The upper level handler for unsolicited responses</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"><a class="code" href="classXrdClientUnsolMsgSender.html#a1932add6d1a81cdc4702982bdfe84373"> 70</a></span>  <a class="code" href="classXrdClientAbsUnsolMsgHandler.html">XrdClientAbsUnsolMsgHandler</a> *<a class="code" href="classXrdClientUnsolMsgSender.html#a1932add6d1a81cdc4702982bdfe84373">UnsolicitedMsgHandler</a>;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a name="l00072"></a><span class="lineno"><a class="code" href="classXrdClientUnsolMsgSender.html#aefa1665d4f6acf266082de325b39d6d3"> 72</a></span>  <span class="keyword">inline</span> <a class="code" href="XrdClientUnsolMsg_8hh.html#ac8ef7fc6b74e2fda78f14bd74a171fa4">UnsolRespProcResult</a> <a class="code" href="classXrdClientUnsolMsgSender.html#aefa1665d4f6acf266082de325b39d6d3">SendUnsolicitedMsg</a>(<a class="code" href="classXrdClientUnsolMsgSender.html">XrdClientUnsolMsgSender</a> *sender, XrdClientMessage *unsolmsg) {</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="comment">// We simply send the event</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordflow">if</span> (<a class="code" href="classXrdClientUnsolMsgSender.html#a1932add6d1a81cdc4702982bdfe84373">UnsolicitedMsgHandler</a>)</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">return</span> (<a class="code" href="classXrdClientUnsolMsgSender.html#a1932add6d1a81cdc4702982bdfe84373">UnsolicitedMsgHandler</a>-><a class="code" href="classXrdClientAbsUnsolMsgHandler.html#a0f968c3d9efbde37b6fe99f062d243f9">ProcessUnsolicitedMsg</a>(sender, unsolmsg));</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordflow">return</span> <a class="code" href="XrdClientUnsolMsg_8hh.html#ac8ef7fc6b74e2fda78f14bd74a171fa4a9156b04fe4cd027395597458b01179a5">kUNSOL_CONTINUE</a>;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  }</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a name="l00080"></a><span class="lineno"><a class="code" href="classXrdClientUnsolMsgSender.html#a74e0ce8cc090e9a986428f0842d7dda8"> 80</a></span>  <span class="keyword">inline</span> <a class="code" href="classXrdClientUnsolMsgSender.html#a74e0ce8cc090e9a986428f0842d7dda8">XrdClientUnsolMsgSender</a>() { <a class="code" href="classXrdClientUnsolMsgSender.html#a1932add6d1a81cdc4702982bdfe84373">UnsolicitedMsgHandler</a> = 0; }</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> };</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</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
>
187
