BaseDelegatingSocketChannel (ice4j 2.0.0-SNAPSHOT API)

java.lang.Object
- java.nio.channels.spi.AbstractInterruptibleChannel
- - java.nio.channels.SelectableChannel
  - - java.nio.channels.spi.AbstractSelectableChannel
    - - java.nio.channels.SocketChannel
      - org.ice4j.socket.BaseDelegatingSocketChannel<T>

All Implemented Interfaces:

Closeable, AutoCloseable, ByteChannel, Channel, GatheringByteChannel, InterruptibleChannel, NetworkChannel, ReadableByteChannel, ScatteringByteChannel, WritableByteChannel

Direct Known Subclasses:

DelegatingSocketChannel
```
public class BaseDelegatingSocketChannel<T extends SocketChannel>
extends SocketChannel
```
Implements a SocketChannel which delegates (its method calls) to another SocketChannel. In other words, the former wraps the latter.

Author:

Lyubomir Marinov

Field Summary

Fields
Modifier and Type	Field and Description
`protected T`	`delegate` The `SocketChannel` this instance delegates (its method calls) to.
`private Socket`	`socket` The `Socket` to be reported by this instance.
`private Object`	`socketSyncRoot` The `Object` which synchronizes the access to `socket`.

Constructor Summary

Constructors
Constructor and Description
`BaseDelegatingSocketChannel(T delegate)` Initializes a new `BaseDelegatingSocketChannel` instance which is to delegate (its method calls) to a specific `SocketChannel`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SocketChannel`	`bind(SocketAddress local)` Forwards to `delegate` and returns `this`.
`boolean`	`connect(SocketAddress remote)` Forwards to `delegate`.
`boolean`	`finishConnect()` Forwards to `delegate`.
`SocketAddress`	`getLocalAddress()` Forwards to `delegate`.
`<U> U`	`getOption(SocketOption<U> name)` Forwards to `delegate`.
`SocketAddress`	`getRemoteAddress()` Forwards to `delegate`.
`protected void`	`implCloseSelectableChannel()` Forwards to `delegate`.
`protected void`	`implConfigureBlocking(boolean block)` Forwards to `delegate`.
`protected Socket`	`implSocket(Socket socket)` Allows extenders to optionally configure (e.g.
`boolean`	`isConnected()` Forwards to `delegate`.
`boolean`	`isConnectionPending()` Forwards to `delegate`.
`int`	`read(ByteBuffer dst)` Forwards to `delegate`.
`long`	`read(ByteBuffer[] dsts, int offset, int length)` Forwards to `delegate`.
`<U> SocketChannel`	`setOption(SocketOption<U> name, U value)` Forwards to `delegate` and returns `this`.
`SocketChannel`	`shutdownInput()` Forwards to `delegate` and returns `this`.
`SocketChannel`	`shutdownOutput()` Forwards to `delegate` and returns `this`.
`Socket`	`socket()` Allows wrapping the `socket` of `delegate`.
`Set<SocketOption<?>>`	`supportedOptions()` Forwards to `delegate`.
`int`	`write(ByteBuffer src)` Forwards to `delegate`.
`long`	`write(ByteBuffer[] srcs, int offset, int length)` Forwards to `delegate`.

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

- Field Detail
  - delegate
```
protected final T extends SocketChannel delegate
```
    The SocketChannel this instance delegates (its method calls) to.
  - socket
```
private Socket socket
```
    The Socket to be reported by this instance.
  - socketSyncRoot
```
private final Object socketSyncRoot
```
    The Object which synchronizes the access to socket.
- Constructor Detail
  - BaseDelegatingSocketChannel
```
public BaseDelegatingSocketChannel(T delegate)
```
    Initializes a new BaseDelegatingSocketChannel instance which is to delegate (its method calls) to a specific SocketChannel.
    
    Parameters:
    
    delegate - the SocketChannel the new instance is to delegate (its method calls) to
- Method Detail
  - bind
```
public SocketChannel bind(SocketAddress local)
                   throws IOException
```
    Forwards to delegate and returns this.
    
    Specified by:
    
    bind in interface NetworkChannel
    
    Overrides:
    
    bind in class SocketChannel
    
    Throws:
    
    IOException
  - connect
```
public boolean connect(SocketAddress remote)
                throws IOException
```
    Forwards to delegate.
    
    Specified by:
    
    connect in class SocketChannel
    
    Throws:
    
    IOException
  - finishConnect
```
public boolean finishConnect()
                      throws IOException
```
    Forwards to delegate.
    
    Specified by:
    
    finishConnect in class SocketChannel
    
    Throws:
    
    IOException
  - getLocalAddress
```
public SocketAddress getLocalAddress()
                              throws IOException
```
    Forwards to delegate.
    
    Specified by:
    
    getLocalAddress in interface NetworkChannel
    
    Specified by:
    
    getLocalAddress in class SocketChannel
    
    Throws:
    
    IOException
  - getOption
```
public <U> U getOption(SocketOption<U> name)
                throws IOException
```
    Forwards to delegate.
    
    Throws:
    
    IOException
  - getRemoteAddress
```
public SocketAddress getRemoteAddress()
                               throws IOException
```
    Forwards to delegate.
    
    Specified by:
    
    getRemoteAddress in class SocketChannel
    
    Throws:
    
    IOException
  - implCloseSelectableChannel
```
protected void implCloseSelectableChannel()
                                   throws IOException
```
    Forwards to delegate.
    
    Specified by:
    
    implCloseSelectableChannel in class AbstractSelectableChannel
    
    Throws:
    
    IOException
  - implConfigureBlocking
```
protected void implConfigureBlocking(boolean block)
                              throws IOException
```
    Forwards to delegate.
    
    Specified by:
    
    implConfigureBlocking in class AbstractSelectableChannel
    
    Throws:
    
    IOException
  - implSocket
```
protected Socket implSocket(Socket socket)
                     throws IOException
```
    Allows extenders to optionally configure (e.g. wrap) the Socket of delegate and before it is returned by socket().
    
    Parameters:
    
    socket - the Socket of delegate
    
    Returns:
    
    the Socket to be returned by socket() (in place of socket)
    
    Throws:
    
    IOException - if an I/O error occurs
  - isConnected
```
public boolean isConnected()
```
    Forwards to delegate.
    
    Specified by:
    
    isConnected in class SocketChannel
  - isConnectionPending
```
public boolean isConnectionPending()
```
    Forwards to delegate.
    
    Specified by:
    
    isConnectionPending in class SocketChannel
  - read
```
public int read(ByteBuffer dst)
         throws IOException
```
    Forwards to delegate.
    
    Specified by:
    
    read in interface ReadableByteChannel
    
    Specified by:
    
    read in class SocketChannel
    
    Throws:
    
    IOException
  - read
```
public long read(ByteBuffer[] dsts,
                 int offset,
                 int length)
          throws IOException
```
    Forwards to delegate.
    
    Specified by:
    
    read in interface ScatteringByteChannel
    
    Specified by:
    
    read in class SocketChannel
    
    Throws:
    
    IOException
  - setOption
```
public <U> SocketChannel setOption(SocketOption<U> name,
                                   U value)
                            throws IOException
```
    Forwards to delegate and returns this.
    
    Specified by:
    
    setOption in interface NetworkChannel
    
    Specified by:
    
    setOption in class SocketChannel
    
    Throws:
    
    IOException
  - shutdownInput
```
public SocketChannel shutdownInput()
                            throws IOException
```
    Forwards to delegate and returns this.
    
    Specified by:
    
    shutdownInput in class SocketChannel
    
    Throws:
    
    IOException
  - shutdownOutput
```
public SocketChannel shutdownOutput()
                             throws IOException
```
    Forwards to delegate and returns this.
    
    Specified by:
    
    shutdownOutput in class SocketChannel
    
    Throws:
    
    IOException
  - socket
```
public Socket socket()
```
    Allows wrapping the socket of delegate.
    
    Specified by:
    
    socket in class SocketChannel
  - supportedOptions
```
public Set<SocketOption<?>> supportedOptions()
```
    Forwards to delegate.
  - write
```
public int write(ByteBuffer src)
          throws IOException
```
    Forwards to delegate.
    
    Specified by:
    
    write in interface WritableByteChannel
    
    Specified by:
    
    write in class SocketChannel
    
    Throws:
    
    IOException
  - write
```
public long write(ByteBuffer[] srcs,
                  int offset,
                  int length)
           throws IOException
```
    Forwards to delegate.
    
    Specified by:
    
    write in interface GatheringByteChannel
    
    Specified by:
    
    write in class SocketChannel
    
    Throws:
    
    IOException

Class BaseDelegatingSocketChannel<T extends SocketChannel>

Field Summary

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

Field Detail

delegate

socket

socketSyncRoot

Constructor Detail

BaseDelegatingSocketChannel

Method Detail

bind

connect

finishConnect

getLocalAddress

getOption

getRemoteAddress

implCloseSelectableChannel

implConfigureBlocking

implSocket

isConnected

isConnectionPending

read

read

setOption

shutdownInput

shutdownOutput

socket

supportedOptions

write

write