Sophie

Sophie

distrib > Fedora > 18 > x86_64 > media > updates > by-pkgid > 749e483016bbc41594aeb77eb13e3491 > files > 628

xrootd-doc-3.3.5-1.fc18.noarch.rpm

<!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::OutgoingMsgHandler 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&#160;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&#160;List</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;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_1OutgoingMsgHandler.html">OutgoingMsgHandler</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classXrdCl_1_1OutgoingMsgHandler-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">XrdCl::OutgoingMsgHandler 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> status handler.  
 <a href="classXrdCl_1_1OutgoingMsgHandler.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="XrdClPostMasterInterfaces_8hh_source.html">XrdClPostMasterInterfaces.hh</a>&gt;</code></p>
<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:a907af942d7178e70f56acf618b23801f"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1OutgoingMsgHandler.html#a907af942d7178e70f56acf618b23801f">~OutgoingMsgHandler</a> ()</td></tr>
<tr class="separator:a907af942d7178e70f56acf618b23801f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fb94966bdc3efced197134becf608cd"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1OutgoingMsgHandler.html#a1fb94966bdc3efced197134becf608cd">OnStatusReady</a> (const <a class="el" href="classXrdCl_1_1Message.html">Message</a> *message, <a class="el" href="structXrdCl_1_1Status.html">Status</a> status)=0</td></tr>
<tr class="memdesc:a1fb94966bdc3efced197134becf608cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">The requested action has been performed and the status is available.  <a href="#a1fb94966bdc3efced197134becf608cd">More...</a><br/></td></tr>
<tr class="separator:a1fb94966bdc3efced197134becf608cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13306cbbd7ad01227e55ffc33b6670f7"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1OutgoingMsgHandler.html#a13306cbbd7ad01227e55ffc33b6670f7">OnReadyToSend</a> (<a class="el" href="classXrdCl_1_1Message.html">Message</a> *msg, uint16_t streamNum)</td></tr>
<tr class="separator:a13306cbbd7ad01227e55ffc33b6670f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1e6d6ad53c0ab6492ba4e30ed558f4b"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1OutgoingMsgHandler.html#ac1e6d6ad53c0ab6492ba4e30ed558f4b">IsRaw</a> () const </td></tr>
<tr class="separator:ac1e6d6ad53c0ab6492ba4e30ed558f4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4850a1411de5f077a5a95865ac2f253"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structXrdCl_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1OutgoingMsgHandler.html#aa4850a1411de5f077a5a95865ac2f253">WriteMessageBody</a> (int socket, uint32_t &amp;bytesRead)</td></tr>
<tr class="separator:aa4850a1411de5f077a5a95865ac2f253"><td class="memSeparator" colspan="2">&#160;</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> status handler. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a907af942d7178e70f56acf618b23801f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual XrdCl::OutgoingMsgHandler::~OutgoingMsgHandler </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">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ac1e6d6ad53c0ab6492ba4e30ed558f4b"></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::OutgoingMsgHandler::IsRaw </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</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>Determines whether the handler wants to write some data directly to the socket after the message (or message header) has been sent, WriteMessageBody will be called </p>

</div>
</div>
<a class="anchor" id="a13306cbbd7ad01227e55ffc33b6670f7"></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::OutgoingMsgHandler::OnReadyToSend </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classXrdCl_1_1Message.html">Message</a> *&#160;</td>
          <td class="paramname"><em>msg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>streamNum</em>&#160;</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>Called just before the message is going to be sent through a valid connection, so that the user can still make some modifications that were impossible before (ie. protocol version dependent adjustments)</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">msg</td><td>message concerned </td></tr>
    <tr><td class="paramname">streamNum</td><td>number of the stream the message will go through </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a1fb94966bdc3efced197134becf608cd"></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::OutgoingMsgHandler::OnStatusReady </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classXrdCl_1_1Message.html">Message</a> *&#160;</td>
          <td class="paramname"><em>message</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structXrdCl_1_1Status.html">Status</a>&#160;</td>
          <td class="paramname"><em>status</em>&#160;</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>The requested action has been performed and the status is available. </p>

</div>
</div>
<a class="anchor" id="aa4850a1411de5f077a5a95865ac2f253"></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::OutgoingMsgHandler::WriteMessageBody </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>socket</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t &amp;&#160;</td>
          <td class="paramname"><em>bytesRead</em>&#160;</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>Write message body directly to a socket - called if IsRaw returns true - only socket related errors may be returned here</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <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 &amp; suDone if the whole body has been processed stOK &amp; suRetry if more data needs to be written stError on failure </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 &#160;<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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional