SSLSocketChannel2

java.lang.Object
- org.java_websocket.SSLSocketChannel2

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.nio.channels.ByteChannel, java.nio.channels.Channel, java.nio.channels.ReadableByteChannel, java.nio.channels.WritableByteChannel, WrappedByteChannel
```
public class SSLSocketChannel2
extends java.lang.Object
implements java.nio.channels.ByteChannel, WrappedByteChannel
```
Implements the relevant portions of the SocketChannel interface with the SSLEngine wrapper.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static java.nio.ByteBuffer`	`emptybuffer`
`protected javax.net.ssl.SSLEngineResult`	`engineResult`
`protected java.util.concurrent.ExecutorService`	`exec`
`protected java.nio.ByteBuffer`	`inCrypt` encrypted data incoming
`protected java.nio.ByteBuffer`	`inData` raw payload incomming
`protected java.nio.ByteBuffer`	`outCrypt` encrypted data outgoing
`protected java.nio.channels.SelectionKey`	`selectionKey` used to set interestOP SelectionKey.OP_WRITE for the underlying channel
`protected java.nio.channels.SocketChannel`	`socketChannel` the underlying channel
`protected javax.net.ssl.SSLEngine`	`sslEngine`
`protected java.util.List<java.util.concurrent.Future<?>>`	`tasks`

Constructor Summary

Constructors
Constructor and Description
`SSLSocketChannel2(java.nio.channels.SocketChannel channel, javax.net.ssl.SSLEngine sslEngine, java.util.concurrent.ExecutorService exec, java.nio.channels.SelectionKey key)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`java.nio.channels.SelectableChannel`	`configureBlocking(boolean b)`
`boolean`	`connect(java.net.SocketAddress remote)`
`protected void`	`consumeDelegatedTasks()`
`protected void`	`createBuffers(javax.net.ssl.SSLSession session)`
`boolean`	`finishConnect()`
`boolean`	`isBlocking()`
`boolean`	`isConnected()`
`boolean`	`isInboundDone()`
`boolean`	`isNeedRead()` returns whether readMore should be called to fetch data which has been decoded but not yet been returned.
`boolean`	`isNeedWrite()`
`boolean`	`isOpen()`
`int`	`read(java.nio.ByteBuffer dst)` Blocks when in blocking mode until at least one byte has been decoded. When not in blocking mode 0 may be returned.
`int`	`readMore(java.nio.ByteBuffer dst)` This function does not read data from the underlying channel at all.
`java.net.Socket`	`socket()`
`int`	`write(java.nio.ByteBuffer src)`
`void`	`writeMore()`

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

- Field Detail
  - emptybuffer
```
protected static java.nio.ByteBuffer emptybuffer
```
  - exec
```
protected java.util.concurrent.ExecutorService exec
```
  - tasks
```
protected java.util.List<java.util.concurrent.Future<?>> tasks
```
  - inData
```
protected java.nio.ByteBuffer inData
```
    raw payload incomming
  - outCrypt
```
protected java.nio.ByteBuffer outCrypt
```
    encrypted data outgoing
  - inCrypt
```
protected java.nio.ByteBuffer inCrypt
```
    encrypted data incoming
  - socketChannel
```
protected java.nio.channels.SocketChannel socketChannel
```
    the underlying channel
  - selectionKey
```
protected java.nio.channels.SelectionKey selectionKey
```
    used to set interestOP SelectionKey.OP_WRITE for the underlying channel
  - engineResult
```
protected javax.net.ssl.SSLEngineResult engineResult
```
  - sslEngine
```
protected javax.net.ssl.SSLEngine sslEngine
```
- Constructor Detail
  - SSLSocketChannel2
```
public SSLSocketChannel2(java.nio.channels.SocketChannel channel,
                         javax.net.ssl.SSLEngine sslEngine,
                         java.util.concurrent.ExecutorService exec,
                         java.nio.channels.SelectionKey key)
                  throws java.io.IOException
```
    Throws:
    
    java.io.IOException
- Method Detail
  - consumeDelegatedTasks
```
protected void consumeDelegatedTasks()
```
  - createBuffers
```
protected void createBuffers(javax.net.ssl.SSLSession session)
```
  - write
```
public int write(java.nio.ByteBuffer src)
          throws java.io.IOException
```
    Specified by:
    
    write in interface java.nio.channels.WritableByteChannel
    
    Throws:
    
    java.io.IOException
  - read
```
public int read(java.nio.ByteBuffer dst)
         throws java.io.IOException
```
    Blocks when in blocking mode until at least one byte has been decoded.
    When not in blocking mode 0 may be returned.
    
    Specified by:
    
    read in interface java.nio.channels.ReadableByteChannel
    
    Throws:
    
    java.io.IOException
  - isConnected
```
public boolean isConnected()
```
  - close
```
public void close()
           throws java.io.IOException
```
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface java.nio.channels.Channel
    
    Throws:
    
    java.io.IOException
  - configureBlocking
```
public java.nio.channels.SelectableChannel configureBlocking(boolean b)
                                                      throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - connect
```
public boolean connect(java.net.SocketAddress remote)
                throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - finishConnect
```
public boolean finishConnect()
                      throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - socket
```
public java.net.Socket socket()
```
  - isInboundDone
```
public boolean isInboundDone()
```
  - isOpen
```
public boolean isOpen()
```
    Specified by:
    
    isOpen in interface java.nio.channels.Channel
  - isNeedWrite
```
public boolean isNeedWrite()
```
    Specified by:
    
    isNeedWrite in interface WrappedByteChannel
  - writeMore
```
public void writeMore()
               throws java.io.IOException
```
    Specified by:
    
    writeMore in interface WrappedByteChannel
    
    Throws:
    
    java.io.IOException
  - isNeedRead
```
public boolean isNeedRead()
```
    Description copied from interface: WrappedByteChannel
    
    returns whether readMore should be called to fetch data which has been decoded but not yet been returned.
    
    Specified by:
    
    isNeedRead in interface WrappedByteChannel
    
    See Also:
    
    ReadableByteChannel.read(ByteBuffer), WrappedByteChannel.readMore(ByteBuffer)
  - readMore
```
public int readMore(java.nio.ByteBuffer dst)
             throws javax.net.ssl.SSLException
```
    Description copied from interface: WrappedByteChannel
    
    This function does not read data from the underlying channel at all. It is just a way to fetch data which has already be received or decoded but was but was not yet returned to the user. This could be the case when the decoded data did not fit into the buffer the user passed to ReadableByteChannel.read(ByteBuffer).
    
    Specified by:
    
    readMore in interface WrappedByteChannel
    
    Throws:
    
    javax.net.ssl.SSLException
  - isBlocking
```
public boolean isBlocking()
```
    Specified by:
    
    isBlocking in interface WrappedByteChannel

Class SSLSocketChannel2

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

emptybuffer

exec

tasks

inData

outCrypt

inCrypt

socketChannel

selectionKey

engineResult

sslEngine

Constructor Detail

SSLSocketChannel2

Method Detail

consumeDelegatedTasks

createBuffers

write

read

isConnected

close

configureBlocking

connect

finishConnect

socket

isInboundDone

isOpen

isNeedWrite

writeMore

isNeedRead

readMore

isBlocking