<!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: XrdClMessage.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_cc07005933c58fdd66ad39025e40a12c.html">XrdCl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">XrdClMessage.hh</div> </div>
</div><!--header-->
<div class="contents">
<a href="XrdClMessage_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="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Copyright (c) 2011-2012 by European Organization for Nuclear Research (CERN)</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// Author: Lukasz Janyst <ljanyst@cern.ch></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">// XRootD is free software: you can redistribute it and/or modify</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// it under the terms of the GNU Lesser General Public License as published by</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// the Free Software Foundation, either version 3 of the License, or</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// (at your option) any later version.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">//</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// XRootD is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// GNU General Public License for more details.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">//</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// You should have received a copy of the GNU Lesser General Public License</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// along with XRootD. If not, see <http://www.gnu.org/licenses/>.</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> </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef __XRD_CL_MESSAGE_HH__</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor"></span><span class="preprocessor">#define __XRD_CL_MESSAGE_HH__</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "<a class="code" href="XrdClBuffer_8hh.html">XrdCl/XrdClBuffer.hh</a>"</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">namespace </span>XrdCl</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> {</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="comment">//----------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"></span> <span class="comment">//----------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="code" href="classXrdCl_1_1Message.html"> 29</a></span>  <span class="keyword">class </span><a class="code" href="classXrdCl_1_1Message.html" title="The message representation used throughout the system.">Message</a>: <span class="keyword">public</span> <a class="code" href="classXrdCl_1_1Buffer.html" title="Binary blob representation.">Buffer</a></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  {</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="comment">//------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"></span> <span class="comment">//------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="code" href="classXrdCl_1_1Message.html#ae7e17e50934822d89689a72d4141a524"> 35</a></span>  <a class="code" href="classXrdCl_1_1Message.html#ae7e17e50934822d89689a72d4141a524" title="Constructor.">Message</a>( uint32_t size = 0 ):</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <a class="code" href="classXrdCl_1_1Buffer.html" title="Binary blob representation.">Buffer</a>( size ), <a class="code" href="classXrdCl_1_1Message.html#a6d85314fbbaa09295d2723fc2eb3df0f">pIsMarshalled</a>( false ), <a class="code" href="classXrdCl_1_1Message.html#a39f202e105afc5871db0a27dafa91a85">pSessionId</a>(0)</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="keywordflow">if</span>( size )</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="classXrdCl_1_1Buffer.html#a2649d860de46530990a2119fb06cc1e8" title="Zero.">Zero</a>();</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  }</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">//------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"></span> <span class="comment">//------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="code" href="classXrdCl_1_1Message.html#a1c51c20e7be9b6a8fd671bf914eedf41"> 45</a></span>  <span class="keyword">virtual</span> <a class="code" href="classXrdCl_1_1Message.html#a1c51c20e7be9b6a8fd671bf914eedf41" title="Destructor.">~Message</a>() {}</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="comment">//------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"></span> <span class="comment">//------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="code" href="classXrdCl_1_1Message.html#a761bff00cc8c7497b58f1ea1a2f9d229"> 50</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classXrdCl_1_1Message.html#a761bff00cc8c7497b58f1ea1a2f9d229" title="Check if the message is marshalled.">IsMarshalled</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordflow">return</span> <a class="code" href="classXrdCl_1_1Message.html#a6d85314fbbaa09295d2723fc2eb3df0f">pIsMarshalled</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> </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">//------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"></span> <span class="comment">//------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="code" href="classXrdCl_1_1Message.html#a7e93fa35db6bdeca43f4799e61f4b02d"> 58</a></span>  <span class="keywordtype">void</span> <a class="code" href="classXrdCl_1_1Message.html#a7e93fa35db6bdeca43f4799e61f4b02d" title="Set the marshalling status.">SetIsMarshalled</a>( <span class="keywordtype">bool</span> isMarshalled )</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>  <a class="code" href="classXrdCl_1_1Message.html#a6d85314fbbaa09295d2723fc2eb3df0f">pIsMarshalled</a> = isMarshalled;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</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">//------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"></span> <span class="comment">//------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="code" href="classXrdCl_1_1Message.html#a5ae20044b016268386e40e74b1bae3cb"> 66</a></span>  <span class="keywordtype">void</span> <a class="code" href="classXrdCl_1_1Message.html#a5ae20044b016268386e40e74b1bae3cb" title="Set the description of the message.">SetDescription</a>( <span class="keyword">const</span> std::string &description )</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  {</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="classXrdCl_1_1Message.html#a0004e7537363438ce55c3a030b6a4fb8">pDescription</a> = description;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  }</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="comment">//------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"></span> <span class="comment">//------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"><a class="code" href="classXrdCl_1_1Message.html#ae3e3ff61c4e9a6dd9bd42c0fa6c97adf"> 74</a></span>  <span class="keyword">const</span> std::string &<a class="code" href="classXrdCl_1_1Message.html#ae3e3ff61c4e9a6dd9bd42c0fa6c97adf" title="Get the description of the message.">GetDescription</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordflow">return</span> <a class="code" href="classXrdCl_1_1Message.html#a0004e7537363438ce55c3a030b6a4fb8">pDescription</a>;</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  }</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>  <span class="comment">//------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"></span> <span class="comment">//------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"><a class="code" href="classXrdCl_1_1Message.html#a5b7988309199e3d5c04b707f86590723"> 82</a></span>  <span class="keywordtype">void</span> <a class="code" href="classXrdCl_1_1Message.html#a5b7988309199e3d5c04b707f86590723" title="Set the session ID which this message is meant for.">SetSessionId</a>( uint64_t sessionId )</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  {</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="classXrdCl_1_1Message.html#a39f202e105afc5871db0a27dafa91a85">pSessionId</a> = sessionId;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  }</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="comment">//------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"></span> <span class="comment">//------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"><a class="code" href="classXrdCl_1_1Message.html#aefd07d6bfce4e48dac2888560967ab3b"> 90</a></span>  uint64_t <a class="code" href="classXrdCl_1_1Message.html#aefd07d6bfce4e48dac2888560967ab3b" title="Get the session ID the message is meant for.">GetSessionId</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordflow">return</span> <a class="code" href="classXrdCl_1_1Message.html#a39f202e105afc5871db0a27dafa91a85">pSessionId</a>;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  }</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00096"></a><span class="lineno"><a class="code" href="classXrdCl_1_1Message.html#a6d85314fbbaa09295d2723fc2eb3df0f"> 96</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classXrdCl_1_1Message.html#a6d85314fbbaa09295d2723fc2eb3df0f">pIsMarshalled</a>;</div>
<div class="line"><a name="l00097"></a><span class="lineno"><a class="code" href="classXrdCl_1_1Message.html#a39f202e105afc5871db0a27dafa91a85"> 97</a></span>  uint64_t <a class="code" href="classXrdCl_1_1Message.html#a39f202e105afc5871db0a27dafa91a85">pSessionId</a>;</div>
<div class="line"><a name="l00098"></a><span class="lineno"><a class="code" href="classXrdCl_1_1Message.html#a0004e7537363438ce55c3a030b6a4fb8"> 98</a></span>  std::string <a class="code" href="classXrdCl_1_1Message.html#a0004e7537363438ce55c3a030b6a4fb8">pDescription</a>;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  };</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</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="preprocessor">#endif // __XRD_CL_MESSAGE_HH__</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
>
110
