classphttpresource.html

pwlib开发文档

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

<p>
Get a block of data that the resource contains.
<p>
The default behaviour is to call the <a class="el" href="classPHTTPResource.html#a19">LoadText()</a># function and if successful, call the <a class="el" href="classPHTTPResource.html#a20">OnLoadedText()</a># function.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if there is still more to load. </dl>
<p>
Reimplemented in <a class="el" href="classPHTTPFile.html#a8">PHTTPFile</a>, and <a class="el" href="classPHTTPTailFile.html#a7">PHTTPTailFile</a>.    </td>
  </tr>
</table>
<a name="a16" doxytag="PHTTPResource::LoadHeaders"></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 PHTTPResource::LoadHeaders </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classPHTTPRequest.html">PHTTPRequest</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>request</em>          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [pure virtual]</code></td>
        </tr>

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

<p>
Get the headers for block of data (eg HTML) that the resource contains. This will fill in all the fields of the <code>outMIME</code> parameter required by the resource and return the status for the load.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if all OK, FALSE if an error occurred. </dl>
<p>
Implemented in <a class="el" href="classPHTTPString.html#a6">PHTTPString</a>, <a class="el" href="classPHTTPFile.html#a7">PHTTPFile</a>, <a class="el" href="classPHTTPTailFile.html#a6">PHTTPTailFile</a>, <a class="el" href="classPHTTPDirectory.html#a3">PHTTPDirectory</a>, and <a class="el" href="classPXMLRPCServerResource.html#a4">PXMLRPCServerResource</a>.    </td>
  </tr>
</table>
<a name="a19" doxytag="PHTTPResource::LoadText"></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 <a class="el" href="classPString.html">PString</a> PHTTPResource::LoadText </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classPHTTPRequest.html">PHTTPRequest</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>request</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>
Get a block of text data (eg HTML) that the resource contains.
<p>
The default behaviour is to assert, one of <a class="el" href="classPHTTPResource.html#a19">LoadText()</a># or <a class="el" href="classPHTTPResource.html#a18">LoadData()</a># functions must be overridden for correct operation.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 String for loaded text. </dl>
<p>
Reimplemented in <a class="el" href="classPHTTPString.html#a7">PHTTPString</a>, <a class="el" href="classPHTTPFile.html#a9">PHTTPFile</a>, <a class="el" href="classPHTTPDirectory.html#a4">PHTTPDirectory</a>, <a class="el" href="classPRegisterPage.html#a1">PRegisterPage</a>, and <a class="el" href="classPServiceHTTPString.html#a5">PServiceHTTPString</a>.    </td>
  </tr>
</table>
<a name="a8" doxytag="PHTTPResource::OnGET"></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 PHTTPResource::OnGET </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classPHTTPServer.html">PHTTPServer</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>server</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="classPURL.html">PURL</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>url</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>info</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="classPHTTPConnectionInfo.html">PHTTPConnectionInfo</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>conInfo</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>
Handle the GET command passed from the HTTP socket.
<p>
The default action is to check the authorisation for the resource and call the virtuals <a class="el" href="classPHTTPResource.html#a16">LoadHeaders()</a># and <a class="el" href="classPHTTPResource.html#a9">OnGETData()</a># to get a resource to be sent to the socket.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if the connection may persist, FALSE if the connection must close. If there is no ContentLength field in the response, this value must be FALSE for correct operation. </dl>    </td>
  </tr>
</table>
<a name="a9" doxytag="PHTTPResource::OnGETData"></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 PHTTPResource::OnGETData </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classPHTTPServer.html">PHTTPServer</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>server</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="classPURL.html">PURL</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>url</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="classPHTTPConnectionInfo.html">PHTTPConnectionInfo</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>connectInfo</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="classPHTTPRequest.html">PHTTPRequest</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>request</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>
Send the data associated with a GET command.
<p>
The default action calls <a class="el" href="classPHTTPResource.html#a17">SendData()</a>#.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if the connection may persist, FALSE if the connection must close. If there is no ContentLength field in the response, this value must be FALSE for correct operation. </dl>    </td>
  </tr>
</table>
<a name="b5" doxytag="PHTTPResource::OnGETOrHEAD"></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 PHTTPResource::OnGETOrHEAD </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classPHTTPServer.html">PHTTPServer</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>server</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="classPURL.html">PURL</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>url</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>info</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="classPHTTPConnectionInfo.html">PHTTPConnectionInfo</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>conInfo</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>BOOL&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>IsGet</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [protected, virtual]</code></td>
        </tr>

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

<p>
common code for GET and HEAD commands     </td>
  </tr>
</table>
<a name="a10" doxytag="PHTTPResource::OnHEAD"></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 PHTTPResource::OnHEAD </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classPHTTPServer.html">PHTTPServer</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>server</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="classPURL.html">PURL</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>url</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>info</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="classPHTTPConnectionInfo.html">PHTTPConnectionInfo</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>conInfo</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>
Handle the HEAD command passed from the HTTP socket.
<p>
The default action is to check the authorisation for the resource and call the virtual <a class="el" href="classPHTTPResource.html#a16">LoadHeaders()</a># to get the header information to be sent to the socket.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if the connection may persist, FALSE if the connection must close If there is no ContentLength field in the response, this value must be FALSE for correct operation. </dl>    </td>
  </tr>
</table>
<a name="a20" doxytag="PHTTPResource::OnLoadedText"></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 void PHTTPResource::OnLoadedText </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classPHTTPRequest.html">PHTTPRequest</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>request</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="classPString.html">PString</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>text</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>