AbstractChannel (Netty/Transport 4.2.0.RC2 API)

java.lang.Object
- io.netty.util.DefaultAttributeMap
- - io.netty.channel.AbstractChannel

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, io.netty.util.AttributeMap, Comparable<Channel>

Direct Known Subclasses:

AbstractNioChannel, AbstractOioChannel, AbstractServerChannel, EmbeddedChannel, LocalChannel
```
public abstract class AbstractChannel
extends io.netty.util.DefaultAttributeMap
implements Channel
```
A skeletal Channel implementation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class AbstractChannel.AbstractUnsafe
Unsafe implementation which sub-classes must extend and use.
- Nested classes/interfaces inherited from interface io.netty.channel.Channel
  Channel.Unsafe

Nested Classes
Modifier and Type	Class and Description
`protected class`	`AbstractChannel.AbstractUnsafe` `Unsafe` implementation which sub-classes must extend and use.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractChannel(Channel parent)` Creates a new instance.
`protected`	`AbstractChannel(Channel parent, ChannelId id)` Creates a new instance.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ChannelFuture`	`closeFuture()` Returns the `ChannelFuture` which will be notified when this channel is closed.
`int`	`compareTo(Channel o)`
`protected abstract void`	`doBeginRead()` Schedule a read operation.
`protected abstract void`	`doBind(SocketAddress localAddress)` Bind the `Channel` to the `SocketAddress`
`protected abstract void`	`doClose()` Close the `Channel`
`protected void`	`doDeregister()` Deregister the `Channel` from its `EventLoop`.
`protected abstract void`	`doDisconnect()` Disconnect this `Channel` from its remote peer
`protected void`	`doRegister()` Deprecated. use `doRegister(ChannelPromise)`
`protected void`	`doRegister(ChannelPromise promise)` Is called after the `Channel` is registered with its `EventLoop` as part of the register process.
`protected void`	`doShutdownOutput()` Called when conditions justify shutting down the output portion of the channel.
`protected abstract void`	`doWrite(ChannelOutboundBuffer in)` Flush the content of the given buffer to the remote peer.
`boolean`	`equals(Object o)` Returns `true` if and only if the specified object is identical with this channel (i.e: `this == o`).
`EventLoop`	`eventLoop()` Return the `EventLoop` this `Channel` was registered to.
`protected Object`	`filterOutboundMessage(Object msg)` Invoked when a new message is added to a `ChannelOutboundBuffer` of this `AbstractChannel`, so that the `Channel` implementation converts the message to another.
`int`	`hashCode()` Returns the ID of this channel.
`ChannelId`	`id()` Returns the globally unique identifier of this `Channel`.
`protected void`	`invalidateLocalAddress()` Deprecated. no use-case for this.
`protected void`	`invalidateRemoteAddress()` Deprecated. no use-case for this.
`protected abstract boolean`	`isCompatible(EventLoop loop)` Return `true` if the given `EventLoop` is compatible with this instance.
`boolean`	`isRegistered()` Returns `true` if the `Channel` is registered with an `EventLoop`.
`SocketAddress`	`localAddress()` Returns the local address where this channel is bound to.
`protected abstract SocketAddress`	`localAddress0()` Returns the `SocketAddress` which is bound locally.
`protected int`	`maxMessagesPerWrite()`
`protected DefaultChannelPipeline`	`newChannelPipeline()` Returns a new `DefaultChannelPipeline` instance.
`protected ChannelId`	`newId()` Returns a new `DefaultChannelId` instance.
`protected abstract AbstractChannel.AbstractUnsafe`	`newUnsafe()` Create a new `AbstractChannel.AbstractUnsafe` instance which will be used for the life-time of the `Channel`
`Channel`	`parent()` Returns the parent of this channel.
`ChannelPipeline`	`pipeline()` Return the assigned `ChannelPipeline`.
`SocketAddress`	`remoteAddress()` Returns the remote address where this channel is connected to.
`protected abstract SocketAddress`	`remoteAddress0()` Return the `SocketAddress` which the `Channel` is connected to.
`String`	`toString()` Returns the `String` representation of this channel.
`Channel.Unsafe`	`unsafe()` Returns an internal-use-only object that provides unsafe operations.
`protected void`	`validateFileRegion(DefaultFileRegion region, long position)`
`ChannelPromise`	`voidPromise()` Return a special ChannelPromise which can be reused for different operations.

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, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, config, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, flush, getOption, isActive, isOpen, isWritable, metadata, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, read, setOption, write, write, writeAndFlush, writeAndFlush

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

- Constructor Detail
  - AbstractChannel
```
protected AbstractChannel(Channel parent)
```
    Creates a new instance.
    
    Parameters:
    
    parent - the parent of this channel. null if there's no parent.
  - AbstractChannel
```
protected AbstractChannel(Channel parent,
                          ChannelId id)
```
    Creates a new instance.
    
    Parameters:
    
    parent - the parent of this channel. null if there's no parent.
- Method Detail
  - maxMessagesPerWrite
```
protected final int maxMessagesPerWrite()
```
  - id
```
public final ChannelId id()
```
    Description copied from interface: Channel
    
    Returns the globally unique identifier of this Channel.
    
    Specified by:
    
    id in interface Channel
  - newId
```
protected ChannelId newId()
```
    Returns a new DefaultChannelId instance. Subclasses may override this method to assign custom ChannelIds to Channels that use the AbstractChannel(Channel) constructor.
  - newChannelPipeline
```
protected DefaultChannelPipeline newChannelPipeline()
```
    Returns a new DefaultChannelPipeline instance.
  - parent
```
public Channel parent()
```
    Description copied from interface: Channel
    
    Returns the parent of this channel.
    
    Specified by:
    
    parent in interface Channel
    
    Returns:
    
    the parent channel. null if this channel does not have a parent channel.
  - pipeline
```
public ChannelPipeline pipeline()
```
    Description copied from interface: Channel
    
    Return the assigned ChannelPipeline.
    
    Specified by:
    
    pipeline in interface Channel
  - eventLoop
```
public EventLoop eventLoop()
```
    Description copied from interface: Channel
    
    Return the EventLoop this Channel was registered to.
    
    Specified by:
    
    eventLoop in interface Channel
  - localAddress
```
public SocketAddress localAddress()
```
    Description copied from interface: Channel
    
    Returns the local address where this channel is bound to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.
    
    Specified by:
    
    localAddress in interface Channel
    
    Returns:
    
    the local address of this channel. null if this channel is not bound.
  - invalidateLocalAddress
```
@Deprecated
protected void invalidateLocalAddress()
```
    Deprecated. no use-case for this.
  - remoteAddress
```
public SocketAddress remoteAddress()
```
    Description copied from interface: Channel
    
    Returns the remote address where this channel is connected to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.
    
    Specified by:
    
    remoteAddress in interface Channel
    
    Returns:
    
    the remote address of this channel. null if this channel is not connected. If this channel is not connected but it can receive messages from arbitrary remote addresses (e.g. DatagramChannel, use DefaultAddressedEnvelope.recipient() to determine the origination of the received message as this method will return null.
  - invalidateRemoteAddress
```
@Deprecated
protected void invalidateRemoteAddress()
```
    Deprecated. no use-case for this.
  - isRegistered
```
public boolean isRegistered()
```
    Description copied from interface: Channel
    
    Returns true if the Channel is registered with an EventLoop.
    
    Specified by:
    
    isRegistered in interface Channel
  - closeFuture
```
public ChannelFuture closeFuture()
```
    Description copied from interface: Channel
    
    Returns the ChannelFuture which will be notified when this channel is closed. This method always returns the same future instance.
    
    Specified by:
    
    closeFuture in interface Channel
  - unsafe
```
public Channel.Unsafe unsafe()
```
    Description copied from interface: Channel
    
    Returns an internal-use-only object that provides unsafe operations.
    
    Specified by:
    
    unsafe in interface Channel
  - newUnsafe
```
protected abstract AbstractChannel.AbstractUnsafe newUnsafe()
```
    Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel
  - hashCode
```
public final int hashCode()
```
    Returns the ID of this channel.
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object o)
```
    Returns true if and only if the specified object is identical with this channel (i.e: this == o).
    
    Overrides:
    
    equals in class Object
  - compareTo
```
public final int compareTo(Channel o)
```
    Specified by:
    
    compareTo in interface Comparable<Channel>
  - toString
```
public String toString()
```
    Returns the String representation of this channel. The returned string contains the ID, local address, and remote address of this channel for easier identification.
    
    Overrides:
    
    toString in class Object
  - voidPromise
```
public final ChannelPromise voidPromise()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Return a special ChannelPromise which can be reused for different operations.
    It's only supported to use it for ChannelOutboundInvoker.write(Object, ChannelPromise).
    
    Be aware that the returned ChannelPromise will not support most operations and should only be used if you want to save an object allocation for every write operation. You will not be able to detect if the operation was complete, only if it failed as the implementation will call ChannelPipeline.fireExceptionCaught(Throwable) in this case.
    Be aware this is an expert feature and should be used with care!
    
    Specified by:
    
    voidPromise in interface Channel
    
    Specified by:
    
    voidPromise in interface ChannelOutboundInvoker
  - isCompatible
```
protected abstract boolean isCompatible(EventLoop loop)
```
    Return true if the given EventLoop is compatible with this instance.
  - localAddress0
```
protected abstract SocketAddress localAddress0()
```
    Returns the SocketAddress which is bound locally.
  - remoteAddress0
```
protected abstract SocketAddress remoteAddress0()
```
    Return the SocketAddress which the Channel is connected to.
  - doRegister
```
@Deprecated
protected void doRegister()
                               throws Exception
```
    Deprecated. use doRegister(ChannelPromise)
    
    Is called after the Channel is registered with its EventLoop as part of the register process. Subclasses may override this method
    
    Throws:
    
    Exception
  - doRegister
```
protected void doRegister(ChannelPromise promise)
```
    Is called after the Channel is registered with its EventLoop as part of the register process. Subclasses may override this method
    
    Parameters:
    
    promise - ChannelPromise that must be notified once done to continue the registration.
  - doBind
```
protected abstract void doBind(SocketAddress localAddress)
                        throws Exception
```
    Bind the Channel to the SocketAddress
    
    Throws:
    
    Exception
  - doDisconnect
```
protected abstract void doDisconnect()
                              throws Exception
```
    Disconnect this Channel from its remote peer
    
    Throws:
    
    Exception
  - doClose
```
protected abstract void doClose()
                         throws Exception
```
    Close the Channel
    
    Throws:
    
    Exception
  - doShutdownOutput
```
protected void doShutdownOutput()
                         throws Exception
```
    Called when conditions justify shutting down the output portion of the channel. This may happen if a write operation throws an exception.
    
    Throws:
    
    Exception
  - doDeregister
```
protected void doDeregister()
                     throws Exception
```
    Deregister the Channel from its EventLoop. Sub-classes may override this method
    
    Throws:
    
    Exception
  - doBeginRead
```
protected abstract void doBeginRead()
                             throws Exception
```
    Schedule a read operation.
    
    Throws:
    
    Exception
  - doWrite
```
protected abstract void doWrite(ChannelOutboundBuffer in)
                         throws Exception
```
    Flush the content of the given buffer to the remote peer.
    
    Throws:
    
    Exception
  - filterOutboundMessage
```
protected Object filterOutboundMessage(Object msg)
                                throws Exception
```
    Invoked when a new message is added to a ChannelOutboundBuffer of this AbstractChannel, so that the Channel implementation converts the message to another. (e.g. heap buffer -> direct buffer)
    
    Throws:
    
    Exception
  - validateFileRegion
```
protected void validateFileRegion(DefaultFileRegion region,
                                  long position)
                           throws IOException
```
    Throws:
    
    IOException

Class AbstractChannel

Nested Class Summary

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

Constructor Summary

Method Summary

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

Constructor Detail

AbstractChannel

AbstractChannel

Method Detail

maxMessagesPerWrite

id

newId

newChannelPipeline

parent

pipeline

eventLoop

localAddress

invalidateLocalAddress

remoteAddress

invalidateRemoteAddress

isRegistered

closeFuture

unsafe

newUnsafe

hashCode

equals

compareTo

toString

voidPromise

isCompatible

localAddress0

remoteAddress0

doRegister

doRegister

doBind

doDisconnect

doClose

doShutdownOutput

doDeregister

doBeginRead

doWrite

filterOutboundMessage

validateFileRegion