classpindirectchannel.html

pwlib开发文档

The <a class="el" href="classPChannel.html#z55_2">GetErrorCode()</a> function should be consulted after <a class="el" href="classPIndirectChannel.html#z157_3">Read()</a> returns FALSE to determine what caused the failure.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE indicates that at least one character was read from the channel. FALSE means no bytes were read due to timeout or some other I/O error. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>len</em>&nbsp;</td><td>
Pointer to a block of memory to receive the read bytes. Maximum number of bytes to read into the buffer. </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classPChannel.html#z49_2">PChannel</a>.
<p>
Reimplemented in <a class="el" href="classPDelayChannel.html#z477_0">PDelayChannel</a>, <a class="el" href="classPInternetProtocol.html#a0">PInternetProtocol</a>, <a class="el" href="classPSSLChannel.html#a3">PSSLChannel</a>, and <a class="el" href="classPVXMLChannel.html#a5">PVXMLChannel</a>.    </td>
  </tr>
</table>
<a name="z159_4" doxytag="PIndirectChannel::SetReadChannel"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> BOOL PIndirectChannel::SetReadChannel </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classPChannel.html">PChannel</a> *&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>channel</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>BOOL&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>autoDelete</em> = TRUE</td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Set the channel for read operations.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 Returns TRUE if both channels are set and are both open. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>autoDelete</em>&nbsp;</td><td>
Channel to be used for both read operations. Automatically delete the channel </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z159_6" doxytag="PIndirectChannel::SetWriteChannel"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> BOOL PIndirectChannel::SetWriteChannel </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classPChannel.html">PChannel</a> *&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>channel</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>BOOL&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>autoDelete</em> = TRUE</td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Set the channel for read operations.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 Returns TRUE if both channels are set and are both open. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>autoDelete</em>&nbsp;</td><td>
Channel to be used for both write operations. Automatically delete the channel </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z157_5" doxytag="PIndirectChannel::Shutdown"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual BOOL PIndirectChannel::Shutdown </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classPChannel.html#z53_0">ShutdownValue</a>&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>option</em>          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Close one or both of the data streams associated with a channel.
<p>
The behavour here is to pass the shutdown on to its read and write channels.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if the shutdown was successfully performed. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>option</em>&nbsp;</td><td>
Flag for shut down of read, write or both. </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classPChannel.html#z53_2">PChannel</a>.
<p>
Reimplemented in <a class="el" href="classPSSLChannel.html#a6">PSSLChannel</a>.    </td>
  </tr>
</table>
<a name="z157_4" doxytag="PIndirectChannel::Write"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual BOOL PIndirectChannel::Write </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const void *&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>buf</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>PINDEX&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>len</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Low level write to the channel. This function will block until the requested number of characters are written or the write timeout is reached. The <a class="el" href="classPChannel.html#z51_3">GetLastWriteCount()</a> function returns the actual number of bytes written.
<p>
This will use the <a class="el" href="classPIndirectChannel.html#n2">writeChannel</a># pointer to actually do the write. If <a class="el" href="classPIndirectChannel.html#n2">writeChannel</a># is null the this asserts.
<p>
The <a class="el" href="classPChannel.html#z55_2">GetErrorCode()</a> function should be consulted after <a class="el" href="classPIndirectChannel.html#z157_4">Write()</a> returns FALSE to determine what caused the failure.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if at least len bytes were written to the channel. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>len</em>&nbsp;</td><td>
Pointer to a block of memory to write. Number of bytes to write. </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classPChannel.html#z51_2">PChannel</a>.
<p>
Reimplemented in <a class="el" href="classPDelayChannel.html#z477_1">PDelayChannel</a>, <a class="el" href="classPRFC822Channel.html#a3">PRFC822Channel</a>, <a class="el" href="classPInternetProtocol.html#a1">PInternetProtocol</a>, <a class="el" href="classPSSLChannel.html#a4">PSSLChannel</a>, and <a class="el" href="classPVXMLChannel.html#a6">PVXMLChannel</a>.    </td>
  </tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="n4" doxytag="PIndirectChannel::channelPointerMutex"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="classPReadWriteMutex.html">PReadWriteMutex</a> PIndirectChannel::channelPointerMutex<code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Race condition prevention on closing channel.
<p>
    </td>
  </tr>
</table>
<a name="n1" doxytag="PIndirectChannel::readAutoDelete"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> BOOL PIndirectChannel::readAutoDelete<code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Automatically delete read channel on destruction.
<p>
    </td>
  </tr>
</table>
<a name="n0" doxytag="PIndirectChannel::readChannel"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="classPChannel.html">PChannel</a>* PIndirectChannel::readChannel<code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Channel for read operations.
<p>
    </td>
  </tr>
</table>
<a name="n3" doxytag="PIndirectChannel::writeAutoDelete"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> BOOL PIndirectChannel::writeAutoDelete<code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Automatically delete write channel on destruction.
<p>
    </td>
  </tr>
</table>
<a name="n2" doxytag="PIndirectChannel::writeChannel"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="classPChannel.html">PChannel</a>* PIndirectChannel::writeChannel<code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Channel for write operations.
<p>
    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="indchan_8h-source.html">indchan.h</a><li><a class="el" href="osutil_8inl.html">osutil.inl</a></ul>
<hr><address style="align: right;"><small>Generated on Wed Sep 29 22:44:17 2004 for PWLib by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.2.18 </small></address>
</body>
</html>