SSLSocketChannel (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- java.nio.channels.spi.AbstractInterruptibleChannel
- - java.nio.channels.SelectableChannel
  - - java.nio.channels.spi.AbstractSelectableChannel
    - - java.nio.channels.SocketChannel
      - net.i2p.sam.SSLSocketChannel

All Implemented Interfaces:
Closeable, AutoCloseable, ByteChannel, Channel, GatheringByteChannel, InterruptibleChannel, NetworkChannel, ReadableByteChannel, ScatteringByteChannel, WritableByteChannel
```
class SSLSocketChannel
extends SocketChannel
```
Simple wrapper for a SSLSocket. Cannot be used for asynch ops.

Constructor Summary
Constructors
Constructor and Description
SSLSocketChannel(SSLSocket socket)
Create a new SSLSocketChannel wrapping the given SSL socket.

Constructors
Constructor and Description
`SSLSocketChannel(SSLSocket socket)` Create a new SSLSocketChannel wrapping the given SSL socket.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SocketChannel`	`bind(SocketAddress local)` Bind is not supported by this wrapper.
`boolean`	`connect(SocketAddress remote)` Connect is not supported by this wrapper.
`boolean`	`finishConnect()` Finish connecting.
`SocketAddress`	`getLocalAddress()` Get the local socket address of the underlying SSL socket.
`<T> T`	`getOption(SocketOption<T> name)` Get the value of a socket option.
`SocketAddress`	`getRemoteAddress()` Get the remote socket address of the underlying SSL socket.
`void`	`implCloseSelectableChannel()` Close the underlying SSL socket.
`void`	`implConfigureBlocking(boolean block)` Configure the blocking mode.
`boolean`	`isConnected()` Check if the underlying SSL socket is connected.
`boolean`	`isConnectionPending()` Check if a connection operation is pending.
`int`	`read(ByteBuffer src)` Read bytes from the underlying SSL socket into the given buffer.
`long`	`read(ByteBuffer[] srcs, int offset, int length)` Scatter read is not supported by this wrapper.
`<T> SocketChannel`	`setOption(SocketOption<T> name, T value)` Set a socket option.
`SocketChannel`	`shutdownInput()` Shut down the input stream of the underlying SSL socket.
`SocketChannel`	`shutdownOutput()` Shut down the output stream of the underlying SSL socket.
`Socket`	`socket()` Return the underlying SSL socket.
`Set<SocketOption<?>>`	`supportedOptions()` Get the set of supported socket options.
`int`	`write(ByteBuffer src)` Write bytes from the given buffer to the underlying SSL socket.
`long`	`write(ByteBuffer[] srcs, int offset, int length)` Gather write is not supported by this wrapper.

Methods inherited from class java.nio.channels.SocketChannel
open, open, read, validOps, write

Methods inherited from class java.nio.channels.spi.AbstractSelectableChannel
blockingLock, configureBlocking, implCloseChannel, isBlocking, isRegistered, keyFor, provider, register

Methods inherited from class java.nio.channels.SelectableChannel
register

Methods inherited from class java.nio.channels.spi.AbstractInterruptibleChannel
begin, close, end, isOpen

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

Methods inherited from interface java.nio.channels.Channel
close, isOpen

- Constructor Detail
  - SSLSocketChannel
```
public SSLSocketChannel(SSLSocket socket)
```
    Create a new SSLSocketChannel wrapping the given SSL socket.
    Parameters:
    socket - the SSL socket to wrap
- Method Detail
  - bind
```
public SocketChannel bind(SocketAddress local)
```
    Bind is not supported by this wrapper.
    Specified by:
    bind in interface NetworkChannel
    Overrides:
    bind in class SocketChannel
    Parameters:
    local - the socket address to bind to (ignored)
    Returns:
    this channel (never returned)
    Throws:
    UnsupportedOperationException - always
  - connect
```
public boolean connect(SocketAddress remote)
```
    Connect is not supported by this wrapper.
    Specified by:
    connect in class SocketChannel
    Parameters:
    remote - the remote address to connect to (ignored)
    Returns:
    true (never reached)
    Throws:
    UnsupportedOperationException - always
  - finishConnect
```
public boolean finishConnect()
```
    Finish connecting. This wrapper assumes the connection is already established.
    Specified by:
    finishConnect in class SocketChannel
    Returns:
    true always
  - getLocalAddress
```
public SocketAddress getLocalAddress()
```
    Get the local socket address of the underlying SSL socket.
    Specified by:
    getLocalAddress in interface NetworkChannel
    Specified by:
    getLocalAddress in class SocketChannel
    Returns:
    the local socket address, or null if not bound
  - getOption
```
public <T> T getOption(SocketOption<T> name)
```
    Get the value of a socket option. Not supported, always returns null.
    Type Parameters:
    T - the type of the socket option value
    Parameters:
    name - the socket option name (ignored)
    Returns:
    null always
  - getRemoteAddress
```
public SocketAddress getRemoteAddress()
```
    Get the remote socket address of the underlying SSL socket.
    Specified by:
    getRemoteAddress in class SocketChannel
    Returns:
    the remote socket address, or null if not connected
  - implCloseSelectableChannel
```
public void implCloseSelectableChannel()
                                throws IOException
```
    Close the underlying SSL socket.
    Specified by:
    implCloseSelectableChannel in class AbstractSelectableChannel
    Throws:
    IOException - if an I/O error occurs while closing
  - implConfigureBlocking
```
public void implConfigureBlocking(boolean block)
                           throws IOException
```
    Configure the blocking mode. Only blocking mode is supported.
    Specified by:
    implConfigureBlocking in class AbstractSelectableChannel
    Parameters:
    block - true for blocking mode (accepted), false throws
    Throws:
    IOException - if an I/O error occurs
    UnsupportedOperationException - if block is false
  - isConnected
```
public boolean isConnected()
```
    Check if the underlying SSL socket is connected.
    Specified by:
    isConnected in class SocketChannel
    Returns:
    true if connected
  - isConnectionPending
```
public boolean isConnectionPending()
```
    Check if a connection operation is pending. Always returns false.
    Specified by:
    isConnectionPending in class SocketChannel
    Returns:
    false always
  - read
```
public int read(ByteBuffer src)
         throws IOException
```
    Read bytes from the underlying SSL socket into the given buffer. The buffer must have a backing array.
    Specified by:
    read in interface ReadableByteChannel
    Specified by:
    read in class SocketChannel
    Parameters:
    src - the buffer to read into
    Returns:
    the number of bytes read, or -1 if end of stream
    Throws:
    IOException - if an I/O error occurs
    UnsupportedOperationException - if the buffer has no backing array
  - read
```
public long read(ByteBuffer[] srcs,
                 int offset,
                 int length)
```
    Scatter read is not supported by this wrapper.
    Specified by:
    read in interface ScatteringByteChannel
    Specified by:
    read in class SocketChannel
    Parameters:
    srcs - the buffers to read into (ignored)
    offset - the offset in the buffer array (ignored)
    length - the number of buffers to use (ignored)
    Returns:
    the number of bytes read (never reached)
    Throws:
    UnsupportedOperationException - always
  - setOption
```
public <T> SocketChannel setOption(SocketOption<T> name,
                                   T value)
```
    Set a socket option. This is a no-op for this wrapper.
    Specified by:
    setOption in interface NetworkChannel
    Specified by:
    setOption in class SocketChannel
    Type Parameters:
    T - the type of the socket option value
    Parameters:
    name - the socket option name (ignored)
    value - the socket option value (ignored)
    Returns:
    this channel
  - shutdownInput
```
public SocketChannel shutdownInput()
                            throws IOException
```
    Shut down the input stream of the underlying SSL socket.
    Specified by:
    shutdownInput in class SocketChannel
    Returns:
    this channel
    Throws:
    IOException - if an I/O error occurs
  - shutdownOutput
```
public SocketChannel shutdownOutput()
                             throws IOException
```
    Shut down the output stream of the underlying SSL socket.
    Specified by:
    shutdownOutput in class SocketChannel
    Returns:
    this channel
    Throws:
    IOException - if an I/O error occurs
  - socket
```
public Socket socket()
```
    Return the underlying SSL socket.
    Specified by:
    socket in class SocketChannel
    Returns:
    the wrapped SSLSocket
  - supportedOptions
```
public Set<SocketOption<?>> supportedOptions()
```
    Get the set of supported socket options. Returns an empty set.
    Returns:
    an empty set of supported socket options
  - write
```
public int write(ByteBuffer src)
          throws IOException
```
    Write bytes from the given buffer to the underlying SSL socket. The buffer must have a backing array.
    Specified by:
    write in interface WritableByteChannel
    Specified by:
    write in class SocketChannel
    Parameters:
    src - the buffer to write from
    Returns:
    the number of bytes written
    Throws:
    IOException - if an I/O error occurs
    UnsupportedOperationException - if the buffer has no backing array
  - write
```
public long write(ByteBuffer[] srcs,
                  int offset,
                  int length)
```
    Gather write is not supported by this wrapper.
    Specified by:
    write in interface GatheringByteChannel
    Specified by:
    write in class SocketChannel
    Parameters:
    srcs - the buffers to write from (ignored)
    offset - the offset in the buffer array (ignored)
    length - the number of buffers to use (ignored)
    Returns:
    the number of bytes written (never reached)
    Throws:
    UnsupportedOperationException - always

Class SSLSocketChannel

Constructor Summary

Method Summary

Methods inherited from class java.nio.channels.SocketChannel

Methods inherited from class java.nio.channels.spi.AbstractSelectableChannel

Methods inherited from class java.nio.channels.SelectableChannel

Methods inherited from class java.nio.channels.spi.AbstractInterruptibleChannel

Methods inherited from class java.lang.Object

Methods inherited from interface java.nio.channels.Channel

Constructor Detail

SSLSocketChannel

Method Detail

bind

connect

finishConnect

getLocalAddress

getOption

getRemoteAddress

implCloseSelectableChannel

implConfigureBlocking

isConnected

isConnectionPending

read

read

setOption

shutdownInput

shutdownOutput

socket

supportedOptions

write

write