io.netty.channel.oio

Class OioByteStreamChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.oio.AbstractOioChannel

io.netty.channel.oio.AbstractOioByteChannel

io.netty.channel.oio.OioByteStreamChannel

All Implemented Interfaces:

Channel, AttributeMap, Comparable<Channel>

Direct Known Subclasses:

OioSocketChannel, RxtxChannel

public abstract class OioByteStreamChannel
extends AbstractOioByteChannel

Abstract base class for OIO Channels that are based on streams.

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	OioByteStreamChannel(Channel parent) Create a new instance

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activate(InputStream is, OutputStream os) Activate this instance.
protected int	available() Return the number of bytes ready to read from the underlying Socket.
protected void	doClose() Close the Channel
protected int	doReadBytes(ByteBuf buf) Read bytes from the underlying Socket.
protected void	doWriteBytes(ByteBuf buf) Write the data which is hold by the ByteBuf to the underlying Socket.
protected void	doWriteFileRegion(FileRegion region) Write the data which is hold by the FileRegion to the underlying Socket.
boolean	isActive() Return true if the Channel is active and so connected.

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

checkInputShutdown, doRead, doWrite, filterOutboundMessage, isInputShutdown, metadata

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

doBeginRead, doConnect, isCompatible, isReadPending, newUnsafe, setReadPending

Methods inherited from class io.netty.channel.AbstractChannel

alloc, bind, bind, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doBind, doDeregister, doDisconnect, doRegister, equals, eventLoop, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, localAddress, localAddress0, newFailedFuture, 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, isOpen

Methods inherited from interface io.netty.util.AttributeMap

attr, hasAttr

Constructor Detail

OioByteStreamChannel

protected OioByteStreamChannel(Channel parent)

Create a new instance

Parameters:

parent - the parent Channel which was used to create this instance. This can be null if the has no parent as it was created by your self.

Method Detail

activate

protected final void activate(InputStream is,
            OutputStream os)

Activate this instance. After this call isActive() will return true.

isActive

public boolean isActive()

Description copied from interface: Channel

Return true if the Channel is active and so connected.

available

protected int available()

Description copied from class: AbstractOioByteChannel

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

Specified by:

available in class AbstractOioByteChannel

doReadBytes

protected int doReadBytes(ByteBuf buf)
                   throws Exception

Description copied from class: AbstractOioByteChannel

Read bytes from the underlying Socket.

Specified by:

doReadBytes in class AbstractOioByteChannel

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 void doWriteBytes(ByteBuf buf)
                     throws Exception

Description copied from class: AbstractOioByteChannel

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

Specified by:

doWriteBytes in class AbstractOioByteChannel

Parameters:

buf - the ByteBuf which holds the data to transfer

Throws:

Exception - is thrown if an error occurred

doWriteFileRegion

protected void doWriteFileRegion(FileRegion region)
                          throws Exception

Description copied from class: AbstractOioByteChannel

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

Specified by:

doWriteFileRegion in class AbstractOioByteChannel

Parameters:

region - the FileRegion which holds the data to transfer

Throws:

Exception - is thrown if an error occurred

doClose

protected void doClose()
                throws Exception

Description copied from class: AbstractChannel

Close the Channel

Specified by:

doClose in class AbstractChannel

Throws:

Exception