<!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::ChannelEventHandler 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_1ChannelEventHandler.html">ChannelEventHandler</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_1ChannelEventHandler-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">XrdCl::ChannelEventHandler Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Channel event handler.
<a href="classXrdCl_1_1ChannelEventHandler.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:ac38cdbe6f2f3c06c799125187de3ae1d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1ChannelEventHandler.html#ac38cdbe6f2f3c06c799125187de3ae1d">ChannelEvent</a> { <a class="el" href="classXrdCl_1_1ChannelEventHandler.html#ac38cdbe6f2f3c06c799125187de3ae1da4032d869ce7cfdee678e4e75bc4dca3d">StreamReady</a> = 1,
<a class="el" href="classXrdCl_1_1ChannelEventHandler.html#ac38cdbe6f2f3c06c799125187de3ae1da033292bb7be3e6731b972a2d0638d03b">StreamBroken</a> = 2,
<a class="el" href="classXrdCl_1_1ChannelEventHandler.html#ac38cdbe6f2f3c06c799125187de3ae1da9cb69ca47a71b0f3346b62e6e830f61f">FatalError</a> = 4
}</td></tr>
<tr class="memdesc:ac38cdbe6f2f3c06c799125187de3ae1d"><td class="mdescLeft"> </td><td class="mdescRight">Events that may have occurred to the channel. <a href="classXrdCl_1_1ChannelEventHandler.html#ac38cdbe6f2f3c06c799125187de3ae1d">More...</a><br/></td></tr>
<tr class="separator:ac38cdbe6f2f3c06c799125187de3ae1d"><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:ac416198cb70ec34b23267c7e2ee91141"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1ChannelEventHandler.html#ac416198cb70ec34b23267c7e2ee91141">~ChannelEventHandler</a> ()</td></tr>
<tr class="memdesc:ac416198cb70ec34b23267c7e2ee91141"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ac416198cb70ec34b23267c7e2ee91141">More...</a><br/></td></tr>
<tr class="separator:ac416198cb70ec34b23267c7e2ee91141"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba662145aaac185b5c17f351734ba74d"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1ChannelEventHandler.html#aba662145aaac185b5c17f351734ba74d">OnChannelEvent</a> (<a class="el" href="classXrdCl_1_1ChannelEventHandler.html#ac38cdbe6f2f3c06c799125187de3ae1d">ChannelEvent</a> event, <a class="el" href="structXrdCl_1_1Status.html">Status</a> status, uint16_t stream)=0</td></tr>
<tr class="separator:aba662145aaac185b5c17f351734ba74d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Channel event handler. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="ac38cdbe6f2f3c06c799125187de3ae1d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classXrdCl_1_1ChannelEventHandler.html#ac38cdbe6f2f3c06c799125187de3ae1d">XrdCl::ChannelEventHandler::ChannelEvent</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Events that may have occurred to the channel. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ac38cdbe6f2f3c06c799125187de3ae1da4032d869ce7cfdee678e4e75bc4dca3d"></a>StreamReady</em> </td><td class="fielddoc">
<p>The stream has become connected. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ac38cdbe6f2f3c06c799125187de3ae1da033292bb7be3e6731b972a2d0638d03b"></a>StreamBroken</em> </td><td class="fielddoc">
<p>The stream is broken. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ac38cdbe6f2f3c06c799125187de3ae1da9cb69ca47a71b0f3346b62e6e830f61f"></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="ac416198cb70ec34b23267c7e2ee91141"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual XrdCl::ChannelEventHandler::~ChannelEventHandler </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>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aba662145aaac185b5c17f351734ba74d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool XrdCl::ChannelEventHandler::OnChannelEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXrdCl_1_1ChannelEventHandler.html#ac38cdbe6f2f3c06c799125187de3ae1d">ChannelEvent</a> </td>
<td class="paramname"><em>event</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 class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>stream</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Event callback</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">event</td><td>the event that has occurred </td></tr>
<tr><td class="paramname">stream</td><td>the stream concerned </td></tr>
<tr><td class="paramname">status</td><td>the status info </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the handler should be kept false if it should be removed from further consideration </dd></dl>
</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>
