Class AbstractServerChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.AbstractServerChannel

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, ServerChannel, AttributeMap, Comparable<Channel>

Direct Known Subclasses:

LocalServerChannel

public abstract class AbstractServerChannel
extends AbstractChannel
implements ServerChannel

A skeletal server-side Channel implementation. A server-side Channel does not allow the following operations:

• Channel.connect(SocketAddress, ChannelPromise)
• Channel.disconnect(ChannelPromise)
• Channel.write(Object, ChannelPromise)
• Channel.flush()
• and the shortcut methods which calls the methods mentioned above

Nested Class Summary

Nested classes/interfaces inherited from class AbstractChannel

AbstractChannel.AbstractUnsafe

Nested classes/interfaces inherited from interface Channel

Channel.Unsafe

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractServerChannel()	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected void	doDisconnect()	Disconnect this Channel from its remote peer
protected void	doWrite(ChannelOutboundBuffer in)	Flush the content of the given buffer to the remote peer.
protected final 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.
ChannelMetadata	metadata()	Return the ChannelMetadata of the Channel which describe the nature of the Channel.
protected AbstractChannel.AbstractUnsafe	newUnsafe()	Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel
SocketAddress	remoteAddress()	Returns the remote address where this channel is connected to.
protected SocketAddress	remoteAddress0()	Return the SocketAddress which the Channel is connected to.

Methods inherited from class AbstractChannel

closeFuture, compareTo, doBeginRead, doBind, doClose, doDeregister, doRegister, doRegister, doShutdownOutput, equals, eventLoop, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isCompatible, isRegistered, localAddress, localAddress0, maxMessagesPerWrite, newChannelPipeline, newId, parent, pipeline, toString, unsafe, validateFileRegion, voidPromise

Methods inherited from class DefaultAttributeMap

attr, hasAttr

Methods inherited from class Object

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

Methods inherited from interface AttributeMap

attr, hasAttr

Methods inherited from interface Channel

alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, config, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, eventLoop, flush, getOption, id, isActive, isOpen, isRegistered, isWritable, localAddress, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, setOption, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface Comparable

compareTo

Constructor Details

AbstractServerChannel

protected AbstractServerChannel()

Creates a new instance.

Method Details

metadata

public ChannelMetadata metadata()

Description copied from interface: Channel

Return the ChannelMetadata of the Channel which describe the nature of the Channel.

Specified by:

metadata in interface Channel

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

Overrides:

remoteAddress in class AbstractChannel

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.

remoteAddress0

protected SocketAddress remoteAddress0()

Description copied from class: AbstractChannel

Return the SocketAddress which the Channel is connected to.

Specified by:

remoteAddress0 in class AbstractChannel

doDisconnect

protected void doDisconnect()
                     throws Exception

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Specified by:

doDisconnect in class AbstractChannel

Throws:

Exception

newUnsafe

protected AbstractChannel.AbstractUnsafe newUnsafe()

Description copied from class: AbstractChannel

Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel

Specified by:

newUnsafe in class AbstractChannel

doWrite

protected void doWrite(ChannelOutboundBuffer in)
                throws Exception

Description copied from class: AbstractChannel

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

Specified by:

doWrite in class AbstractChannel

Throws:

Exception

filterOutboundMessage

protected final Object filterOutboundMessage(Object msg)

Description copied from class: AbstractChannel

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)

Overrides:

filterOutboundMessage in class AbstractChannel