io.netty.channel.oio

Class AbstractOioByteChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.oio.AbstractOioChannel

io.netty.channel.oio.AbstractOioByteChannel

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, AttributeMap, Comparable<Channel>

Direct Known Subclasses:

OioByteStreamChannel

public abstract class AbstractOioByteChannel
extends AbstractOioChannel

Abstract base class for OIO which reads and writes bytes from/to a Socket

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.channel.AbstractChannel

AbstractChannel.AbstractUnsafe

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

Channel.Unsafe

Field Summary

Fields inherited from class io.netty.channel.oio.AbstractOioChannel

SO_TIMEOUT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractOioByteChannel(Channel parent)

Method Summary

Modifier and Type	Method and Description
protected abstract int	available() Return the number of bytes ready to read from the underlying Socket.
protected void	doRead()
protected abstract int	doReadBytes(ByteBuf buf) Read bytes from the underlying Socket.
protected void	doWrite(ChannelOutboundBuffer in) Flush the content of the given buffer to the remote peer.
protected abstract void	doWriteBytes(ByteBuf buf) Write the data which is hold by the ByteBuf to the underlying Socket.
protected abstract void	doWriteFileRegion(FileRegion region) Write the data which is hold by the FileRegion to the underlying Socket.
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.
protected abstract boolean	isInputShutdown() Determine if the input side of this channel is shutdown.
ChannelMetadata	metadata() Return the ChannelMetadata of the Channel which describe the nature of the Channel.
protected abstract ChannelFuture	shutdownInput() Shutdown the input side of this channel.

Methods inherited from class io.netty.channel.oio.AbstractOioChannel

clearReadPending, doBeginRead, doConnect, isCompatible, isReadPending, newUnsafe, setReadPending

Methods inherited from class io.netty.channel.AbstractChannel

alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doBind, doClose, doDeregister, doDisconnect, doRegister, equals, eventLoop, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, localAddress, localAddress0, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, remoteAddress0, toString, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

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

config, isActive, isOpen

Methods inherited from interface io.netty.util.AttributeMap

attr, hasAttr

Constructor Detail

AbstractOioByteChannel

protected AbstractOioByteChannel(Channel parent)

See Also:

AbstractOioByteChannel(Channel)

Method Detail

metadata

public ChannelMetadata metadata()

Description copied from interface: Channel

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

isInputShutdown

protected abstract boolean isInputShutdown()

Determine if the input side of this channel is shutdown.

Returns:

true if the input side of this channel is shutdown.

shutdownInput

protected abstract ChannelFuture shutdownInput()

Shutdown the input side of this channel.

Returns:

A channel future that will complete when the shutdown is complete.

doRead

protected void doRead()

Specified by:

doRead in class AbstractOioChannel

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)
                                      throws Exception

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

Throws:

Exception

available

protected abstract int available()

Return the number of bytes ready to read from the underlying Socket.

doReadBytes

protected abstract int doReadBytes(ByteBuf buf)
                            throws Exception

Read bytes from the underlying Socket.

Parameters:

buf - the ByteBuf into which the read bytes will be written

Returns:

amount the number of bytes read. This may return a negative amount if the underlying Socket was closed

Throws:

Exception - is thrown if an error occurred

doWriteBytes

protected abstract void doWriteBytes(ByteBuf buf)
                              throws Exception

Write the data which is hold by the ByteBuf to the underlying Socket.

Parameters:

buf - the ByteBuf which holds the data to transfer

Throws:

Exception - is thrown if an error occurred

doWriteFileRegion

protected abstract void doWriteFileRegion(FileRegion region)
                                   throws Exception

Write the data which is hold by the FileRegion to the underlying Socket.

Parameters:

region - the FileRegion which holds the data to transfer

Throws:

Exception - is thrown if an error occurred