public abstract class AbstractChannel extends DefaultAttributeMap implements Channel
Channel implementation.| Modifier and Type | Class and Description |
|---|---|
protected class |
AbstractChannel.AbstractUnsafe
Unsafe implementation which sub-classes must extend and use. |
Channel.Unsafe| Modifier | Constructor and Description |
|---|---|
protected |
AbstractChannel(Channel parent)
Creates a new instance.
|
| Modifier and Type | Method and Description |
|---|---|
ByteBufAllocator |
alloc()
Return the assigned
ByteBufAllocator which will be used to allocate ByteBufs. |
ChannelFuture |
bind(java.net.SocketAddress localAddress)
Request to bind to the given
SocketAddress and notify the ChannelFuture once the operation
completes, either because the operation was successful or because of an error. |
ChannelFuture |
bind(java.net.SocketAddress localAddress,
ChannelPromise promise)
Request to bind to the given
SocketAddress and notify the ChannelFuture once the operation
completes, either because the operation was successful or because of an error. |
ChannelFuture |
close()
Request to close this
Channel and notify the ChannelFuture once the operation completes,
either because the operation was successful or because of
an error. |
ChannelFuture |
close(ChannelPromise promise)
Request to close this
Channel and notify the ChannelFuture once the operation completes,
either because the operation was successful or because of
an error. |
ChannelFuture |
closeFuture()
Returns the
ChannelFuture which will be notified when this
channel is closed. |
int |
compareTo(Channel o) |
ChannelFuture |
connect(java.net.SocketAddress remoteAddress)
Request to connect to the given
SocketAddress and notify the ChannelFuture once the operation
completes, either because the operation was successful or because of an error. |
ChannelFuture |
connect(java.net.SocketAddress remoteAddress,
ChannelPromise promise)
Request to connect to the given
SocketAddress and notify the ChannelFuture once the operation
completes, either because the operation was successful or because of an error. |
ChannelFuture |
connect(java.net.SocketAddress remoteAddress,
java.net.SocketAddress localAddress)
Request to connect to the given
SocketAddress while bind to the localAddress and notify the
ChannelFuture once the operation completes, either because the operation was successful or because of
an error. |
ChannelFuture |
connect(java.net.SocketAddress remoteAddress,
java.net.SocketAddress localAddress,
ChannelPromise promise)
Request to connect to the given
SocketAddress while bind to the localAddress and notify the
ChannelFuture once the operation completes, either because the operation was successful or because of
an error. |
ChannelFuture |
deregister()
Request to deregister this
Channel from the previous assigned EventExecutor and notify the
ChannelFuture once the operation completes, either because the operation was successful or because of
an error. |
ChannelFuture |
deregister(ChannelPromise promise)
Request to deregister this
Channel from the previous assigned EventExecutor and notify the
ChannelFuture once the operation completes, either because the operation was successful or because of
an error. |
ChannelFuture |
disconnect()
Request to disconnect from the remote peer and notify the
ChannelFuture once the operation completes,
either because the operation was successful or because of an error. |
ChannelFuture |
disconnect(ChannelPromise promise)
Request to disconnect from the remote peer and notify the
ChannelFuture once the operation completes,
either because the operation was successful or because of an error. |
protected abstract void |
doBeginRead()
Schedule a read operation.
|
protected abstract void |
doBind(java.net.SocketAddress localAddress)
Bind the
Channel to the SocketAddress |
protected abstract void |
doClose()
Close the
Channel |
protected void |
doDeregister()
|
protected abstract void |
doDisconnect()
Disconnect this
Channel from its remote peer |
protected void |
doRegister()
|
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(java.lang.Object o)
Returns
true if and only if the specified object is identical
with this channel (i.e: this == o). |
EventLoop |
eventLoop()
|
protected java.lang.Object |
filterOutboundMessage(java.lang.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. |
Channel |
flush()
Request to flush all pending messages.
|
int |
hashCode()
Returns the ID 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()
|
boolean |
isWritable()
Returns
true if and only if the I/O thread will perform the
requested write operation immediately. |
java.net.SocketAddress |
localAddress()
Returns the local address where this channel is bound to.
|
protected abstract java.net.SocketAddress |
localAddress0()
Returns the
SocketAddress which is bound locally. |
protected DefaultChannelPipeline |
newChannelPipeline()
Returns a new
DefaultChannelPipeline instance. |
ChannelFuture |
newFailedFuture(java.lang.Throwable cause)
Create a new
ChannelFuture which is marked as failed already. |
ChannelProgressivePromise |
newProgressivePromise()
Return an new
ChannelProgressivePromise. |
ChannelPromise |
newPromise()
Return a new
ChannelPromise. |
ChannelFuture |
newSucceededFuture()
Create a new
ChannelFuture which is marked as succeeded already. |
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. |
Channel |
read()
Request to Read data from the
Channel into the first inbound buffer, triggers an
ChannelInboundHandler.channelRead(ChannelHandlerContext, Object) event if data was
read, and triggers a
channelReadComplete event so the
handler can decide to continue reading. |
java.net.SocketAddress |
remoteAddress()
Returns the remote address where this channel is connected to.
|
protected abstract java.net.SocketAddress |
remoteAddress0()
Return the
SocketAddress which the Channel is connected to. |
java.lang.String |
toString()
Returns the
String representation of this channel. |
Channel.Unsafe |
unsafe()
Returns an internal-use-only object that provides unsafe operations.
|
ChannelPromise |
voidPromise()
Return a special ChannelPromise which can be reused for different operations.
|
ChannelFuture |
write(java.lang.Object msg)
Request to write a message via this
Channel through the ChannelPipeline. |
ChannelFuture |
write(java.lang.Object msg,
ChannelPromise promise)
Request to write a message via this
Channel through the ChannelPipeline. |
ChannelFuture |
writeAndFlush(java.lang.Object msg)
Shortcut for call
Channel.write(Object) and Channel.flush(). |
ChannelFuture |
writeAndFlush(java.lang.Object msg,
ChannelPromise promise)
Shortcut for call
Channel.write(Object, ChannelPromise) and Channel.flush(). |
attrclone, finalize, getClass, notify, notifyAll, wait, wait, waitattrprotected AbstractChannel(Channel parent)
parent - the parent of this channel. null if there's no parent.protected DefaultChannelPipeline newChannelPipeline()
DefaultChannelPipeline instance.public boolean isWritable()
Channeltrue if and only if the I/O thread will perform the
requested write operation immediately. Any write requests made when
this method returns false are queued until the I/O thread is
ready to process the queued write requests.isWritable in interface Channelpublic Channel parent()
Channelpublic ChannelPipeline pipeline()
ChannelChannelPipeline.public ByteBufAllocator alloc()
ChannelByteBufAllocator which will be used to allocate ByteBufs.public java.net.SocketAddress localAddress()
ChannelSocketAddress is supposed to be down-cast into more concrete
type such as InetSocketAddress to retrieve the detailed
information.localAddress in interface Channelnull if this channel is not bound.@Deprecated protected void invalidateLocalAddress()
public java.net.SocketAddress remoteAddress()
ChannelSocketAddress is supposed to be down-cast into more
concrete type such as InetSocketAddress to retrieve the detailed
information.remoteAddress in interface Channelnull 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.@Deprecated protected void invalidateRemoteAddress()
public boolean isRegistered()
ChannelisRegistered in interface Channelpublic ChannelFuture bind(java.net.SocketAddress localAddress)
ChannelSocketAddress and notify the ChannelFuture once the operation
completes, either because the operation was successful or because of an error.
This will result in having the
ChannelOutboundHandler.bind(ChannelHandlerContext, SocketAddress, ChannelPromise) method
called of the next ChannelOutboundHandler contained in the ChannelPipeline of the
Channel.
public ChannelFuture connect(java.net.SocketAddress remoteAddress)
ChannelSocketAddress and notify the ChannelFuture once the operation
completes, either because the operation was successful or because of an error.
If the connection fails because of a connection timeout, the ChannelFuture will get failed with
a ConnectTimeoutException. If it fails because of connection refused a ConnectException
will be used.
This will result in having the
ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise)
method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the
Channel.
public ChannelFuture connect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)
ChannelSocketAddress while bind to the localAddress and notify the
ChannelFuture once the operation completes, either because the operation was successful or because of
an error.
This will result in having the
ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise)
method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the
Channel.
public ChannelFuture disconnect()
ChannelChannelFuture once the operation completes,
either because the operation was successful or because of an error.
This will result in having the
ChannelOutboundHandler.disconnect(ChannelHandlerContext, ChannelPromise)
method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the
Channel.
disconnect in interface Channelpublic ChannelFuture close()
ChannelChannel and notify the ChannelFuture once the operation completes,
either because the operation was successful or because of
an error.
After it is closed it is not possible to reuse it again.
This will result in having the
ChannelOutboundHandler.close(ChannelHandlerContext, ChannelPromise)
method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the
Channel.
public ChannelFuture deregister()
ChannelChannel from the previous assigned EventExecutor and notify the
ChannelFuture once the operation completes, either because the operation was successful or because of
an error.
This will result in having the
ChannelOutboundHandler.deregister(ChannelHandlerContext, ChannelPromise)
method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the
Channel.
deregister in interface Channelpublic Channel flush()
Channelpublic ChannelFuture bind(java.net.SocketAddress localAddress, ChannelPromise promise)
ChannelSocketAddress and notify the ChannelFuture once the operation
completes, either because the operation was successful or because of an error.
The given ChannelPromise will be notified.
This will result in having the
ChannelOutboundHandler.bind(ChannelHandlerContext, SocketAddress, ChannelPromise) method
called of the next ChannelOutboundHandler contained in the ChannelPipeline of the
Channel.
public ChannelFuture connect(java.net.SocketAddress remoteAddress, ChannelPromise promise)
ChannelSocketAddress and notify the ChannelFuture once the operation
completes, either because the operation was successful or because of an error.
The given ChannelFuture will be notified.
If the connection fails because of a connection timeout, the ChannelFuture will get failed with
a ConnectTimeoutException. If it fails because of connection refused a ConnectException
will be used.
This will result in having the
ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise)
method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the
Channel.
public ChannelFuture connect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress, ChannelPromise promise)
ChannelSocketAddress while bind to the localAddress and notify the
ChannelFuture once the operation completes, either because the operation was successful or because of
an error.
The given ChannelPromise will be notified and also returned.
This will result in having the
ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise)
method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the
Channel.
public ChannelFuture disconnect(ChannelPromise promise)
ChannelChannelFuture once the operation completes,
either because the operation was successful or because of an error.
The given ChannelPromise will be notified.
This will result in having the
ChannelOutboundHandler.disconnect(ChannelHandlerContext, ChannelPromise)
method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the
Channel.
disconnect in interface Channelpublic ChannelFuture close(ChannelPromise promise)
ChannelChannel and notify the ChannelFuture once the operation completes,
either because the operation was successful or because of
an error.
After it is closed it is not possible to reuse it again.
The given ChannelPromise will be notified.
This will result in having the
ChannelOutboundHandler.close(ChannelHandlerContext, ChannelPromise)
method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the
Channel.
public ChannelFuture deregister(ChannelPromise promise)
ChannelChannel from the previous assigned EventExecutor and notify the
ChannelFuture once the operation completes, either because the operation was successful or because of
an error.
The given ChannelPromise will be notified.
This will result in having the
ChannelOutboundHandler.deregister(ChannelHandlerContext, ChannelPromise)
method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the
Channel.
deregister in interface Channelpublic Channel read()
ChannelChannel into the first inbound buffer, triggers an
ChannelInboundHandler.channelRead(ChannelHandlerContext, Object) event if data was
read, and triggers a
channelReadComplete event so the
handler can decide to continue reading. If there's a pending read operation already, this method does nothing.
This will result in having the
ChannelOutboundHandler.read(ChannelHandlerContext)
method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the
Channel.
public ChannelFuture write(java.lang.Object msg)
ChannelChannel through the ChannelPipeline.
This method will not request to actual flush, so be sure to call Channel.flush()
once you want to request to flush all pending data to the actual transport.public ChannelFuture write(java.lang.Object msg, ChannelPromise promise)
ChannelChannel through the ChannelPipeline.
This method will not request to actual flush, so be sure to call Channel.flush()
once you want to request to flush all pending data to the actual transport.public ChannelFuture writeAndFlush(java.lang.Object msg)
ChannelChannel.write(Object) and Channel.flush().writeAndFlush in interface Channelpublic ChannelFuture writeAndFlush(java.lang.Object msg, ChannelPromise promise)
ChannelChannel.write(Object, ChannelPromise) and Channel.flush().writeAndFlush in interface Channelpublic ChannelPromise newPromise()
ChannelChannelPromise.newPromise in interface Channelpublic ChannelProgressivePromise newProgressivePromise()
ChannelChannelProgressivePromise.newProgressivePromise in interface Channelpublic ChannelFuture newSucceededFuture()
ChannelChannelFuture which is marked as succeeded already. So Future.isSuccess()
will return true. All FutureListener added to it will be notified directly. Also
every call of blocking methods will just return without blocking.newSucceededFuture in interface Channelpublic ChannelFuture newFailedFuture(java.lang.Throwable cause)
ChannelChannelFuture which is marked as failed already. So Future.isSuccess()
will return false. All FutureListener added to it will be notified directly. Also
every call of blocking methods will just return without blocking.newFailedFuture in interface Channelpublic ChannelFuture closeFuture()
ChannelChannelFuture which will be notified when this
channel is closed. This method always returns the same future instance.closeFuture in interface Channelpublic Channel.Unsafe unsafe()
Channelprotected abstract AbstractChannel.AbstractUnsafe newUnsafe()
AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channelpublic final int hashCode()
hashCode in class java.lang.Objectpublic final boolean equals(java.lang.Object o)
true if and only if the specified object is identical
with this channel (i.e: this == o).equals in class java.lang.Objectpublic final int compareTo(Channel o)
compareTo in interface java.lang.Comparable<Channel>public java.lang.String toString()
String representation of this channel. The returned
string contains the ID, local address,
and remote address of this channel for
easier identification.toString in class java.lang.Objectpublic final ChannelPromise voidPromise()
Channel
It's only supported to use
it for Channel.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.
voidPromise in interface Channelprotected abstract boolean isCompatible(EventLoop loop)
true if the given EventLoop is compatible with this instance.protected abstract java.net.SocketAddress localAddress0()
SocketAddress which is bound locally.protected abstract java.net.SocketAddress remoteAddress0()
SocketAddress which the Channel is connected to.protected void doRegister()
throws java.lang.Exception
Channel is registered with its EventLoop as part of the register process.
Sub-classes may override this methodjava.lang.Exceptionprotected abstract void doBind(java.net.SocketAddress localAddress)
throws java.lang.Exception
Channel to the SocketAddressjava.lang.Exceptionprotected abstract void doDisconnect()
throws java.lang.Exception
Channel from its remote peerjava.lang.Exceptionprotected abstract void doClose()
throws java.lang.Exception
Channeljava.lang.Exception@UnstableApi
protected void doShutdownOutput()
throws java.lang.Exception
java.lang.Exceptionprotected void doDeregister()
throws java.lang.Exception
java.lang.Exceptionprotected abstract void doBeginRead()
throws java.lang.Exception
java.lang.Exceptionprotected abstract void doWrite(ChannelOutboundBuffer in) throws java.lang.Exception
java.lang.Exceptionprotected java.lang.Object filterOutboundMessage(java.lang.Object msg)
throws java.lang.Exception
ChannelOutboundBuffer of this AbstractChannel, so that
the Channel implementation converts the message to another. (e.g. heap buffer -> direct buffer)java.lang.ExceptionCopyright © 2008–2018 The Netty Project. All rights reserved.