📄 classpsslchannel.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>PSSLChannel 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>PSSLChannel Class Reference</h1><code>#include <<a class="el" href="pssl_8h-source.html">pssl.h</a>></code><p><p>Inheritance diagram for PSSLChannel:<p><center><img src="classPSSLChannel.png" usemap="#PSSLChannel_map" border="0" alt=""></center><map name="PSSLChannel_map"><area href="classPIndirectChannel.html" alt="PIndirectChannel" shape="rect" coords="0,112,109,136"><area href="classPChannel.html" alt="PChannel" shape="rect" coords="0,56,109,80"><area href="classPObject.html" alt="PObject" shape="rect" coords="0,0,109,24"></map><a href="classPSSLChannel-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 Types</h2></td></tr><tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="classPSSLChannel.html#s3">VerifyMode</a> { <a class="el" href="classPSSLChannel.html#s3s0">VerifyNone</a>, <a class="el" href="classPSSLChannel.html#s3s1">VerifyPeer</a>, <a class="el" href="classPSSLChannel.html#s3s2">VerifyPeerMandatory</a> }</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="classPSSLChannel.html#a0">PSSLChannel</a> (<a class="el" href="classPSSLContext.html">PSSLContext</a> *<a class="el" href="classPSSLChannel.html#n0">context</a>=NULL, BOOL <a class="el" href="classPSSLChannel.html#n1">autoDeleteContext</a>=FALSE)</td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPSSLChannel.html#a1">PSSLChannel</a> (<a class="el" href="classPSSLContext.html">PSSLContext</a> &<a class="el" href="classPSSLChannel.html#n0">context</a>)</td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPSSLChannel.html#a2">~PSSLChannel</a> ()</td></tr><tr><td nowrap align=right valign=top>virtual BOOL </td><td valign=bottom><a class="el" href="classPSSLChannel.html#a3">Read</a> (void *buf, PINDEX len)</td></tr><tr><td nowrap align=right valign=top>virtual BOOL </td><td valign=bottom><a class="el" href="classPSSLChannel.html#a4">Write</a> (const void *buf, PINDEX len)</td></tr><tr><td nowrap align=right valign=top>virtual BOOL </td><td valign=bottom><a class="el" href="classPSSLChannel.html#a5">Close</a> ()</td></tr><tr><td nowrap align=right valign=top>virtual BOOL </td><td valign=bottom><a class="el" href="classPSSLChannel.html#a6">Shutdown</a> (<a class="el" href="classPChannel.html#z53_0">ShutdownValue</a>)</td></tr><tr><td nowrap align=right valign=top>virtual <a class="el" href="classPString.html">PString</a> </td><td valign=bottom><a class="el" href="classPSSLChannel.html#a7">GetErrorText</a> (<a class="el" href="classPChannel.html#z55_1">ErrorGroup</a> group=NumErrorGroups) const</td></tr><tr><td nowrap align=right valign=top>virtual BOOL </td><td valign=bottom><a class="el" href="classPSSLChannel.html#a8">ConvertOSError</a> (int error, <a class="el" href="classPChannel.html#z55_1">ErrorGroup</a> group=LastGeneralError)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPSSLChannel.html#a9">Accept</a> ()</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPSSLChannel.html#a10">Accept</a> (<a class="el" href="classPChannel.html">PChannel</a> &channel)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPSSLChannel.html#a11">Accept</a> (<a class="el" href="classPChannel.html">PChannel</a> *channel, BOOL autoDelete=TRUE)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPSSLChannel.html#a12">Connect</a> ()</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPSSLChannel.html#a13">Connect</a> (<a class="el" href="classPChannel.html">PChannel</a> &channel)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPSSLChannel.html#a14">Connect</a> (<a class="el" href="classPChannel.html">PChannel</a> *channel, BOOL autoDelete=TRUE)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPSSLChannel.html#a15">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="classPSSLChannel.html#a16">UsePrivateKey</a> (const <a class="el" href="classPSSLPrivateKey.html">PSSLPrivateKey</a> &key)</td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classPSSLChannel.html#a17">SetVerifyMode</a> (<a class="el" href="classPSSLChannel.html#s3">VerifyMode</a> mode)</td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPSSLContext.html">PSSLContext</a> * </td><td valign=bottom><a class="el" href="classPSSLChannel.html#a18">GetContext</a> () const</td></tr><tr><td nowrap align=right valign=top>virtual BOOL </td><td valign=bottom><a class="el" href="classPSSLChannel.html#a19">RawSSLRead</a> (void *buf, PINDEX &len)</td></tr><tr><td colspan=2><br><h2>Protected Methods</h2></td></tr><tr><td nowrap align=right valign=top>virtual BOOL </td><td valign=bottom><a class="el" href="classPSSLChannel.html#b0">OnOpen</a> ()</td></tr><tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPSSLContext.html">PSSLContext</a> * </td><td valign=bottom><a class="el" href="classPSSLChannel.html#n0">context</a></td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPSSLChannel.html#n1">autoDeleteContext</a></td></tr><tr><td nowrap align=right valign=top>ssl_st * </td><td valign=bottom><a class="el" href="classPSSLChannel.html#n2">ssl</a></td></tr></table><hr><a name="_details"></a><h2>Detailed Description</h2>This class will start a secure SSL based channel. <p><hr><h2>Member Enumeration Documentation</h2><a name="s3" doxytag="PSSLChannel::VerifyMode"></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"> enum PSSLChannel::VerifyMode </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p><dl compact><dt><b>Enumeration values: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em><a name="s3s0" doxytag="VerifyNone"></a><em>VerifyNone</em></em> </td><td></td></tr><tr><td valign=top><em><a name="s3s1" doxytag="VerifyPeer"></a><em>VerifyPeer</em></em> </td><td></td></tr><tr><td valign=top><em><a name="s3s2" doxytag="VerifyPeerMandatory"></a><em>VerifyPeerMandatory</em></em> </td><td></td></tr></table></dl> </td> </tr></table><hr><h2>Constructor & Destructor Documentation</h2><a name="a0" doxytag="PSSLChannel::PSSLChannel"></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"> PSSLChannel::PSSLChannel </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classPSSLContext.html">PSSLContext</a> * </td> <td class="mdname" nowrap> <em>context</em> = NULL, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>BOOL </td> <td class="mdname" nowrap> <em>autoDeleteContext</em> = FALSE</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 channel given the context. If no context is given a default one is created. <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>autoDeleteContext</em> </td><td>Context for SSL channel Flag for context to be automatically deleted. </td></tr></table></dl> </td> </tr></table><a name="a1" doxytag="PSSLChannel::PSSLChannel"></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"> PSSLChannel::PSSLChannel </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classPSSLContext.html">PSSLContext</a> & </td> <td class="mdname1" valign="top" nowrap> <em>context</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><dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>context</em> </td><td>Context for SSL channel </td></tr></table></dl> </td> </tr></table><a name="a2" doxytag="PSSLChannel::~PSSLChannel"></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"> PSSLChannel::~PSSLChannel </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>Close and clear the SSL channel. </td> </tr></table><hr><h2>Member Function Documentation</h2><a name="a11" doxytag="PSSLChannel::Accept"></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 PSSLChannel::Accept </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classPChannel.html">PChannel</a> * </td> <td class="mdname" nowrap> <em>channel</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>BOOL </td> <td class="mdname" nowrap> <em>autoDelete</em> = TRUE</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>Accept a new inbound connection (server). <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>autoDelete</em> </td><td>Channel to attach to. Flag for if channel should be automatically deleted. </td></tr></table></dl> </td> </tr></table><a name="a10" doxytag="PSSLChannel::Accept"></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 PSSLChannel::Accept </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classPChannel.html">PChannel</a> & </td> <td class="mdname1" valign="top" nowrap> <em>channel</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>Accept a new inbound connection (server). <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>channel</em> </td><td>Channel to attach to. </td></tr></table></dl> </td> </tr></table><a name="a9" doxytag="PSSLChannel::Accept"></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 PSSLChannel::Accept </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>Accept a new inbound connection (server). This version expects that the indirect channel has already been opened using <a class="el" href="classPIndirectChannel.html#z159_0">Open()</a> beforehand. </td> </tr></table><a name="a5" doxytag="PSSLChannel::Close"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -