📄 classphttpsimpleauth.html

📁 pwlib开发文档
💻 HTML
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>PHTTPSimpleAuth class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.2.18 --><center><a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center><hr><h1>PHTTPSimpleAuth Class Reference</h1><code>#include &lt;<a class="el" href="http_8h-source.html">http.h</a>&gt;</code><p><p>Inheritance diagram for PHTTPSimpleAuth:<p><center><img src="classPHTTPSimpleAuth.png" usemap="#PHTTPSimpleAuth_map" border="0" alt=""></center><map name="PHTTPSimpleAuth_map"><area href="classPHTTPAuthority.html" alt="PHTTPAuthority" shape="rect" coords="0,56,114,80"><area href="classPObject.html" alt="PObject" shape="rect" coords="0,0,114,24"></map><a href="classPHTTPSimpleAuth-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0><tr><td></td></tr><tr><td colspan=2><br><h2>Public Methods</h2></td></tr><tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classPHTTPSimpleAuth.html#a0">PHTTPSimpleAuth</a> (const <a class="el" href="classPString.html">PString</a> &amp;<a class="el" href="classPHTTPSimpleAuth.html#n0">realm</a>, const <a class="el" href="classPString.html">PString</a> &amp;<a class="el" href="classPHTTPSimpleAuth.html#n1">username</a>, const <a class="el" href="classPString.html">PString</a> &amp;<a class="el" href="classPHTTPSimpleAuth.html#n2">password</a>)</td></tr><tr><td nowrap align=right valign=top>virtual <a class="el" href="classPObject.html">PObject</a> *&nbsp;</td><td valign=bottom><a class="el" href="classPHTTPSimpleAuth.html#a1">Clone</a> () const</td></tr><tr><td nowrap align=right valign=top>virtual <a class="el" href="classPString.html">PString</a>&nbsp;</td><td valign=bottom><a class="el" href="classPHTTPSimpleAuth.html#a2">GetRealm</a> (const <a class="el" href="classPHTTPRequest.html">PHTTPRequest</a> &amp;request) const</td></tr><tr><td nowrap align=right valign=top>virtual BOOL&nbsp;</td><td valign=bottom><a class="el" href="classPHTTPSimpleAuth.html#a3">Validate</a> (const <a class="el" href="classPHTTPRequest.html">PHTTPRequest</a> &amp;request, const <a class="el" href="classPString.html">PString</a> &amp;authInfo) const</td></tr><tr><td nowrap align=right valign=top>virtual BOOL&nbsp;</td><td valign=bottom><a class="el" href="classPHTTPSimpleAuth.html#a4">IsActive</a> () const</td></tr><tr><td nowrap align=right valign=top>const <a class="el" href="classPString.html">PString</a> &amp;&nbsp;</td><td valign=bottom><a class="el" href="classPHTTPSimpleAuth.html#a5">GetUserName</a> () const</td></tr><tr><td nowrap align=right valign=top>const <a class="el" href="classPString.html">PString</a> &amp;&nbsp;</td><td valign=bottom><a class="el" href="classPHTTPSimpleAuth.html#a6">GetPassword</a> () const</td></tr><tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPString.html">PString</a>&nbsp;</td><td valign=bottom><a class="el" href="classPHTTPSimpleAuth.html#n0">realm</a></td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPString.html">PString</a>&nbsp;</td><td valign=bottom><a class="el" href="classPHTTPSimpleAuth.html#n1">username</a></td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPString.html">PString</a>&nbsp;</td><td valign=bottom><a class="el" href="classPHTTPSimpleAuth.html#n2">password</a></td></tr></table><hr><a name="_details"></a><h2>Detailed Description</h2>This class describes the simplest authorisation mechanism for a Universal Resource Locator, a fixed realm, username and password. <p><hr><h2>Constructor &amp; Destructor Documentation</h2><a name="a0" doxytag="PHTTPSimpleAuth::PHTTPSimpleAuth"></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"> PHTTPSimpleAuth::PHTTPSimpleAuth </td>          <td class="md" valign="top">(&nbsp;</td>          <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> &amp;&nbsp;</td>          <td class="mdname" nowrap>&nbsp; <em>realm</em>, </td>        </tr>        <tr>          <td></td>          <td></td>          <td class="md" nowrap>const <a class="el" href="classPString.html">PString</a> &amp;&nbsp;</td>          <td class="mdname" nowrap>&nbsp; <em>username</em>, </td>        </tr>        <tr>          <td></td>          <td></td>          <td class="md" nowrap>const <a class="el" href="classPString.html">PString</a> &amp;&nbsp;</td>          <td class="mdname" nowrap>&nbsp; <em>password</em></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>    </td>  </tr></table><hr><h2>Member Function Documentation</h2><a name="a1" doxytag="PHTTPSimpleAuth::Clone"></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="classPObject.html">PObject</a>* PHTTPSimpleAuth::Clone </td>          <td class="md" valign="top">(&nbsp;</td>          <td class="mdname1" valign="top" nowrap>&nbsp;          </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>Create a copy of the class on the heap. This is used by the PHTTPResource# classes for maintaining authorisation to resources.<p><dl compact><dt><b>Returns: </b></dt><dd> pointer to new copy of the class instance. </dl><p>Reimplemented from <a class="el" href="classPObject.html#z203_0">PObject</a>.    </td>  </tr></table><a name="a6" doxytag="PHTTPSimpleAuth::GetPassword"></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"> const <a class="el" href="classPString.html">PString</a>&amp; PHTTPSimpleAuth::GetPassword </td>          <td class="md" valign="top">(&nbsp;</td>          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>          <td class="md" valign="top">)&nbsp;</td>          <td class="md" nowrap> const<code> [inline]</code></td>        </tr>      </table>    </td>  </tr></table><table cellspacing=5 cellpadding=0 border=0>  <tr>    <td>      &nbsp;    </td>    <td><p>Get the password allocated to this simple authorisation.<p><dl compact><dt><b>Returns: </b></dt><dd> String for the authorisation password. </dl>    </td>  </tr></table><a name="a2" doxytag="PHTTPSimpleAuth::GetRealm"></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> PHTTPSimpleAuth::GetRealm </td>          <td class="md" valign="top">(&nbsp;</td>          <td class="md" nowrap valign="top">const <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> const<code> [virtual]</code></td>        </tr>      </table>    </td>  </tr></table><table cellspacing=5 cellpadding=0 border=0>  <tr>    <td>      &nbsp;    </td>    <td><p>Get the realm or name space for the user authorisation name and password as required by the basic authorisation system of HTTP/1.0.<p><dl compact><dt><b>Returns: </b></dt><dd> String for the authorisation realm name. </dl><p>Implements <a class="el" href="classPHTTPAuthority.html#a0">PHTTPAuthority</a>.    </td>  </tr></table><a name="a5" doxytag="PHTTPSimpleAuth::GetUserName"></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"> const <a class="el" href="classPString.html">PString</a>&amp; PHTTPSimpleAuth::GetUserName </td>          <td class="md" valign="top">(&nbsp;</td>          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>          <td class="md" valign="top">)&nbsp;</td>          <td class="md" nowrap> const<code> [inline]</code></td>        </tr>      </table>    </td>  </tr></table><table cellspacing=5 cellpadding=0 border=0>  <tr>    <td>      &nbsp;    </td>    <td><p>Get the user name allocated to this simple authorisation.<p><dl compact><dt><b>Returns: </b></dt><dd> String for the authorisation user name. </dl>    </td>  </tr></table><a name="a4" doxytag="PHTTPSimpleAuth::IsActive"></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 PHTTPSimpleAuth::IsActive </td>          <td class="md" valign="top">(&nbsp;</td>          <td class="mdname1" valign="top" nowrap>&nbsp;          </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>Determine if the authirisation is to be applied. This could be used to distinguish between net requiring authorisation and requiring autorisation but having no password.<p>The default behaviour is to return TRUE.<p><dl compact><dt><b>Returns: </b></dt><dd> TRUE if the authorisation in the realm is to be applied. </dl><p>Reimplemented from <a class="el" href="classPHTTPAuthority.html#a2">PHTTPAuthority</a>.    </td>  </tr></table><a name="a3" doxytag="PHTTPSimpleAuth::Validate"></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 PHTTPSimpleAuth::Validate </td>          <td class="md" valign="top">(&nbsp;</td>          <td class="md" nowrap valign="top">const <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>const <a class="el" href="classPString.html">PString</a> &amp;&nbsp;</td>          <td class="mdname" nowrap>&nbsp; <em>authInfo</em></td>        </tr>        <tr>          <td></td>          <td class="md">)&nbsp;</td>          <td class="md" colspan="2"> const<code> [virtual]</code></td>        </tr>      </table>    </td>  </tr></table><table cellspacing=5 cellpadding=0 border=0>  <tr>    <td>      &nbsp;    </td>    <td><p>Validate the user and password provided by the remote HTTP client for the realm specified by the class instance.<p><dl compact><dt><b>Returns: </b></dt><dd> TRUE if the user and password are authorised in the realm. </dl><p>Implements <a class="el" href="classPHTTPAuthority.html#a1">PHTTPAuthority</a>.    </td>  </tr></table><hr><h2>Member Data Documentation</h2><a name="n2" doxytag="PHTTPSimpleAuth::password"></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="classPString.html">PString</a> PHTTPSimpleAuth::password<code> [protected]</code>      </table>    </td>  </tr></table><table cellspacing=5 cellpadding=0 border=0>  <tr>    <td>      &nbsp;    </td>    <td><p>    </td>  </tr></table><a name="n0" doxytag="PHTTPSimpleAuth::realm"></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="classPString.html">PString</a> PHTTPSimpleAuth::realm<code> [protected]</code>      </table>    </td>  </tr></table><table cellspacing=5 cellpadding=0 border=0>  <tr>    <td>      &nbsp;    </td>    <td><p>    </td>  </tr></table><a name="n1" doxytag="PHTTPSimpleAuth::username"></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="classPString.html">PString</a> PHTTPSimpleAuth::username<code> [protected]</code>      </table>    </td>  </tr></table><table cellspacing=5 cellpadding=0 border=0>  <tr>    <td>      &nbsp;    </td>    <td><p>    </td>  </tr></table><hr>The documentation for this class was generated from the following file:<ul><li><a class="el" href="http_8h-source.html">http.h</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>
⌨️ 快捷键说明

复制代码 Ctrl + C
搜索代码 Ctrl + F
全屏模式 F11
切换主题 Ctrl + Shift + D
显示快捷键 ?
增大字号 Ctrl + =
减小字号 Ctrl + -