📄 classpsslcontext.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>PSSLContext 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> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center><hr><h1>PSSLContext Class Reference</h1><code>#include <<a class="el" href="pssl_8h-source.html">pssl.h</a>></code><p><a href="classPSSLContext-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> </td><td valign=bottom><a class="el" href="classPSSLContext.html#a0">PSSLContext</a> (const void *sessionId=NULL, PINDEX idSize=0)</td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPSSLContext.html#a1">~PSSLContext</a> ()</td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPSSLContext.html#a2">operator ssl_ctx_st *</a> () const</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPSSLContext.html#a3">SetCAPath</a> (const <a class="el" href="classPDirectory.html">PDirectory</a> &caPath)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPSSLContext.html#a4">SetCAFile</a> (const <a class="el" href="classPFilePath.html">PFilePath</a> &caFile)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPSSLContext.html#a5">UseCertificate</a> (const <a class="el" href="classPSSLCertificate.html">PSSLCertificate</a> &certificate)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPSSLContext.html#a6">UsePrivateKey</a> (const <a class="el" href="classPSSLPrivateKey.html">PSSLPrivateKey</a> &key)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPSSLContext.html#a7">UseDiffieHellman</a> (const <a class="el" href="classPSSLDiffieHellman.html">PSSLDiffieHellman</a> &dh)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPSSLContext.html#a8">SetCipherList</a> (const <a class="el" href="classPString.html">PString</a> &ciphers)</td></tr><tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr><tr><td nowrap align=right valign=top>ssl_ctx_st * </td><td valign=bottom><a class="el" href="classPSSLContext.html#n0">context</a></td></tr></table><hr><a name="_details"></a><h2>Detailed Description</h2>Context for SSL channels. This class embodies a common environment for all connections made via SSL using the <a class="el" href="classPSSLChannel.html">PSSLChannel</a> class. It includes such things as the version of SSL and certificates, CA's etc. <p><hr><h2>Constructor & Destructor Documentation</h2><a name="a0" doxytag="PSSLContext::PSSLContext"></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"> PSSLContext::PSSLContext </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const void * </td> <td class="mdname" nowrap> <em>sessionId</em> = NULL, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>PINDEX </td> <td class="mdname" nowrap> <em>idSize</em> = 0</td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Create a new context for SSL channels. An optional session ID may be provided in the context. This is used to identify sessions across multiple channels in this context. The session ID is a completely arbitrary block of data. If sessionId is non NULL and idSize is zero, then sessionId is assumed to be a pointer to a C string. <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>idSize</em> </td><td>Pointer to session ID Size of session ID </td></tr></table></dl> </td> </tr></table><a name="a1" doxytag="PSSLContext::~PSSLContext"></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"> PSSLContext::~PSSLContext </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Clean up the SSL context. </td> </tr></table><hr><h2>Member Function Documentation</h2><a name="a2" doxytag="PSSLContext::operator ssl_ctx_st *"></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"> PSSLContext::operator ssl_ctx_st * </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap> const<code> [inline]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Get the internal SSL context structure. </td> </tr></table><a name="a4" doxytag="PSSLContext::SetCAFile"></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 PSSLContext::SetCAFile </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classPFilePath.html">PFilePath</a> & </td> <td class="mdname1" valign="top" nowrap> <em>caFile</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Set the CA certificate file. <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>caFile</em> </td><td>CA certificate file </td></tr></table></dl> </td> </tr></table><a name="a3" doxytag="PSSLContext::SetCAPath"></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 PSSLContext::SetCAPath </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classPDirectory.html">PDirectory</a> & </td> <td class="mdname1" valign="top" nowrap> <em>caPath</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Set the path to locate CA certificates. <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>caPath</em> </td><td>Directory for CA certificates </td></tr></table></dl> </td> </tr></table><a name="a8" doxytag="PSSLContext::SetCipherList"></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 PSSLContext::SetCipherList </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> & </td> <td class="mdname1" valign="top" nowrap> <em>ciphers</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Set the available ciphers to those listed. <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>ciphers</em> </td><td>List of cipher names. </td></tr></table></dl> </td> </tr></table><a name="a5" doxytag="PSSLContext::UseCertificate"></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 PSSLContext::UseCertificate </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classPSSLCertificate.html">PSSLCertificate</a> & </td> <td class="mdname1" valign="top" nowrap> <em>certificate</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Use the certificate specified. </td> </tr></table><a name="a7" doxytag="PSSLContext::UseDiffieHellman"></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 PSSLContext::UseDiffieHellman </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classPSSLDiffieHellman.html">PSSLDiffieHellman</a> & </td> <td class="mdname1" valign="top" nowrap> <em>dh</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Use the Diffie-Hellman parameters specified. </td> </tr></table><a name="a6" doxytag="PSSLContext::UsePrivateKey"></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 PSSLContext::UsePrivateKey </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classPSSLPrivateKey.html">PSSLPrivateKey</a> & </td> <td class="mdname1" valign="top" nowrap> <em>key</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Use the private key specified. </td> </tr></table><hr><h2>Member Data Documentation</h2><a name="n0" doxytag="PSSLContext::context"></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"> ssl_ctx_st* PSSLContext::context<code> [protected]</code> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p> </td> </tr></table><hr>The documentation for this class was generated from the following file:<ul><li><a class="el" href="pssl_8h-source.html">pssl.h</a></ul><hr><address style="align: right;"><small>Generated on Wed Sep 29 22:44:19 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 + -