io.netty.channel

Class AbstractChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractEmbeddedChannel, AbstractNioChannel, AbstractServerChannel, AioServerSocketChannel, AioSocketChannel, LocalChannel, OioDatagramChannel, OioSctpChannel, OioSctpServerChannel, OioServerSocketChannel, OioSocketChannel

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

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

Channel.Unsafe

Field Summary

Fields

Modifier and Type	Field and Description
protected ChannelFlushFutureNotifier	flushFutureNotifier

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
ChannelFuture	bind(SocketAddress localAddress)
ChannelFuture	bind(SocketAddress localAddress, ChannelFuture future)
ChannelFuture	close()
ChannelFuture	close(ChannelFuture future)
ChannelFuture	closeFuture() Returns the ChannelFuture which will be notified when this channel is closed.
int	compareTo(Channel o) Compares the ID of the two channels.
ChannelFuture	connect(SocketAddress remoteAddress)
ChannelFuture	connect(SocketAddress remoteAddress, ChannelFuture future)
ChannelFuture	connect(SocketAddress remoteAddress, SocketAddress localAddress)
ChannelFuture	connect(SocketAddress remoteAddress, SocketAddress localAddress, ChannelFuture future)
ChannelFuture	deregister()
ChannelFuture	deregister(ChannelFuture future)
ChannelFuture	disconnect()
ChannelFuture	disconnect(ChannelFuture future)
protected abstract void	doBind(SocketAddress localAddress)
protected abstract void	doClose()
protected abstract void	doDeregister()
protected abstract void	doDisconnect()
protected void	doFlushByteBuffer(io.netty.buffer.ByteBuf buf)
protected void	doFlushMessageBuffer(io.netty.buffer.MessageBuf<Object> buf)
protected void	doPreClose()
protected abstract Runnable	doRegister()
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 too.
ChannelFuture	flush()
ChannelFuture	flush(ChannelFuture future)
int	hashCode() Returns the ID of this channel.
Integer	id() Returns the unique integer ID of this channel.
protected void	invalidateLocalAddress()
protected void	invalidateRemoteAddress()
protected abstract boolean	isCompatible(EventLoop loop)
protected abstract boolean	isFlushPending()
boolean	isRegistered()
SocketAddress	localAddress() Returns the local address where this channel is bound to.
protected abstract SocketAddress	localAddress0()
ChannelFuture	newFailedFuture(Throwable cause) Create a new ChannelFuture which is marked as fakued already.
ChannelFuture	newFuture() Create a new ChannelFuture
ChannelFuture	newSucceededFuture() Create a new ChannelFuture which is marked as successes already.
protected abstract Channel.Unsafe	newUnsafe()
io.netty.buffer.ByteBuf	outboundByteBuffer()
io.netty.buffer.MessageBuf<Object>	outboundMessageBuffer()
Channel	parent() Returns the parent of this channel.
ChannelPipeline	pipeline() Returns the ChannelPipeline which handles ChannelEvents associated with this channel.
SocketAddress	remoteAddress() Returns the remote address where this channel is connected to.
protected abstract SocketAddress	remoteAddress0()
String	toString() Returns the String representation of this channel.
Channel.Unsafe	unsafe() Caution for transport implementations use only!
ChannelFuture	write(Object message)
ChannelFuture	write(Object message, ChannelFuture future)

Methods inherited from class io.netty.util.DefaultAttributeMap

attr

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.netty.channel.Channel

config, isActive, isOpen, metadata

Methods inherited from interface io.netty.util.AttributeMap

attr

Field Detail

flushFutureNotifier

protected final ChannelFlushFutureNotifier flushFutureNotifier

Constructor Detail

AbstractChannel

protected AbstractChannel(Channel parent,
               Integer id)

Creates a new instance.

Parameters:

id - the unique non-negative integer ID of this channel. Specify null to auto-generate a unique negative integer ID.

parent - the parent of this channel. null if there's no parent.

Method Detail

id

public final Integer id()

Description copied from interface: Channel

Returns the unique integer ID of this channel.

Specified by:

id in interface Channel

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

Returns the ChannelPipeline which handles ChannelEvents associated with this channel.

Specified by:

pipeline in interface Channel

eventLoop

public EventLoop eventLoop()

Description copied from interface: Channel

Return the EventLoop this Channel was registered too.

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

protected void invalidateLocalAddress()

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 MessageEvent#getRemoteAddress() to determine the origination of the received message as this method will return null.

invalidateRemoteAddress

protected void invalidateRemoteAddress()

isRegistered

public boolean isRegistered()

Specified by:

isRegistered in interface Channel

bind

public ChannelFuture bind(SocketAddress localAddress)

Specified by:

bind in interface ChannelOutboundInvoker

connect

public ChannelFuture connect(SocketAddress remoteAddress)

Specified by:

connect in interface ChannelOutboundInvoker

connect

public ChannelFuture connect(SocketAddress remoteAddress,
                    SocketAddress localAddress)

Specified by:

connect in interface ChannelOutboundInvoker

disconnect

public ChannelFuture disconnect()

Specified by:

disconnect in interface ChannelOutboundInvoker

close

public ChannelFuture close()

Specified by:

close in interface ChannelOutboundInvoker

deregister

public ChannelFuture deregister()

Specified by:

deregister in interface ChannelOutboundInvoker

flush

public ChannelFuture flush()

Specified by:

flush in interface ChannelOutboundInvoker

write

public ChannelFuture write(Object message)

Specified by:

write in interface ChannelOutboundInvoker

bind

public ChannelFuture bind(SocketAddress localAddress,
                 ChannelFuture future)

Specified by:

bind in interface ChannelOutboundInvoker

connect

public ChannelFuture connect(SocketAddress remoteAddress,
                    ChannelFuture future)

Specified by:

connect in interface ChannelOutboundInvoker

connect

public ChannelFuture connect(SocketAddress remoteAddress,
                    SocketAddress localAddress,
                    ChannelFuture future)

Specified by:

connect in interface ChannelOutboundInvoker

disconnect

public ChannelFuture disconnect(ChannelFuture future)

Specified by:

disconnect in interface ChannelOutboundInvoker

close

public ChannelFuture close(ChannelFuture future)

Specified by:

close in interface ChannelOutboundInvoker

deregister

public ChannelFuture deregister(ChannelFuture future)

Specified by:

deregister in interface ChannelOutboundInvoker

outboundByteBuffer

public io.netty.buffer.ByteBuf outboundByteBuffer()

Specified by:

outboundByteBuffer in interface Channel

outboundMessageBuffer

public io.netty.buffer.MessageBuf<Object> outboundMessageBuffer()

Specified by:

outboundMessageBuffer in interface Channel

flush

public ChannelFuture flush(ChannelFuture future)

Specified by:

flush in interface ChannelOutboundInvoker

write

public ChannelFuture write(Object message,
                  ChannelFuture future)

Specified by:

write in interface ChannelOutboundInvoker

newFuture

public ChannelFuture newFuture()

Description copied from interface: ChannelFutureFactory

Create a new ChannelFuture

Specified by:

newFuture in interface ChannelFutureFactory

newSucceededFuture

public ChannelFuture newSucceededFuture()

Description copied from interface: ChannelFutureFactory

Create a new ChannelFuture which is marked as successes already. So ChannelFuture.isSuccess() will return true. All ChannelFutureListener added to it will be notified directly. Also every call of blocking methods will just return without blocking.

Specified by:

newSucceededFuture in interface ChannelFutureFactory

newFailedFuture

public ChannelFuture newFailedFuture(Throwable cause)

Description copied from interface: ChannelFutureFactory

Create a new ChannelFuture which is marked as fakued already. So ChannelFuture.isSuccess() will return false. All ChannelFutureListener added to it will be notified directly. Also every call of blocking methods will just return without blocking.

Specified by:

newFailedFuture in interface ChannelFutureFactory

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

Caution for transport implementations use only!

Specified by:

unsafe in interface Channel

newUnsafe

protected abstract Channel.Unsafe newUnsafe()

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)

Compares the ID of the two channels.

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

isCompatible

protected abstract boolean isCompatible(EventLoop loop)

localAddress0

protected abstract SocketAddress localAddress0()

remoteAddress0

protected abstract SocketAddress remoteAddress0()

doRegister

protected abstract Runnable doRegister()
                                throws Exception

Throws:

Exception

doBind

protected abstract void doBind(SocketAddress localAddress)
                        throws Exception

Throws:

Exception

doDisconnect

protected abstract void doDisconnect()
                              throws Exception

Throws:

Exception

doPreClose

protected void doPreClose()
                   throws Exception

Throws:

Exception

doClose

protected abstract void doClose()
                         throws Exception

Throws:

Exception

doDeregister

protected abstract void doDeregister()
                              throws Exception

Throws:

Exception

doFlushByteBuffer

protected void doFlushByteBuffer(io.netty.buffer.ByteBuf buf)
                          throws Exception

Throws:

Exception

doFlushMessageBuffer

protected void doFlushMessageBuffer(io.netty.buffer.MessageBuf<Object> buf)
                             throws Exception

Throws:

Exception

isFlushPending

protected abstract boolean isFlushPending()