io.netty.channel

类 AbstractChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

所有已实现的接口:

Channel, AttributeMap, java.lang.Comparable<Channel>

直接已知子类:

AbstractEpollServerChannel, AbstractEpollStreamChannel, AbstractNioChannel, AbstractOioChannel, AbstractServerChannel, EmbeddedChannel, EpollDatagramChannel, LocalChannel

public abstract class AbstractChannel
extends DefaultAttributeMap
implements Channel

A skeletal Channel implementation.

嵌套类概要

嵌套类

限定符和类型	类和说明
protected class	AbstractChannel.AbstractUnsafe Unsafe implementation which sub-classes must extend and use.

从接口继承的嵌套类/接口 io.netty.channel.Channel

Channel.Unsafe

构造器概要

构造器

限定符	构造器和说明
protected	AbstractChannel(Channel parent) Creates a new instance.

方法概要

方法

限定符和类型	方法和说明
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() Deregister the Channel from its EventLoop.
protected abstract void	doDisconnect() Disconnect this Channel from its remote peer
protected void	doRegister() 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(java.lang.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 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() 已过时。 no use-case for this.
protected void	invalidateRemoteAddress() 已过时。 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.
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().

从类继承的方法 io.netty.util.DefaultAttributeMap

attr

从类继承的方法 java.lang.Object

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

从接口继承的方法 io.netty.channel.Channel

config, isActive, isOpen, metadata

从接口继承的方法 io.netty.util.AttributeMap

attr

构造器详细资料

AbstractChannel

protected AbstractChannel(Channel parent)

Creates a new instance.

参数:

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

方法详细资料

newChannelPipeline

protected DefaultChannelPipeline newChannelPipeline()

Returns a new DefaultChannelPipeline instance.

isWritable

public boolean isWritable()

从接口复制的说明: Channel

Returns true 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 在接口中 Channel

parent

public Channel parent()

从接口复制的说明: Channel

Returns the parent of this channel.

指定者:

parent 在接口中 Channel

返回:

the parent channel. null if this channel does not have a parent channel.

pipeline

public ChannelPipeline pipeline()

从接口复制的说明: Channel

Return the assigned ChannelPipeline.

指定者:

pipeline 在接口中 Channel

alloc

public ByteBufAllocator alloc()

从接口复制的说明: Channel

Return the assigned ByteBufAllocator which will be used to allocate ByteBufs.

指定者:

alloc 在接口中 Channel

eventLoop

public EventLoop eventLoop()

从接口复制的说明: Channel

Return the EventLoop this Channel was registered to.

指定者:

eventLoop 在接口中 Channel

localAddress

public java.net.SocketAddress localAddress()

从接口复制的说明: 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.

指定者:

localAddress 在接口中 Channel

返回:

the local address of this channel. null if this channel is not bound.

invalidateLocalAddress

@Deprecated
protected void invalidateLocalAddress()

已过时。 no use-case for this.

remoteAddress

public java.net.SocketAddress remoteAddress()

从接口复制的说明: 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.

指定者:

remoteAddress 在接口中 Channel

返回:

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()

已过时。 no use-case for this.

isRegistered

public boolean isRegistered()

从接口复制的说明: Channel

Returns true if the Channel is registered with an EventLoop.

指定者:

isRegistered 在接口中 Channel

bind

public ChannelFuture bind(java.net.SocketAddress localAddress)

从接口复制的说明: Channel

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.

This will result in having the ChannelOutboundHandler.bind(ChannelHandlerContext, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

指定者:

bind 在接口中 Channel

connect

public ChannelFuture connect(java.net.SocketAddress remoteAddress)

从接口复制的说明: Channel

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.

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.

指定者:

connect 在接口中 Channel

connect

public ChannelFuture connect(java.net.SocketAddress remoteAddress,
                    java.net.SocketAddress localAddress)

从接口复制的说明: Channel

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.

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.

指定者:

connect 在接口中 Channel

disconnect

public ChannelFuture disconnect()

从接口复制的说明: Channel

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.

This will result in having the ChannelOutboundHandler.disconnect(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

指定者:

disconnect 在接口中 Channel

close

public ChannelFuture close()

从接口复制的说明: Channel

Request to close this Channel 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.

指定者:

close 在接口中 Channel

deregister

public ChannelFuture deregister()

从接口复制的说明: Channel

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.

This will result in having the ChannelOutboundHandler.deregister(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

指定者:

deregister 在接口中 Channel

flush

public Channel flush()

从接口复制的说明: Channel

Request to flush all pending messages.

指定者:

flush 在接口中 Channel

bind

public ChannelFuture bind(java.net.SocketAddress localAddress,
                 ChannelPromise promise)

从接口复制的说明: Channel

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. 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.

指定者:

bind 在接口中 Channel

connect

public ChannelFuture connect(java.net.SocketAddress remoteAddress,
                    ChannelPromise promise)

从接口复制的说明: Channel

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. 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.

指定者:

connect 在接口中 Channel

connect

public ChannelFuture connect(java.net.SocketAddress remoteAddress,
                    java.net.SocketAddress localAddress,
                    ChannelPromise promise)

从接口复制的说明: Channel

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. 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.

指定者:

connect 在接口中 Channel

disconnect

public ChannelFuture disconnect(ChannelPromise promise)

从接口复制的说明: Channel

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. 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 在接口中 Channel

close

public ChannelFuture close(ChannelPromise promise)

从接口复制的说明: Channel

Request to close this Channel 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.

指定者:

close 在接口中 Channel

deregister

public ChannelFuture deregister(ChannelPromise promise)

从接口复制的说明: Channel

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. 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 在接口中 Channel

read

public Channel read()

从接口复制的说明: Channel

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. 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.

指定者:

read 在接口中 Channel

write

public ChannelFuture write(java.lang.Object msg)

从接口复制的说明: Channel

Request to write a message via this Channel 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.

指定者:

write 在接口中 Channel

write

public ChannelFuture write(java.lang.Object msg,
                  ChannelPromise promise)

从接口复制的说明: Channel

Request to write a message via this Channel 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.

指定者:

write 在接口中 Channel

writeAndFlush

public ChannelFuture writeAndFlush(java.lang.Object msg)

从接口复制的说明: Channel

Shortcut for call Channel.write(Object) and Channel.flush().

指定者:

writeAndFlush 在接口中 Channel

writeAndFlush

public ChannelFuture writeAndFlush(java.lang.Object msg,
                          ChannelPromise promise)

从接口复制的说明: Channel

Shortcut for call Channel.write(Object, ChannelPromise) and Channel.flush().

指定者:

writeAndFlush 在接口中 Channel

newPromise

public ChannelPromise newPromise()

从接口复制的说明: Channel

Return a new ChannelPromise.

指定者:

newPromise 在接口中 Channel

newProgressivePromise

public ChannelProgressivePromise newProgressivePromise()

从接口复制的说明: Channel

Return an new ChannelProgressivePromise.

指定者:

newProgressivePromise 在接口中 Channel

newSucceededFuture

public ChannelFuture newSucceededFuture()

从接口复制的说明: Channel

Create a new ChannelFuture 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 在接口中 Channel

newFailedFuture

public ChannelFuture newFailedFuture(java.lang.Throwable cause)

从接口复制的说明: Channel

Create a new ChannelFuture 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 在接口中 Channel

closeFuture

public ChannelFuture closeFuture()

从接口复制的说明: Channel

Returns the ChannelFuture which will be notified when this channel is closed. This method always returns the same future instance.

指定者:

closeFuture 在接口中 Channel

unsafe

public Channel.Unsafe unsafe()

从接口复制的说明: Channel

Returns an internal-use-only object that provides unsafe operations.

指定者:

unsafe 在接口中 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.

覆盖:

hashCode 在类中 java.lang.Object

equals

public final boolean equals(java.lang.Object o)

Returns true if and only if the specified object is identical with this channel (i.e: this == o).

覆盖:

equals 在类中 java.lang.Object

compareTo

public final int compareTo(Channel o)

指定者:

compareTo 在接口中 java.lang.Comparable<Channel>

toString

public java.lang.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.

覆盖:

toString 在类中 java.lang.Object

voidPromise

public final ChannelPromise voidPromise()

从接口复制的说明: Channel

Return a special ChannelPromise which can be reused for different operations.

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.

Be aware this is an expert feature and should be used with care!

指定者:

voidPromise 在接口中 Channel

isCompatible

protected abstract boolean isCompatible(EventLoop loop)

Return true if the given EventLoop is compatible with this instance.

localAddress0

protected abstract java.net.SocketAddress localAddress0()

Returns the SocketAddress which is bound locally.

remoteAddress0

protected abstract java.net.SocketAddress remoteAddress0()

Return the SocketAddress which the Channel is connected to.

doRegister

protected void doRegister()
                   throws java.lang.Exception

Is called after the Channel is registered with its EventLoop as part of the register process. Sub-classes may override this method

抛出:

java.lang.Exception

doBind

protected abstract void doBind(java.net.SocketAddress localAddress)
                        throws java.lang.Exception

Bind the Channel to the SocketAddress

抛出:

java.lang.Exception

doDisconnect

protected abstract void doDisconnect()
                              throws java.lang.Exception

Disconnect this Channel from its remote peer

抛出:

java.lang.Exception

doClose

protected abstract void doClose()
                         throws java.lang.Exception

Close the Channel

抛出:

java.lang.Exception

doShutdownOutput

@UnstableApi
protected void doShutdownOutput()
                         throws java.lang.Exception

Called when conditions justify shutting down the output portion of the channel. This may happen if a write operation throws an exception.

抛出:

java.lang.Exception

doDeregister

protected void doDeregister()
                     throws java.lang.Exception

Deregister the Channel from its EventLoop. Sub-classes may override this method

抛出:

java.lang.Exception

doBeginRead

protected abstract void doBeginRead()
                             throws java.lang.Exception

Schedule a read operation.

抛出:

java.lang.Exception

doWrite

protected abstract void doWrite(ChannelOutboundBuffer in)
                         throws java.lang.Exception

Flush the content of the given buffer to the remote peer.

抛出:

java.lang.Exception

filterOutboundMessage

protected java.lang.Object filterOutboundMessage(java.lang.Object msg)
                                          throws java.lang.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)

抛出:

java.lang.Exception