<!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::IncomingMsgHandler 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 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 List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class 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_1IncomingMsgHandler.html">IncomingMsgHandler</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classXrdCl_1_1IncomingMsgHandler-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">XrdCl::IncomingMsgHandler Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classXrdCl_1_1Message.html" title="The message representation used throughout the system.">Message</a> handler.
<a href="classXrdCl_1_1IncomingMsgHandler.html#details">More...</a></p>
<p><code>#include <<a class="el" href="XrdClPostMasterInterfaces_8hh_source.html">XrdClPostMasterInterfaces.hh</a>></code></p>
<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:a0ea4dbab876d58db4c94e181dd0f588f"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1IncomingMsgHandler.html#a0ea4dbab876d58db4c94e181dd0f588f">Action</a> { <br/>
  <a class="el" href="classXrdCl_1_1IncomingMsgHandler.html#a0ea4dbab876d58db4c94e181dd0f588fa9485a540ef9e958313f6e5da437f3d52">Take</a> = 0x0001,
<a class="el" href="classXrdCl_1_1IncomingMsgHandler.html#a0ea4dbab876d58db4c94e181dd0f588fa31142fe71ed849e7a8bf0d673cd24338">Ignore</a> = 0x0002,
<a class="el" href="classXrdCl_1_1IncomingMsgHandler.html#a0ea4dbab876d58db4c94e181dd0f588faebd610a1dcab90cf1ce72abac48fee16">RemoveHandler</a> = 0x0004,
<a class="el" href="classXrdCl_1_1IncomingMsgHandler.html#a0ea4dbab876d58db4c94e181dd0f588fa0002377a2012952750ac577589f27cc4">Raw</a> = 0x0008,
<br/>
  <a class="el" href="classXrdCl_1_1IncomingMsgHandler.html#a0ea4dbab876d58db4c94e181dd0f588fafa9e7b0048d2756df8a860ddcc775735">NoProcess</a> = 0x0010
<br/>
}</td></tr>
<tr class="memdesc:a0ea4dbab876d58db4c94e181dd0f588f"><td class="mdescLeft"> </td><td class="mdescRight">Actions to be taken after a message is processed by the handler. <a href="classXrdCl_1_1IncomingMsgHandler.html#a0ea4dbab876d58db4c94e181dd0f588f">More...</a><br/></td></tr>
<tr class="separator:a0ea4dbab876d58db4c94e181dd0f588f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac2782f97368258151af1b74e925b2907"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1IncomingMsgHandler.html#ac2782f97368258151af1b74e925b2907">StreamEvent</a> { <a class="el" href="classXrdCl_1_1IncomingMsgHandler.html#ac2782f97368258151af1b74e925b2907af4236eae4b07c65359480ade619b95ce">Ready</a> = 1,
<a class="el" href="classXrdCl_1_1IncomingMsgHandler.html#ac2782f97368258151af1b74e925b2907a43a11fa871bf756a92912ce9bd163b07">Broken</a> = 2,
<a class="el" href="classXrdCl_1_1IncomingMsgHandler.html#ac2782f97368258151af1b74e925b2907a51d0bab699ec89b9663f1d5045142572">Timeout</a> = 3,
<a class="el" href="classXrdCl_1_1IncomingMsgHandler.html#ac2782f97368258151af1b74e925b2907afc19c1a0d4c1a12c9a765f5e956abade">FatalError</a> = 4
}</td></tr>
<tr class="memdesc:ac2782f97368258151af1b74e925b2907"><td class="mdescLeft"> </td><td class="mdescRight">Events that may have occurred to the stream. <a href="classXrdCl_1_1IncomingMsgHandler.html#ac2782f97368258151af1b74e925b2907">More...</a><br/></td></tr>
<tr class="separator:ac2782f97368258151af1b74e925b2907"><td class="memSeparator" colspan="2"> </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:a187a3dffb63b45e189babb9cbe743a4f"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1IncomingMsgHandler.html#a187a3dffb63b45e189babb9cbe743a4f">~IncomingMsgHandler</a> ()</td></tr>
<tr class="memdesc:a187a3dffb63b45e189babb9cbe743a4f"><td class="mdescLeft"> </td><td class="mdescRight">Event types that the message handler may receive. <a href="#a187a3dffb63b45e189babb9cbe743a4f">More...</a><br/></td></tr>
<tr class="separator:a187a3dffb63b45e189babb9cbe743a4f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae6214868983565fe6d92126ae7f72e2"><td class="memItemLeft" align="right" valign="top">virtual uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1IncomingMsgHandler.html#aae6214868983565fe6d92126ae7f72e2">Examine</a> (<a class="el" href="classXrdCl_1_1Message.html">Message</a> *msg)=0</td></tr>
<tr class="separator:aae6214868983565fe6d92126ae7f72e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a384de2b4254a1e03f2fe32b79ab39a2d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1IncomingMsgHandler.html#a384de2b4254a1e03f2fe32b79ab39a2d">Process</a> (<a class="el" href="classXrdCl_1_1Message.html">Message</a> *msg)</td></tr>
<tr class="separator:a384de2b4254a1e03f2fe32b79ab39a2d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b1692122ff7cde6d9b40c79f69e1152"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structXrdCl_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1IncomingMsgHandler.html#a7b1692122ff7cde6d9b40c79f69e1152">ReadMessageBody</a> (<a class="el" href="classXrdCl_1_1Message.html">Message</a> *msg, int socket, uint32_t &bytesRead)</td></tr>
<tr class="separator:a7b1692122ff7cde6d9b40c79f69e1152"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afb9dfb76be0a4c5677d28f3e8253f396"><td class="memItemLeft" align="right" valign="top">virtual uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1IncomingMsgHandler.html#afb9dfb76be0a4c5677d28f3e8253f396">OnStreamEvent</a> (<a class="el" href="classXrdCl_1_1IncomingMsgHandler.html#ac2782f97368258151af1b74e925b2907">StreamEvent</a> event, uint16_t streamNum, <a class="el" href="structXrdCl_1_1Status.html">Status</a> status)</td></tr>
<tr class="separator:afb9dfb76be0a4c5677d28f3e8253f396"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classXrdCl_1_1Message.html" title="The message representation used throughout the system.">Message</a> handler. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a0ea4dbab876d58db4c94e181dd0f588f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classXrdCl_1_1IncomingMsgHandler.html#a0ea4dbab876d58db4c94e181dd0f588f">XrdCl::IncomingMsgHandler::Action</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Actions to be taken after a message is processed by the handler. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a0ea4dbab876d58db4c94e181dd0f588fa9485a540ef9e958313f6e5da437f3d52"></a>Take</em> </td><td class="fielddoc">
<p>Take ownership over the message. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0ea4dbab876d58db4c94e181dd0f588fa31142fe71ed849e7a8bf0d673cd24338"></a>Ignore</em> </td><td class="fielddoc">
<p>Ignore the message. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0ea4dbab876d58db4c94e181dd0f588faebd610a1dcab90cf1ce72abac48fee16"></a>RemoveHandler</em> </td><td class="fielddoc">
<p>Remove the handler from the notification list </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0ea4dbab876d58db4c94e181dd0f588fa0002377a2012952750ac577589f27cc4"></a>Raw</em> </td><td class="fielddoc">
<p>the handler is interested in reading the message body directly from the socket </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0ea4dbab876d58db4c94e181dd0f588fafa9e7b0048d2756df8a860ddcc775735"></a>NoProcess</em> </td><td class="fielddoc">
<p>don't call the processing callback even if the message belongs to this handler </p>
</td></tr>
</table>
</div>
</div>
<a class="anchor" id="ac2782f97368258151af1b74e925b2907"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classXrdCl_1_1IncomingMsgHandler.html#ac2782f97368258151af1b74e925b2907">XrdCl::IncomingMsgHandler::StreamEvent</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Events that may have occurred to the stream. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ac2782f97368258151af1b74e925b2907af4236eae4b07c65359480ade619b95ce"></a>Ready</em> </td><td class="fielddoc">
<p>The stream has become connected. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ac2782f97368258151af1b74e925b2907a43a11fa871bf756a92912ce9bd163b07"></a>Broken</em> </td><td class="fielddoc">
<p>The stream is broken. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ac2782f97368258151af1b74e925b2907a51d0bab699ec89b9663f1d5045142572"></a>Timeout</em> </td><td class="fielddoc">
<p>The declared timeout has occurred. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ac2782f97368258151af1b74e925b2907afc19c1a0d4c1a12c9a765f5e956abade"></a>FatalError</em> </td><td class="fielddoc">
<p>Stream has been broken and won't be recovered. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a187a3dffb63b45e189babb9cbe743a4f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual XrdCl::IncomingMsgHandler::~IncomingMsgHandler </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>Event types that the message handler may receive. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aae6214868983565fe6d92126ae7f72e2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint16_t XrdCl::IncomingMsgHandler::Examine </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXrdCl_1_1Message.html">Message</a> * </td>
<td class="paramname"><em>msg</em></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>Examine an incoming message, and decide on the action to be taken</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>the message, may be zero if receive failed </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>action type that needs to be take wrt the message and the handler </dd></dl>
</div>
</div>
<a class="anchor" id="afb9dfb76be0a4c5677d28f3e8253f396"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint8_t XrdCl::IncomingMsgHandler::OnStreamEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXrdCl_1_1IncomingMsgHandler.html#ac2782f97368258151af1b74e925b2907">StreamEvent</a> </td>
<td class="paramname"><em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>streamNum</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structXrdCl_1_1Status.html">Status</a> </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</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>Handle an event other that a message arrival</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">event</td><td>type of the event </td></tr>
<tr><td class="paramname">streamNum</td><td>stream concerned </td></tr>
<tr><td class="paramname">status</td><td>status info </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Action::RemoveHandler or 0 </dd></dl>
</div>
</div>
<a class="anchor" id="a384de2b4254a1e03f2fe32b79ab39a2d"></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::IncomingMsgHandler::Process </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXrdCl_1_1Message.html">Message</a> * </td>
<td class="paramname"><em>msg</em></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>Process the message if it was "taken" by the examine action</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>the message to be processed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7b1692122ff7cde6d9b40c79f69e1152"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structXrdCl_1_1Status.html">Status</a> XrdCl::IncomingMsgHandler::ReadMessageBody </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXrdCl_1_1Message.html">Message</a> * </td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>socket</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t & </td>
<td class="paramname"><em>bytesRead</em> </td>
</tr>
<tr>
<td></td>
<td>)</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>Read message body directly from a socket - called if Examine returns Raw flag - only socket related errors may be returned here</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>the corresponding message header </td></tr>
<tr><td class="paramname">socket</td><td>the socket to read from </td></tr>
<tr><td class="paramname">bytesRead</td><td>number of bytes read by the method </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>stOK & suDone if the whole body has been processed stOK & suRetry if more data is needed stError on failure </dd></dl>
<p>References <a class="el" href="namespaceXrdCl.html#a5c25351b39fdfcb21262d8373e900a07">XrdCl::stOK</a>, and <a class="el" href="namespaceXrdCl.html#ac77ca24e84f498251a6fb91cd8559087">XrdCl::suDone</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XrdClPostMasterInterfaces_8hh_source.html">XrdClPostMasterInterfaces.hh</a></li>
</ul>
</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
>
605
