ReferenceCountedOpenSslEngine (Netty API Reference (4.1.22.Final))

java.lang.Object
- javax.net.ssl.SSLEngine
- - io.netty.handler.ssl.ReferenceCountedOpenSslEngine

All Implemented Interfaces:

ReferenceCounted

已知直接子类：

OpenSslEngine
```
public class ReferenceCountedOpenSslEngine
extends javax.net.ssl.SSLEngine
implements ReferenceCounted
```
实现一个SSLEngine使用OpenSSL BIO abstractions 。
这个类的实例必须是released ，否则本机内存会泄漏！

这个类的实例必须在之前发布ReferenceCountedOpenSslContext实例取决于被释放。否则，如果调用此类的任何方法，并且使用ReferenceCountedOpenSslContext JNI资源，那么JVM可能会崩溃。

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`void`	`beginHandshake()`
`void`	`closeInbound()`
`void`	`closeOutbound()`
`java.lang.Runnable`	`getDelegatedTask()`
`java.lang.String[]`	`getEnabledCipherSuites()`
`java.lang.String[]`	`getEnabledProtocols()`
`boolean`	`getEnableSessionCreation()`
`javax.net.ssl.SSLSession`	`getHandshakeSession()`
`javax.net.ssl.SSLEngineResult.HandshakeStatus`	`getHandshakeStatus()`
`boolean`	`getNeedClientAuth()`
`java.lang.String`	`getNegotiatedApplicationProtocol()` 返回协商的应用程序级协议的名称。
`byte[]`	`getOcspResponse()` 如果服务器未提供装订的OCSP响应，则返回OCSP响应或 `null` 。
`javax.net.ssl.SSLSession`	`getSession()`
`javax.net.ssl.SSLParameters`	`getSSLParameters()`
`java.lang.String[]`	`getSupportedCipherSuites()`
`java.lang.String[]`	`getSupportedProtocols()`
`boolean`	`getUseClientMode()`
`boolean`	`getWantClientAuth()`
`boolean`	`isInboundDone()`
`boolean`	`isOutboundDone()`
`int`	`refCnt()` 返回此对象的引用计数。
`boolean`	`release()` 通过减小引用计数 `1`并且如果所述引用计数达到在将释放该对象 `0` 。
`boolean`	`release(int decrement)` 减小由指定的引用计数 `decrement`并且如果所述引用计数达到在将释放该对象 `0` 。
`ReferenceCounted`	`retain()` 将引用计数增加 `1` 。
`ReferenceCounted`	`retain(int increment)` 通过指定的 `increment`增加引用计数。
`void`	`setEnabledCipherSuites(java.lang.String[] cipherSuites)`
`void`	`setEnabledProtocols(java.lang.String[] protocols)` TLS不支持从客户端的角度发布非连续版本的方法，客户端只是通告最大支持版本。
`void`	`setEnableSessionCreation(boolean b)`
`void`	`setNeedClientAuth(boolean b)`
`void`	`setOcspResponse(byte[] response)` 设置OCSP响应。
`void`	`setSSLParameters(javax.net.ssl.SSLParameters sslParameters)`
`void`	`setUseClientMode(boolean clientMode)`
`void`	`setVerify(int verifyMode, int depth)` 见 SSL_set_verify和 `SSL.setVerify(long, int, int)` 。
`void`	`setWantClientAuth(boolean b)`
`void`	`shutdown()` 摧毁这个引擎。
`long`	`sslPointer()` 返回指向此`ReferenceCountedOpenSslEngine`的`SSL`对象的指针。
`ReferenceCounted`	`touch()` 记录此对象的当前访问位置以进行调试。
`ReferenceCounted`	`touch(java.lang.Object hint)` 记录此对象的当前访问位置，并附加一些用于调试的任意信息。
`javax.net.ssl.SSLEngineResult`	`unwrap(java.nio.ByteBuffer[] srcs, java.nio.ByteBuffer[] dsts)`
`javax.net.ssl.SSLEngineResult`	`unwrap(java.nio.ByteBuffer[] srcs, int srcsOffset, int srcsLength, java.nio.ByteBuffer[] dsts, int dstsOffset, int dstsLength)`
`javax.net.ssl.SSLEngineResult`	`unwrap(java.nio.ByteBuffer src, java.nio.ByteBuffer dst)`
`javax.net.ssl.SSLEngineResult`	`unwrap(java.nio.ByteBuffer src, java.nio.ByteBuffer[] dsts)`
`javax.net.ssl.SSLEngineResult`	`unwrap(java.nio.ByteBuffer src, java.nio.ByteBuffer[] dsts, int offset, int length)`
`javax.net.ssl.SSLEngineResult`	`wrap(java.nio.ByteBuffer[] srcs, int offset, int length, java.nio.ByteBuffer dst)`
`javax.net.ssl.SSLEngineResult`	`wrap(java.nio.ByteBuffer src, java.nio.ByteBuffer dst)`

Methods inherited from class javax.net.ssl.SSLEngine
getPeerHost, getPeerPort, wrap

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细信息
  - setOcspResponse
```
@UnstableApi
public void setOcspResponse(byte[] response)
```
    设置OCSP响应。
  - getOcspResponse
```
@UnstableApi
public byte[] getOcspResponse()
```
    如果服务器未提供装订的OCSP响应，则返回OCSP响应或 null 。
  - refCnt
```
public final int refCnt()
```
    从接口ReferenceCounted复制的描述
    
    返回此对象的引用计数。如果0 ，则表示该对象已被释放。
    
    Specified by:
    
    refCnt ，界面 ReferenceCounted
  - retain
```
public final ReferenceCounted retain()
```
    从接口ReferenceCounted复制的描述
    
    将引用计数增加 1 。
    
    Specified by:
    
    retain ，界面 ReferenceCounted
  - retain
```
public final ReferenceCounted retain(int increment)
```
    从接口ReferenceCounted复制的描述
    
    通过指定的 increment增加参考计数。
    
    Specified by:
    
    retain在界面 ReferenceCounted
  - touch
```
public final ReferenceCounted touch()
```
    从接口复制的描述： ReferenceCounted
    
    记录此对象的当前访问位置以进行调试。如果确定此物体泄漏，则通过此操作记录的信息将通过ResourceLeakDetector提供给您。此方法是touch(null)的快捷方式。
    
    Specified by:
    
    touch在界面 ReferenceCounted
  - touch
```
public final ReferenceCounted touch(java.lang.Object hint)
```
    从接口ReferenceCounted复制的描述
    
    记录此对象的当前访问位置，并附加一些用于调试的任意信息。如果确定此物体泄漏，则通过此操作记录的信息将通过ResourceLeakDetector提供给您。
    
    Specified by:
    
    touch在界面 ReferenceCounted
  - release
```
public final boolean release()
```
    从接口ReferenceCounted复制的描述
    
    通过减小引用计数 1并且如果所述引用计数达到在将释放该对象 0 。
    
    Specified by:
    
    release在界面 ReferenceCounted
    
    结果
    
    true当且仅当引用计数变为 0且此对象已被释放
  - release
```
public final boolean release(int decrement)
```
    从接口ReferenceCounted复制的描述
    
    减小由指定的引用计数 decrement并且如果所述引用计数达到在将释放该对象 0 。
    
    Specified by:
    
    release在界面 ReferenceCounted
    
    结果
    
    true当且仅当引用计数变为 0且此对象已被释放
  - getHandshakeSession
```
public final javax.net.ssl.SSLSession getHandshakeSession()
```
    重写：
    
    getHandshakeSession在类 javax.net.ssl.SSLEngine
  - sslPointer
```
public final long sslPointer()
```
    返回指向此ReferenceCountedOpenSslEngine的SSL对象的指针。请注意，只要调用release()或shutdown()方法就会释放它。此时将返回0 。
  - shutdown
```
public final void shutdown()
```
    摧毁这个引擎。
  - wrap
```
public final javax.net.ssl.SSLEngineResult wrap(java.nio.ByteBuffer[] srcs,
                                                int offset,
                                                int length,
                                                java.nio.ByteBuffer dst)
                                         throws javax.net.ssl.SSLException
```
    Specified by:
    
    wrap在课堂上 javax.net.ssl.SSLEngine
    
    异常
    
    javax.net.ssl.SSLException
  - unwrap
```
public final javax.net.ssl.SSLEngineResult unwrap(java.nio.ByteBuffer[] srcs,
                                                  int srcsOffset,
                                                  int srcsLength,
                                                  java.nio.ByteBuffer[] dsts,
                                                  int dstsOffset,
                                                  int dstsLength)
                                           throws javax.net.ssl.SSLException
```
    异常
    
    javax.net.ssl.SSLException
  - unwrap
```
public final javax.net.ssl.SSLEngineResult unwrap(java.nio.ByteBuffer[] srcs,
                                                  java.nio.ByteBuffer[] dsts)
                                           throws javax.net.ssl.SSLException
```
    异常
    
    javax.net.ssl.SSLException
  - unwrap
```
public final javax.net.ssl.SSLEngineResult unwrap(java.nio.ByteBuffer src,
                                                  java.nio.ByteBuffer[] dsts,
                                                  int offset,
                                                  int length)
                                           throws javax.net.ssl.SSLException
```
    Specified by:
    
    unwrap在课堂上 javax.net.ssl.SSLEngine
    
    异常
    
    javax.net.ssl.SSLException
  - wrap
```
public final javax.net.ssl.SSLEngineResult wrap(java.nio.ByteBuffer src,
                                                java.nio.ByteBuffer dst)
                                         throws javax.net.ssl.SSLException
```
    重写：
    
    wrap在课堂上 javax.net.ssl.SSLEngine
    
    异常
    
    javax.net.ssl.SSLException
  - unwrap
```
public final javax.net.ssl.SSLEngineResult unwrap(java.nio.ByteBuffer src,
                                                  java.nio.ByteBuffer dst)
                                           throws javax.net.ssl.SSLException
```
    重写：
    
    unwrap在课堂上 javax.net.ssl.SSLEngine
    
    异常
    
    javax.net.ssl.SSLException
  - unwrap
```
public final javax.net.ssl.SSLEngineResult unwrap(java.nio.ByteBuffer src,
                                                  java.nio.ByteBuffer[] dsts)
                                           throws javax.net.ssl.SSLException
```
    重写：
    
    unwrap javax.net.ssl.SSLEngine
    
    异常
    
    javax.net.ssl.SSLException
  - getDelegatedTask
```
public final java.lang.Runnable getDelegatedTask()
```
    Specified by:
    
    getDelegatedTask在课堂上 javax.net.ssl.SSLEngine
  - closeInbound
```
public final void closeInbound()
                        throws javax.net.ssl.SSLException
```
    Specified by:
    
    closeInbound在课堂上 javax.net.ssl.SSLEngine
    
    异常
    
    javax.net.ssl.SSLException
  - isInboundDone
```
public final boolean isInboundDone()
```
    Specified by:
    
    isInboundDone在课堂上 javax.net.ssl.SSLEngine
  - closeOutbound
```
public final void closeOutbound()
```
    Specified by:
    
    closeOutbound在课堂上 javax.net.ssl.SSLEngine
  - isOutboundDone
```
public final boolean isOutboundDone()
```
    Specified by:
    
    isOutboundDone javax.net.ssl.SSLEngine
  - getSupportedCipherSuites
```
public final java.lang.String[] getSupportedCipherSuites()
```
    Specified by:
    
    getSupportedCipherSuites在课堂上 javax.net.ssl.SSLEngine
  - getEnabledCipherSuites
```
public final java.lang.String[] getEnabledCipherSuites()
```
    Specified by:
    
    getEnabledCipherSuites在课堂上 javax.net.ssl.SSLEngine
  - setEnabledCipherSuites
```
public final void setEnabledCipherSuites(java.lang.String[] cipherSuites)
```
    Specified by:
    
    setEnabledCipherSuites在课堂上 javax.net.ssl.SSLEngine
  - getSupportedProtocols
```
public final java.lang.String[] getSupportedProtocols()
```
    Specified by:
    
    getSupportedProtocols在课堂上 javax.net.ssl.SSLEngine
  - getEnabledProtocols
```
public final java.lang.String[] getEnabledProtocols()
```
    Specified by:
    
    getEnabledProtocols在课堂上 javax.net.ssl.SSLEngine
  - setEnabledProtocols
```
public final void setEnabledProtocols(java.lang.String[] protocols)
```
    TLS不支持从客户端的角度发布非连续版本的方法，客户端只是通告最大支持版本。 TLS协议也不支持离散协议的所有不同组合，而是采用连续的范围。如果使用非连续协议，即使存在一组兼容协议和密码，OpenSSL也会有一些意外行为（例如握手失败）。由于这些原因，此方法将确定最小协议和最大协议，并在OpenSSL中启用[最小协议，最大协议]的连续范围。
    
    Specified by:
    
    setEnabledProtocols在课堂上 javax.net.ssl.SSLEngine
  - getSession
```
public final javax.net.ssl.SSLSession getSession()
```
    Specified by:
    
    getSession在课堂上 javax.net.ssl.SSLEngine
  - beginHandshake
```
public final void beginHandshake()
                          throws javax.net.ssl.SSLException
```
    Specified by:
    
    beginHandshake在课堂上 javax.net.ssl.SSLEngine
    
    异常
    
    javax.net.ssl.SSLException
  - getHandshakeStatus
```
public final javax.net.ssl.SSLEngineResult.HandshakeStatus getHandshakeStatus()
```
    Specified by:
    
    getHandshakeStatus在课堂上 javax.net.ssl.SSLEngine
  - setUseClientMode
```
public final void setUseClientMode(boolean clientMode)
```
    Specified by:
    
    setUseClientMode在课堂 javax.net.ssl.SSLEngine
  - getUseClientMode
```
public final boolean getUseClientMode()
```
    Specified by:
    
    getUseClientMode在课堂 javax.net.ssl.SSLEngine
  - setNeedClientAuth
```
public final void setNeedClientAuth(boolean b)
```
    Specified by:
    
    setNeedClientAuth在课堂上 javax.net.ssl.SSLEngine
  - getNeedClientAuth
```
public final boolean getNeedClientAuth()
```
    Specified by:
    
    getNeedClientAuth在课堂上 javax.net.ssl.SSLEngine
  - setWantClientAuth
```
public final void setWantClientAuth(boolean b)
```
    Specified by:
    
    setWantClientAuth在课程 javax.net.ssl.SSLEngine
  - getWantClientAuth
```
public final boolean getWantClientAuth()
```
    Specified by:
    
    getWantClientAuth在课堂上 javax.net.ssl.SSLEngine
  - setVerify
```
@UnstableApi
public final void setVerify(int verifyMode,
                                         int depth)
```
    见 SSL_set_verify和 SSL.setVerify(long, int, int) 。
  - setEnableSessionCreation
```
public final void setEnableSessionCreation(boolean b)
```
    Specified by:
    
    setEnableSessionCreation javax.net.ssl.SSLEngine
  - getEnableSessionCreation
```
public final boolean getEnableSessionCreation()
```
    Specified by:
    
    getEnableSessionCreation在课堂上 javax.net.ssl.SSLEngine
  - getSSLParameters
```
public final javax.net.ssl.SSLParameters getSSLParameters()
```
    重写：
    
    getSSLParameters javax.net.ssl.SSLEngine
  - setSSLParameters
```
public final void setSSLParameters(javax.net.ssl.SSLParameters sslParameters)
```
    重写：
    
    setSSLParameters在类 javax.net.ssl.SSLEngine
  - getNegotiatedApplicationProtocol
```
public java.lang.String getNegotiatedApplicationProtocol()
```
    返回协商的应用程序级协议的名称。
    
    结果
    
    如果协商失败或客户端没有ALPN / NPN扩展名， null应用级协议名称或 null

Class ReferenceCountedOpenSslEngine

方法摘要

Methods inherited from class javax.net.ssl.SSLEngine

Methods inherited from class java.lang.Object

方法详细信息

setOcspResponse

getOcspResponse

refCnt

retain

retain

touch

touch

release

release

getHandshakeSession

sslPointer

shutdown

wrap

unwrap

unwrap

unwrap

wrap

unwrap

unwrap

getDelegatedTask

closeInbound

isInboundDone

closeOutbound

isOutboundDone

getSupportedCipherSuites

getEnabledCipherSuites

setEnabledCipherSuites

getSupportedProtocols

getEnabledProtocols

setEnabledProtocols

getSession

beginHandshake

getHandshakeStatus

setUseClientMode

getUseClientMode

setNeedClientAuth

getNeedClientAuth

setWantClientAuth

getWantClientAuth

setVerify

setEnableSessionCreation

getEnableSessionCreation

getSSLParameters

setSSLParameters

getNegotiatedApplicationProtocol