ReferenceCountedOpenSslEngine (Netty 4.0.56.Final API文档

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

所有已实现的接口:

ReferenceCounted

直接已知子类:

OpenSslEngine
```
public class ReferenceCountedOpenSslEngine
extends javax.net.ssl.SSLEngine
implements ReferenceCounted
```
Implements a SSLEngine using OpenSSL BIO abstractions.
Instances of this class must be released or else native memory will leak!
Instances of this class must be released before the ReferenceCountedOpenSslContext the instance depends upon are released. Otherwise if any method of this class is called which uses the the ReferenceCountedOpenSslContext JNI resources the JVM may crash.

方法概要

方法
限定符和类型	方法和说明
`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()` Returns the name of the negotiated application-level protocol.
`byte[]`	`getOcspResponse()` Returns the OCSP response or `null` if the server didn't provide a stapled OCSP response.
`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()` Returns the reference count of this object.
`boolean`	`release()` Decreases the reference count by `1` and deallocates this object if the reference count reaches at `0`.
`boolean`	`release(int decrement)` Decreases the reference count by the specified `decrement` and deallocates this object if the reference count reaches at `0`.
`ReferenceCounted`	`retain()` Increases the reference count by `1`.
`ReferenceCounted`	`retain(int increment)` Increases the reference count by the specified `increment`.
`void`	`setEnabledCipherSuites(java.lang.String[] cipherSuites)`
`void`	`setEnabledProtocols(java.lang.String[] protocols)` TLS doesn't support a way to advertise non-contiguous versions from the client's perspective, and the client just advertises the max supported version.
`void`	`setEnableSessionCreation(boolean b)`
`void`	`setNeedClientAuth(boolean b)`
`void`	`setOcspResponse(byte[] response)` Sets the OCSP response.
`void`	`setSSLParameters(javax.net.ssl.SSLParameters sslParameters)`
`void`	`setUseClientMode(boolean clientMode)`
`void`	`setVerify(int verifyMode, int depth)` See SSL_set_verify and `SSL.setVerify(long, int, int)`.
`void`	`setWantClientAuth(boolean b)`
`void`	`shutdown()` Destroys this engine.
`long`	`sslPointer()` Returns the pointer to the `SSL` object for this `ReferenceCountedOpenSslEngine`.
`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)`

从类继承的方法 javax.net.ssl.SSLEngine
getPeerHost, getPeerPort, wrap

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - setOcspResponse
```
@UnstableApi
public void setOcspResponse(byte[] response)
```
    Sets the OCSP response.
  - getOcspResponse
```
@UnstableApi
public byte[] getOcspResponse()
```
    Returns the OCSP response or null if the server didn't provide a stapled OCSP response.
  - refCnt
```
public final int refCnt()
```
    从接口复制的说明: ReferenceCounted
    
    Returns the reference count of this object. If 0, it means this object has been deallocated.
    
    指定者:
    
    refCnt 在接口中 ReferenceCounted
  - retain
```
public final ReferenceCounted retain()
```
    从接口复制的说明: ReferenceCounted
    
    Increases the reference count by 1.
    
    指定者:
    
    retain 在接口中 ReferenceCounted
  - retain
```
public final ReferenceCounted retain(int increment)
```
    从接口复制的说明: ReferenceCounted
    
    Increases the reference count by the specified increment.
    
    指定者:
    
    retain 在接口中 ReferenceCounted
  - release
```
public final boolean release()
```
    从接口复制的说明: ReferenceCounted
    
    Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.
    
    指定者:
    
    release 在接口中 ReferenceCounted
    
    返回:
    true if and only if the reference count became 0 and this object has been deallocated
  - release
```
public final boolean release(int decrement)
```
    从接口复制的说明: ReferenceCounted
    
    Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.
    
    指定者:
    
    release 在接口中 ReferenceCounted
    
    返回:
    true if and only if the reference count became 0 and this object has been deallocated
  - getHandshakeSession
```
public final javax.net.ssl.SSLSession getHandshakeSession()
```
    覆盖:
    
    getHandshakeSession 在类中 javax.net.ssl.SSLEngine
  - sslPointer
```
public final long sslPointer()
```
    Returns the pointer to the SSL object for this ReferenceCountedOpenSslEngine. Be aware that it is freed as soon as the release() or shutdown() methods are called. At this point 0 will be returned.
  - shutdown
```
public final void shutdown()
```
    Destroys this engine.
  - 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
```
    指定者:
    
    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
```
    指定者:
    
    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()
```
    指定者:
    
    getDelegatedTask 在类中 javax.net.ssl.SSLEngine
  - closeInbound
```
public final void closeInbound()
                        throws javax.net.ssl.SSLException
```
    指定者:
    
    closeInbound 在类中 javax.net.ssl.SSLEngine
    
    抛出:
    
    javax.net.ssl.SSLException
  - isInboundDone
```
public final boolean isInboundDone()
```
    指定者:
    
    isInboundDone 在类中 javax.net.ssl.SSLEngine
  - closeOutbound
```
public final void closeOutbound()
```
    指定者:
    
    closeOutbound 在类中 javax.net.ssl.SSLEngine
  - isOutboundDone
```
public final boolean isOutboundDone()
```
    指定者:
    
    isOutboundDone 在类中 javax.net.ssl.SSLEngine
  - getSupportedCipherSuites
```
public final java.lang.String[] getSupportedCipherSuites()
```
    指定者:
    
    getSupportedCipherSuites 在类中 javax.net.ssl.SSLEngine
  - getEnabledCipherSuites
```
public final java.lang.String[] getEnabledCipherSuites()
```
    指定者:
    
    getEnabledCipherSuites 在类中 javax.net.ssl.SSLEngine
  - setEnabledCipherSuites
```
public final void setEnabledCipherSuites(java.lang.String[] cipherSuites)
```
    指定者:
    
    setEnabledCipherSuites 在类中 javax.net.ssl.SSLEngine
  - getSupportedProtocols
```
public final java.lang.String[] getSupportedProtocols()
```
    指定者:
    
    getSupportedProtocols 在类中 javax.net.ssl.SSLEngine
  - getEnabledProtocols
```
public final java.lang.String[] getEnabledProtocols()
```
    指定者:
    
    getEnabledProtocols 在类中 javax.net.ssl.SSLEngine
  - setEnabledProtocols
```
public final void setEnabledProtocols(java.lang.String[] protocols)
```
    TLS doesn't support a way to advertise non-contiguous versions from the client's perspective, and the client just advertises the max supported version. The TLS protocol also doesn't support all different combinations of discrete protocols, and instead assumes contiguous ranges. OpenSSL has some unexpected behavior (e.g. handshake failures) if non-contiguous protocols are used even where there is a compatible set of protocols and ciphers. For these reasons this method will determine the minimum protocol and the maximum protocol and enabled a contiguous range from [min protocol, max protocol] in OpenSSL.
    
    指定者:
    
    setEnabledProtocols 在类中 javax.net.ssl.SSLEngine
  - getSession
```
public final javax.net.ssl.SSLSession getSession()
```
    指定者:
    
    getSession 在类中 javax.net.ssl.SSLEngine
  - beginHandshake
```
public final void beginHandshake()
                          throws javax.net.ssl.SSLException
```
    指定者:
    
    beginHandshake 在类中 javax.net.ssl.SSLEngine
    
    抛出:
    
    javax.net.ssl.SSLException
  - getHandshakeStatus
```
public final javax.net.ssl.SSLEngineResult.HandshakeStatus getHandshakeStatus()
```
    指定者:
    
    getHandshakeStatus 在类中 javax.net.ssl.SSLEngine
  - setUseClientMode
```
public final void setUseClientMode(boolean clientMode)
```
    指定者:
    
    setUseClientMode 在类中 javax.net.ssl.SSLEngine
  - getUseClientMode
```
public final boolean getUseClientMode()
```
    指定者:
    
    getUseClientMode 在类中 javax.net.ssl.SSLEngine
  - setNeedClientAuth
```
public final void setNeedClientAuth(boolean b)
```
    指定者:
    
    setNeedClientAuth 在类中 javax.net.ssl.SSLEngine
  - getNeedClientAuth
```
public final boolean getNeedClientAuth()
```
    指定者:
    
    getNeedClientAuth 在类中 javax.net.ssl.SSLEngine
  - setWantClientAuth
```
public final void setWantClientAuth(boolean b)
```
    指定者:
    
    setWantClientAuth 在类中 javax.net.ssl.SSLEngine
  - getWantClientAuth
```
public final boolean getWantClientAuth()
```
    指定者:
    
    getWantClientAuth 在类中 javax.net.ssl.SSLEngine
  - setVerify
```
@UnstableApi
public final void setVerify(int verifyMode,
                         int depth)
```
    See SSL_set_verify and SSL.setVerify(long, int, int).
  - setEnableSessionCreation
```
public final void setEnableSessionCreation(boolean b)
```
    指定者:
    
    setEnableSessionCreation 在类中 javax.net.ssl.SSLEngine
  - getEnableSessionCreation
```
public final boolean getEnableSessionCreation()
```
    指定者:
    
    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()
```
    Returns the name of the negotiated application-level protocol.
    
    返回:
    the application-level protocol name or null if the negotiation failed or the client does not have ALPN/NPN extension

类 ReferenceCountedOpenSslEngine

方法概要

从类继承的方法 javax.net.ssl.SSLEngine

从类继承的方法 java.lang.Object

方法详细资料

setOcspResponse

getOcspResponse

refCnt

retain

retain

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