WrappingXnioSocketChannel (netty-xnio-transport 0.1.9.Final API)

java.lang.Object
- io.netty.util.DefaultAttributeMap
- - io.netty.channel.AbstractChannel
  - - org.xnio.netty.transport.WrappingXnioSocketChannel

All Implemented Interfaces:

io.netty.channel.Channel, io.netty.channel.ChannelOutboundInvoker, io.netty.channel.socket.DuplexChannel, io.netty.channel.socket.SocketChannel, io.netty.util.AttributeMap, Comparable<io.netty.channel.Channel>
```
public final class WrappingXnioSocketChannel
extends io.netty.channel.AbstractChannel
```
AbstractXnioSocketChannel implementation which allows you to wrap a pre-created XNIO channel.

Author:

Norman Maurer, Flavia Rainone

Nested Class Summary
- Nested classes/interfaces inherited from class io.netty.channel.AbstractChannel
  io.netty.channel.AbstractChannel.AbstractUnsafe
- Nested classes/interfaces inherited from interface io.netty.channel.Channel
  io.netty.channel.Channel.Unsafe

Constructor Summary

Constructors
Constructor and Description
`WrappingXnioSocketChannel(org.xnio.channels.AcceptingChannel<org.xnio.StreamConnection> parent, org.xnio.StreamConnection channel)` Create a new `WrappingXnioSocketChannel` which was created via the given `AcceptingChannel` and uses the given `StreamConnection` under the covers.
`WrappingXnioSocketChannel(org.xnio.StreamConnection channel)` Create a `WrappingXnioSocketChannel` which uses the given `StreamConnection` under the covers.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`io.netty.channel.socket.SocketChannelConfig`	`config()`
`protected org.xnio.StreamConnection`	`connection()` Returns the underlying `StreamConnection` or `null` if not created yet.
`protected void`	`doBeginRead()`
`protected void`	`doBind(SocketAddress localAddress)`
`protected void`	`doClose()`
`protected void`	`doDisconnect()`
`protected void`	`doWrite(io.netty.channel.ChannelOutboundBuffer in)`
`protected <T> T`	`getOption0(org.xnio.Option<T> option)` Return the value for the given `Option`.
`org.xnio.XnioIoThread`	`ioThread()`
`boolean`	`isActive()`
`protected boolean`	`isCompatible(io.netty.channel.EventLoop loop)`
`boolean`	`isInputShutdown()`
`boolean`	`isOpen()`
`boolean`	`isOutputShutdown()`
`boolean`	`isShutdown()`
`InetSocketAddress`	`localAddress()`
`protected SocketAddress`	`localAddress0()`
`io.netty.channel.ChannelMetadata`	`metadata()`
`protected org.xnio.netty.transport.WrappingXnioSocketChannel.XnioUnsafe`	`newUnsafe()`
`io.netty.channel.socket.ServerSocketChannel`	`parent()`
`InetSocketAddress`	`remoteAddress()`
`protected SocketAddress`	`remoteAddress0()`
`protected <T> void`	`setOption0(org.xnio.Option<T> option, T value)` Set the given `Option` to the given value.
`io.netty.channel.ChannelFuture`	`shutdown()`
`io.netty.channel.ChannelFuture`	`shutdown(io.netty.channel.ChannelPromise channelPromise)`
`io.netty.channel.ChannelFuture`	`shutdownInput()`
`io.netty.channel.ChannelFuture`	`shutdownInput(io.netty.channel.ChannelPromise channelPromise)`
`io.netty.channel.ChannelFuture`	`shutdownOutput()`
`io.netty.channel.ChannelFuture`	`shutdownOutput(io.netty.channel.ChannelPromise future)`

Methods inherited from class io.netty.channel.AbstractChannel
alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doDeregister, doRegister, equals, eventLoop, filterOutboundMessage, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, pipeline, read, toString, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from class io.netty.util.DefaultAttributeMap
attr, hasAttr

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

Methods inherited from interface io.netty.channel.Channel
alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, flush, id, isRegistered, isWritable, pipeline, read, unsafe

Methods inherited from interface io.netty.util.AttributeMap
attr, hasAttr

Methods inherited from interface io.netty.channel.ChannelOutboundInvoker
bind, bind, close, close, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface java.lang.Comparable
compareTo

- Constructor Detail
  - WrappingXnioSocketChannel
```
public WrappingXnioSocketChannel(org.xnio.channels.AcceptingChannel<org.xnio.StreamConnection> parent,
                                 org.xnio.StreamConnection channel)
```
    Create a new WrappingXnioSocketChannel which was created via the given AcceptingChannel and uses the given StreamConnection under the covers.
  - WrappingXnioSocketChannel
```
public WrappingXnioSocketChannel(org.xnio.StreamConnection channel)
```
    Create a WrappingXnioSocketChannel which uses the given StreamConnection under the covers.
- Method Detail
  - ioThread
```
public org.xnio.XnioIoThread ioThread()
```
  - newUnsafe
```
protected org.xnio.netty.transport.WrappingXnioSocketChannel.XnioUnsafe newUnsafe()
```
  - doBind
```
protected void doBind(SocketAddress localAddress)
               throws Exception
```
    Specified by:
    
    doBind in class io.netty.channel.AbstractChannel
    
    Throws:
    
    Exception
  - setOption0
```
protected <T> void setOption0(org.xnio.Option<T> option,
                              T value)
                       throws IOException
```
    Set the given Option to the given value.
    
    Throws:
    
    IOException
  - getOption0
```
protected <T> T getOption0(org.xnio.Option<T> option)
                    throws IOException
```
    Return the value for the given Option.
    
    Throws:
    
    IOException
  - connection
```
protected org.xnio.StreamConnection connection()
```
    Returns the underlying StreamConnection or null if not created yet.
  - shutdownInput
```
public io.netty.channel.ChannelFuture shutdownInput()
```
    Specified by:
    
    shutdownInput in interface io.netty.channel.socket.DuplexChannel
  - shutdownInput
```
public io.netty.channel.ChannelFuture shutdownInput(io.netty.channel.ChannelPromise channelPromise)
```
    Specified by:
    
    shutdownInput in interface io.netty.channel.socket.DuplexChannel
  - parent
```
public io.netty.channel.socket.ServerSocketChannel parent()
```
    Specified by:
    
    parent in interface io.netty.channel.Channel
    
    Specified by:
    
    parent in interface io.netty.channel.socket.SocketChannel
    
    Overrides:
    
    parent in class io.netty.channel.AbstractChannel
  - remoteAddress
```
public InetSocketAddress remoteAddress()
```
    Specified by:
    
    remoteAddress in interface io.netty.channel.Channel
    
    Specified by:
    
    remoteAddress in interface io.netty.channel.socket.SocketChannel
    
    Overrides:
    
    remoteAddress in class io.netty.channel.AbstractChannel
  - localAddress
```
public InetSocketAddress localAddress()
```
    Specified by:
    
    localAddress in interface io.netty.channel.Channel
    
    Specified by:
    
    localAddress in interface io.netty.channel.socket.SocketChannel
    
    Overrides:
    
    localAddress in class io.netty.channel.AbstractChannel
  - isCompatible
```
protected boolean isCompatible(io.netty.channel.EventLoop loop)
```
    Specified by:
    
    isCompatible in class io.netty.channel.AbstractChannel
  - doDisconnect
```
protected void doDisconnect()
                     throws Exception
```
    Specified by:
    
    doDisconnect in class io.netty.channel.AbstractChannel
    
    Throws:
    
    Exception
  - doWrite
```
protected void doWrite(io.netty.channel.ChannelOutboundBuffer in)
                throws Exception
```
    Specified by:
    
    doWrite in class io.netty.channel.AbstractChannel
    
    Throws:
    
    Exception
  - config
```
public io.netty.channel.socket.SocketChannelConfig config()
```
    Specified by:
    
    config in interface io.netty.channel.Channel
    
    Specified by:
    
    config in interface io.netty.channel.socket.SocketChannel
  - shutdownOutput
```
public io.netty.channel.ChannelFuture shutdownOutput()
```
    Specified by:
    
    shutdownOutput in interface io.netty.channel.socket.DuplexChannel
  - shutdownOutput
```
public io.netty.channel.ChannelFuture shutdownOutput(io.netty.channel.ChannelPromise future)
```
    Specified by:
    
    shutdownOutput in interface io.netty.channel.socket.DuplexChannel
  - isOpen
```
public boolean isOpen()
```
    Specified by:
    
    isOpen in interface io.netty.channel.Channel
  - isActive
```
public boolean isActive()
```
    Specified by:
    
    isActive in interface io.netty.channel.Channel
  - metadata
```
public io.netty.channel.ChannelMetadata metadata()
```
    Specified by:
    
    metadata in interface io.netty.channel.Channel
  - localAddress0
```
protected SocketAddress localAddress0()
```
    Specified by:
    
    localAddress0 in class io.netty.channel.AbstractChannel
  - remoteAddress0
```
protected SocketAddress remoteAddress0()
```
    Specified by:
    
    remoteAddress0 in class io.netty.channel.AbstractChannel
  - isInputShutdown
```
public boolean isInputShutdown()
```
    Specified by:
    
    isInputShutdown in interface io.netty.channel.socket.DuplexChannel
  - isOutputShutdown
```
public boolean isOutputShutdown()
```
    Specified by:
    
    isOutputShutdown in interface io.netty.channel.socket.DuplexChannel
  - doBeginRead
```
protected void doBeginRead()
                    throws Exception
```
    Specified by:
    
    doBeginRead in class io.netty.channel.AbstractChannel
    
    Throws:
    
    Exception
  - doClose
```
protected void doClose()
                throws Exception
```
    Specified by:
    
    doClose in class io.netty.channel.AbstractChannel
    
    Throws:
    
    Exception
  - isShutdown
```
public boolean isShutdown()
```
    Specified by:
    
    isShutdown in interface io.netty.channel.socket.DuplexChannel
  - shutdown
```
public io.netty.channel.ChannelFuture shutdown()
```
    Specified by:
    
    shutdown in interface io.netty.channel.socket.DuplexChannel
  - shutdown
```
public io.netty.channel.ChannelFuture shutdown(io.netty.channel.ChannelPromise channelPromise)
```
    Specified by:
    
    shutdown in interface io.netty.channel.socket.DuplexChannel

Class WrappingXnioSocketChannel

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.channel.AbstractChannel

Nested classes/interfaces inherited from interface io.netty.channel.Channel

Constructor Summary

Method Summary

Methods inherited from class io.netty.channel.AbstractChannel

Methods inherited from class io.netty.util.DefaultAttributeMap

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.Channel

Methods inherited from interface io.netty.util.AttributeMap

Methods inherited from interface io.netty.channel.ChannelOutboundInvoker

Methods inherited from interface java.lang.Comparable

Constructor Detail

WrappingXnioSocketChannel

WrappingXnioSocketChannel

Method Detail

ioThread

newUnsafe

doBind

setOption0

getOption0

connection

shutdownInput

shutdownInput

parent

remoteAddress

localAddress

isCompatible

doDisconnect

doWrite

config

shutdownOutput

shutdownOutput

isOpen

isActive

metadata

localAddress0

remoteAddress0

isInputShutdown

isOutputShutdown

doBeginRead

doClose

isShutdown

shutdown

shutdown