SSLIOSession (aliyun-http-apache 0.2.15-beta API)

java.lang.Object
- com.aliyun.apache.hc.core5.reactor.ssl.SSLIOSession

所有已实现的接口:

SocketModalCloseable, ModalCloseable, IOSession, Identifiable, Closeable, AutoCloseable, ByteChannel, Channel, ReadableByteChannel, WritableByteChannel
```
@Contract(threading=SAFE_CONDITIONAL)
 @Internal
public class SSLIOSession
extends Object
implements IOSession
```
SSLIOSession is a decorator class intended to transparently extend an IOSession with transport layer security capabilities based on the SSL/TLS protocol.

从以下版本开始:

4.2

嵌套类概要
- 从接口继承的嵌套类/接口 com.aliyun.apache.hc.core5.reactor.IOSession
  IOSession.Status

构造器概要

构造器
构造器和说明
`SSLIOSession(NamedEndpoint targetEndpoint, IOSession session, SSLMode sslMode, SSLContext sslContext, SSLBufferMode sslBufferMode, SSLSessionInitializer initializer, SSLSessionVerifier verifier, Callback<SSLIOSession> sessionStartCallback, Callback<SSLIOSession> sessionEndCallback, Timeout connectTimeout)` Creates new instance of `SSLIOSession` class.
`SSLIOSession(NamedEndpoint targetEndpoint, IOSession session, SSLMode sslMode, SSLContext sslContext, SSLBufferMode sslBufferMode, SSLSessionInitializer initializer, SSLSessionVerifier verifier, Timeout handshakeTimeout, Callback<SSLIOSession> sessionStartCallback, Callback<SSLIOSession> sessionEndCallback, FutureCallback<SSLSession> resultCallback)` Creates new instance of `SSLIOSession` class.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`beginHandshake(IOSession protocolSession)`
`ByteChannel`	`channel()` Returns the underlying I/O channel associated with this session.
`void`	`clearEvent(int op)` Clears interest in a particular I/O event type by updating the event mask associated with the session.
`void`	`close()` Terminates the session gracefully and closes the underlying I/O channel.
`void`	`close(CloseMode closeMode)` Closes this process or endpoint and releases any system resources associated with it.
`void`	`enqueue(Command command, Command.Priority priority)` Inserts `Command` at the end of the command queue.
`int`	`getEventMask()` Returns mask of I/O evens this session declared interest in.
`IOEventHandler`	`getHandler()` Returns event handler associated with the session.
`String`	`getId()`
`long`	`getLastEventTime()` Returns timestamp of the last I/O event including socket timeout reset.
`long`	`getLastReadTime()` Returns timestamp of the last read event.
`long`	`getLastWriteTime()` Returns timestamp of the last write event.
`SocketAddress`	`getLocalAddress()` Returns local address.
`Lock`	`getLock()` Returns session lock that should be used by I/O event handlers to synchronize access to the session.
`SocketAddress`	`getRemoteAddress()` Returns address of the remote peer.
`Timeout`	`getSocketTimeout()` Returns value of the socket timeout in milliseconds.
`IOSession.Status`	`getStatus()` Returns status of the session: `IOSession.Status.ACTIVE`: session is active.
`TlsDetails`	`getTlsDetails()`
`boolean`	`hasCommands()` Tests if there enqueued commands pending execution.
`boolean`	`isOpen()`
`Command`	`poll()` Removes first `Command` from the command queue if available.
`int`	`read(ByteBuffer dst)`
`void`	`setEvent(int op)` Declares interest in a particular I/O event type by updating the event mask associated with the session.
`void`	`setEventMask(int ops)` Declares interest in I/O event notifications by setting the event mask associated with the session
`void`	`setSocketTimeout(Timeout timeout)` Sets value of the socket timeout in milliseconds.
`String`	`toString()`
`void`	`updateReadTime()` Updates the timestamp of the last read event
`void`	`updateWriteTime()` Updates the timestamp of the last write event
`void`	`upgrade(IOEventHandler handler)` Upgrades event handler associated with the session.
`int`	`write(ByteBuffer src)`

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

- 构造器详细资料
  - SSLIOSession
```
public SSLIOSession(NamedEndpoint targetEndpoint,
                    IOSession session,
                    SSLMode sslMode,
                    SSLContext sslContext,
                    SSLBufferMode sslBufferMode,
                    SSLSessionInitializer initializer,
                    SSLSessionVerifier verifier,
                    Callback<SSLIOSession> sessionStartCallback,
                    Callback<SSLIOSession> sessionEndCallback,
                    Timeout connectTimeout)
```
    Creates new instance of SSLIOSession class.
    
    参数:
    
    session - I/O session to be decorated with the TLS/SSL capabilities.
    
    sslMode - SSL mode (client or server)
    
    targetEndpoint - target endpoint (applicable in client mode only). May be null.
    
    sslContext - SSL context to use for this I/O session.
    
    sslBufferMode - buffer management mode
    
    initializer - optional SSL session initializer. May be null.
    
    verifier - optional SSL session verifier. May be null.
    
    connectTimeout - timeout to apply for the TLS/SSL handshake. May be null.
    
    从以下版本开始:
    
    5.0
  - SSLIOSession
```
public SSLIOSession(NamedEndpoint targetEndpoint,
                    IOSession session,
                    SSLMode sslMode,
                    SSLContext sslContext,
                    SSLBufferMode sslBufferMode,
                    SSLSessionInitializer initializer,
                    SSLSessionVerifier verifier,
                    Timeout handshakeTimeout,
                    Callback<SSLIOSession> sessionStartCallback,
                    Callback<SSLIOSession> sessionEndCallback,
                    FutureCallback<SSLSession> resultCallback)
```
    Creates new instance of SSLIOSession class.
    
    参数:
    
    session - I/O session to be decorated with the TLS/SSL capabilities.
    
    sslMode - SSL mode (client or server)
    
    targetEndpoint - target endpoint (applicable in client mode only). May be null.
    
    sslContext - SSL context to use for this I/O session.
    
    sslBufferMode - buffer management mode
    
    initializer - optional SSL session initializer. May be null.
    
    verifier - optional SSL session verifier. May be null.
    
    handshakeTimeout - timeout to apply for the TLS/SSL handshake. May be null.
    
    resultCallback - result callback. May be null.
    
    从以下版本开始:
    
    5.2
- 方法详细资料
  - getHandler
```
public IOEventHandler getHandler()
```
    从接口复制的说明: IOSession
    
    Returns event handler associated with the session.
    
    指定者:
    
    getHandler 在接口中 IOSession
  - beginHandshake
```
public void beginHandshake(IOSession protocolSession)
                    throws IOException
```
    抛出:
    
    IOException
  - write
```
public int write(ByteBuffer src)
          throws IOException
```
    指定者:
    
    write 在接口中 WritableByteChannel
    
    抛出:
    
    IOException
  - read
```
public int read(ByteBuffer dst)
```
    指定者:
    
    read 在接口中 ReadableByteChannel
  - getId
```
public String getId()
```
    指定者:
    
    getId 在接口中 Identifiable
  - getLock
```
public Lock getLock()
```
    从接口复制的说明: IOSession
    
    Returns session lock that should be used by I/O event handlers to synchronize access to the session.
    
    指定者:
    
    getLock 在接口中 IOSession
  - upgrade
```
public void upgrade(IOEventHandler handler)
```
    从接口复制的说明: IOSession
    
    Upgrades event handler associated with the session.
    
    指定者:
    
    upgrade 在接口中 IOSession
  - getTlsDetails
```
public TlsDetails getTlsDetails()
```
  - isOpen
```
public boolean isOpen()
```
    指定者:
    
    isOpen 在接口中 Channel
  - close
```
public void close()
```
    从接口复制的说明: IOSession
    
    Terminates the session gracefully and closes the underlying I/O channel. This method ensures that session termination handshake, such as the one used by the SSL/TLS protocol, is correctly carried out.
    
    指定者:
    
    close 在接口中 IOSession
    
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    指定者:
    
    close 在接口中 Channel
  - close
```
public void close(CloseMode closeMode)
```
    从接口复制的说明: ModalCloseable
    
    Closes this process or endpoint and releases any system resources associated with it. If the endpoint or the process is already closed then invoking this method has no effect.
    
    指定者:
    
    close 在接口中 ModalCloseable
    
    参数:
    
    closeMode - How to close the receiver.
  - getStatus
```
public IOSession.Status getStatus()
```
    从接口复制的说明: IOSession
    
    Returns status of the session:
    IOSession.Status.ACTIVE: session is active.
    IOSession.Status.CLOSING: session is being closed.
    IOSession.Status.CLOSED: session has been terminated.
    
    指定者:
    
    getStatus 在接口中 IOSession
    
    返回:
    
    session status.
  - enqueue
```
public void enqueue(Command command,
                    Command.Priority priority)
```
    从接口复制的说明: IOSession
    
    Inserts Command at the end of the command queue.
    
    指定者:
    
    enqueue 在接口中 IOSession
  - hasCommands
```
public boolean hasCommands()
```
    从接口复制的说明: IOSession
    
    Tests if there enqueued commands pending execution.
    
    指定者:
    
    hasCommands 在接口中 IOSession
  - poll
```
public Command poll()
```
    从接口复制的说明: IOSession
    
    Removes first Command from the command queue if available.
    
    指定者:
    
    poll 在接口中 IOSession
  - channel
```
public ByteChannel channel()
```
    从接口复制的说明: IOSession
    
    Returns the underlying I/O channel associated with this session.
    
    指定者:
    
    channel 在接口中 IOSession
    
    返回:
    
    the I/O channel.
  - getLocalAddress
```
public SocketAddress getLocalAddress()
```
    从接口复制的说明: IOSession
    
    Returns local address.
    
    指定者:
    
    getLocalAddress 在接口中 IOSession
    
    返回:
    
    socket address.
  - getRemoteAddress
```
public SocketAddress getRemoteAddress()
```
    从接口复制的说明: IOSession
    
    Returns address of the remote peer.
    
    指定者:
    
    getRemoteAddress 在接口中 IOSession
    
    返回:
    
    socket address.
  - getEventMask
```
public int getEventMask()
```
    从接口复制的说明: IOSession
    
    Returns mask of I/O evens this session declared interest in.
    
    指定者:
    
    getEventMask 在接口中 IOSession
    
    返回:
    
    I/O event mask.
  - setEventMask
```
public void setEventMask(int ops)
```
    从接口复制的说明: IOSession
    
    Declares interest in I/O event notifications by setting the event mask associated with the session
    
    指定者:
    
    setEventMask 在接口中 IOSession
    
    参数:
    
    ops - new I/O event mask.
  - setEvent
```
public void setEvent(int op)
```
    从接口复制的说明: IOSession
    
    Declares interest in a particular I/O event type by updating the event mask associated with the session.
    
    指定者:
    
    setEvent 在接口中 IOSession
    
    参数:
    
    op - I/O event type.
  - clearEvent
```
public void clearEvent(int op)
```
    从接口复制的说明: IOSession
    
    Clears interest in a particular I/O event type by updating the event mask associated with the session.
    
    指定者:
    
    clearEvent 在接口中 IOSession
    
    参数:
    
    op - I/O event type.
  - getSocketTimeout
```
public Timeout getSocketTimeout()
```
    从接口复制的说明: IOSession
    
    Returns value of the socket timeout in milliseconds. The value of 0 signifies the session cannot time out.
    
    指定者:
    
    getSocketTimeout 在接口中 SocketModalCloseable
    
    指定者:
    
    getSocketTimeout 在接口中 IOSession
    
    返回:
    
    socket timeout.
  - setSocketTimeout
```
public void setSocketTimeout(Timeout timeout)
```
    从接口复制的说明: IOSession
    
    Sets value of the socket timeout in milliseconds. The value of 0 signifies the session cannot time out.
    Please note this operation may affect the last event time.
    
    指定者:
    
    setSocketTimeout 在接口中 SocketModalCloseable
    
    指定者:
    
    setSocketTimeout 在接口中 IOSession
    
    参数:
    
    timeout - socket timeout.
    
    另请参阅:
    
    IOSession.getLastEventTime()
  - updateReadTime
```
public void updateReadTime()
```
    从接口复制的说明: IOSession
    
    Updates the timestamp of the last read event
    
    指定者:
    
    updateReadTime 在接口中 IOSession
  - updateWriteTime
```
public void updateWriteTime()
```
    从接口复制的说明: IOSession
    
    Updates the timestamp of the last write event
    
    指定者:
    
    updateWriteTime 在接口中 IOSession
  - getLastReadTime
```
public long getLastReadTime()
```
    从接口复制的说明: IOSession
    
    Returns timestamp of the last read event.
    
    指定者:
    
    getLastReadTime 在接口中 IOSession
    
    返回:
    
    timestamp.
  - getLastWriteTime
```
public long getLastWriteTime()
```
    从接口复制的说明: IOSession
    
    Returns timestamp of the last write event.
    
    指定者:
    
    getLastWriteTime 在接口中 IOSession
    
    返回:
    
    timestamp.
  - getLastEventTime
```
public long getLastEventTime()
```
    从接口复制的说明: IOSession
    
    Returns timestamp of the last I/O event including socket timeout reset.
    
    指定者:
    
    getLastEventTime 在接口中 IOSession
    
    返回:
    
    timestamp.
    
    另请参阅:
    
    IOSession.getSocketTimeout()
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object

类 SSLIOSession

嵌套类概要

从接口继承的嵌套类/接口 com.aliyun.apache.hc.core5.reactor.IOSession

构造器概要

方法概要

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

构造器详细资料

SSLIOSession

SSLIOSession

方法详细资料

getHandler

beginHandshake

write

read

getId

getLock

upgrade

getTlsDetails

isOpen

close

close

getStatus

enqueue

hasCommands

poll

channel

getLocalAddress

getRemoteAddress

getEventMask

setEventMask

setEvent

clearEvent

getSocketTimeout

setSocketTimeout

updateReadTime

updateWriteTime

getLastReadTime

getLastWriteTime

getLastEventTime

toString