uTools-Manuals/docs/java/javax/net/ssl/SSLEngineResult.html

299 lines
13 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<div class="header">
<div class="subTitle">
compact1, compact2, compact3
</div>
<div class="subTitle">
javax.net.ssl
</div>
<h2 class="title" title="Class SSLEngineResult">Class SSLEngineResult</h2>
</div><div class="contentContainer">
<ul class="inheritance">
<li><a href="../../../java/lang/Object.html" title="class in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>javax.net.ssl.SSLEngineResult</li>
</ul> </li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr/> <br/> <pre>public class <span class="typeNameLabel">SSLEngineResult</span>
extends <a href="../../../java/lang/Object.html" title="class in java.lang">Object</a></pre>
<div class="block">
<span><code>SSLEngine</code> I / O调用产生的结果状态的<code>SSLEngine</code></span>
<p> <span>A <code>SSLEngine</code>提供了在两个对等体之间建立安全通信会话的手段。</span> <span><code>SSLEngine</code>操作通常从输入缓冲区消耗字节并在输出缓冲区中产生字节。</span> <span>此类提供描述的状态运算结果值<code>SSLEngine</code> ,包括需要哪些操作完成正在进行的握手指示。</span> <span>最后,它报告由于此操作而消耗和生成的字节数。</span> </p>
</div>
<dl>
<dt>
<span class="simpleTagLabel">从以下版本开始:</span>
</dt>
<dd>
1.5
</dd>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<span><a href="../../../javax/net/ssl/SSLEngine.html" title="javax.net.ssl中的类"><code>SSLEngine</code></a> <a href="../../../javax/net/ssl/SSLEngine.html#wrap-java.nio.ByteBuffer-java.nio.ByteBuffer-"><code>SSLEngine.wrap(ByteBuffer, ByteBuffer)</code></a> <a href="../../../javax/net/ssl/SSLEngine.html#unwrap-java.nio.ByteBuffer-java.nio.ByteBuffer-"><code>SSLEngine.unwrap(ByteBuffer, ByteBuffer)</code></a></span>
</dd>
</dl> </li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- --> </a> <h3>Nested Class Summary</h3>
<table border="0" cellpadding="3" cellspacing="0" class="memberSummary" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption>
<span>Nested Classes</span>
<span class="tabEnd"> </span>
</caption>
<tbody>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/net/ssl/SSLEngineResult.HandshakeStatus.html" title="enum in javax.net.ssl">SSLEngineResult.HandshakeStatus</a></span></code>
<div class="block">
一个
<code>SSLEngineResult</code>枚举描述了这个
<code>SSLEngine</code>的当前握手状态。
</div> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/net/ssl/SSLEngineResult.Status.html" title="enum in javax.net.ssl">SSLEngineResult.Status</a></span></code>
<div class="block">
一个
<code>SSLEngineResult</code>枚举描述的整体结果
<code>SSLEngine</code>操作。
</div> </td>
</tr>
</tbody>
</table> </li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- --> </a> <h3>构造方法摘要</h3>
<table border="0" cellpadding="3" cellspacing="0" class="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation">
<caption>
<span>构造方法</span>
<span class="tabEnd"> </span>
</caption>
<tbody>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../javax/net/ssl/SSLEngineResult.html#SSLEngineResult-javax.net.ssl.SSLEngineResult.Status-javax.net.ssl.SSLEngineResult.HandshakeStatus-int-int-">SSLEngineResult</a></span>(<a href="../../../javax/net/ssl/SSLEngineResult.Status.html" title="enum in javax.net.ssl">SSLEngineResult.Status</a> status, <a href="../../../javax/net/ssl/SSLEngineResult.HandshakeStatus.html" title="enum in javax.net.ssl">SSLEngineResult.HandshakeStatus</a> handshakeStatus, int bytesConsumed, int bytesProduced)</code>
<div class="block">
初始化此类的新实例。
</div> </td>
</tr>
</tbody>
</table> </li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- --> </a> <h3>方法摘要</h3>
<table border="0" cellpadding="3" cellspacing="0" class="memberSummary" summary="Method Summary table, listing methods, and an explanation">
<caption>
<span class="activeTableTab" id="t0"><span>所有方法</span><span class="tabEnd"> </span></span>
<span class="tableTab" id="t2"><span><a href="javascript:show(2);">接口方法</a></span><span class="tabEnd"> </span></span>
<span class="tableTab" id="t4"><span><a href="javascript:show(8);">具体的方法</a></span><span class="tabEnd"> </span></span>
</caption>
<tbody>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor" id="i0">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/net/ssl/SSLEngineResult.html#bytesConsumed--">bytesConsumed</a></span>()</code>
<div class="block">
返回从输入缓冲区消耗的字节数。
</div> </td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/net/ssl/SSLEngineResult.html#bytesProduced--">bytesProduced</a></span>()</code>
<div class="block">
返回写入输出缓冲区的字节数。
</div> </td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code><a href="../../../javax/net/ssl/SSLEngineResult.HandshakeStatus.html" title="enum in javax.net.ssl">SSLEngineResult.HandshakeStatus</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/net/ssl/SSLEngineResult.html#getHandshakeStatus--">getHandshakeStatus</a></span>()</code>
<div class="block">
获取此
<code>SSLEngine</code>操作的握手状态。
</div> </td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code><a href="../../../javax/net/ssl/SSLEngineResult.Status.html" title="enum in javax.net.ssl">SSLEngineResult.Status</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/net/ssl/SSLEngineResult.html#getStatus--">getStatus</a></span>()</code>
<div class="block">
获取此
<code>SSLEngine</code>操作的返回值。
</div> </td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code><a href="../../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/net/ssl/SSLEngineResult.html#toString--">toString</a></span>()</code>
<div class="block">
返回此对象的String表示形式。
</div> </td>
</tr>
</tbody>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- --> </a> <h3>Methods inherited from class java.lang.<a href="../../../java/lang/Object.html" title="class in java.lang">Object</a></h3> <code><a href="../../../java/lang/Object.html#clone--">clone</a>, <a href="../../../java/lang/Object.html#equals-java.lang.Object-">equals</a>, <a href="../../../java/lang/Object.html#finalize--">finalize</a>, <a href="../../../java/lang/Object.html#getClass--">getClass</a>, <a href="../../../java/lang/Object.html#hashCode--">hashCode</a>, <a href="../../../java/lang/Object.html#notify--">notify</a>, <a href="../../../java/lang/Object.html#notifyAll--">notifyAll</a>, <a href="../../../java/lang/Object.html#wait--">wait</a>, <a href="../../../java/lang/Object.html#wait-long-">wait</a>, <a href="../../../java/lang/Object.html#wait-long-int-">wait</a></code></li>
</ul> </li>
</ul> </li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- --> </a> <h3>构造方法详细信息</h3> <a name="SSLEngineResult-javax.net.ssl.SSLEngineResult.Status-javax.net.ssl.SSLEngineResult.HandshakeStatus-int-int-">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>SSLEngineResult</h4> <pre>public SSLEngineResult(<a href="../../../javax/net/ssl/SSLEngineResult.Status.html" title="enum in javax.net.ssl">SSLEngineResult.Status</a> status,
<a href="../../../javax/net/ssl/SSLEngineResult.HandshakeStatus.html" title="enum in javax.net.ssl">SSLEngineResult.HandshakeStatus</a> handshakeStatus,
int bytesConsumed,
int bytesProduced)</pre>
<div class="block">
初始化此类的新实例。
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>status</code> - 操作的返回值。
</dd>
<dd>
<code>handshakeStatus</code> - 目前握手状态。
</dd>
<dd>
<code>bytesConsumed</code> - 从源ByteBuffer消耗的字节数
</dd>
<dd>
<code>bytesProduced</code> - 放入目的地ByteBuffer的字节数
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../java/lang/IllegalArgumentException.html" title="class in java.lang">IllegalArgumentException</a></code> - 如果
<code>status</code>
<code>handshakeStatus</code>参数为空,或者如果
<code>bytesConsumed</code>
<code>bytesProduced</code>为负。
</dd>
</dl> </li>
</ul> </li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- --> </a> <h3>方法详细信息</h3> <a name="getStatus--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getStatus</h4> <pre>public final <a href="../../../javax/net/ssl/SSLEngineResult.Status.html" title="enum in javax.net.ssl">SSLEngineResult.Status</a> getStatus()</pre>
<div class="block">
获取此
<code>SSLEngine</code>操作的返回值。
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
返回值
</dd>
</dl> </li>
</ul> <a name="getHandshakeStatus--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getHandshakeStatus</h4> <pre>public final <a href="../../../javax/net/ssl/SSLEngineResult.HandshakeStatus.html" title="enum in javax.net.ssl">SSLEngineResult.HandshakeStatus</a> getHandshakeStatus()</pre>
<div class="block">
获取此
<code>SSLEngine</code>操作的握手状态。
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
握手状态
</dd>
</dl> </li>
</ul> <a name="bytesConsumed--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>bytesConsumed</h4> <pre>public final int bytesConsumed()</pre>
<div class="block">
返回从输入缓冲区消耗的字节数。
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
消耗的字节数。
</dd>
</dl> </li>
</ul> <a name="bytesProduced--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>bytesProduced</h4> <pre>public final int bytesProduced()</pre>
<div class="block">
返回写入输出缓冲区的字节数。
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
生成的字节数
</dd>
</dl> </li>
</ul> <a name="toString--">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>toString</h4> <pre>public <a href="../../../java/lang/String.html" title="class in java.lang">String</a> toString()</pre>
<div class="block">
返回此对象的String表示形式。
</div>
<dl>
<dt>
<span class="overrideSpecifyLabel">重写:</span>
</dt>
<dd>
<code><a href="../../../java/lang/Object.html#toString--">toString</a></code>
<code><a href="../../../java/lang/Object.html" title="class in java.lang">Object</a></code>
</dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
对象的字符串表示形式。
</dd>
</dl> </li>
</ul> </li>
</ul> </li>
</ul>
</div>
</div>