io.netty.channel.socket.oio

Class OioSocketChannel

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

io.netty.channel.socket.oio.OioSocketChannel

All Implemented Interfaces:

Channel, SocketChannel, AttributeMap, Comparable<Channel>

public class OioSocketChannel
extends OioByteStreamChannel
implements SocketChannel

A SocketChannel which is using Old-Blocking-IO

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

Constructor and Description
OioSocketChannel() Create a new instance with an new Socket
OioSocketChannel(Channel parent, Socket socket) Create a new instance from the given Socket
OioSocketChannel(Socket socket) Create a new instance from the given Socket

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkInputShutdown() Check if the input was shutdown and if so return true.
OioSocketChannelConfig	config() Returns the configuration of this channel.
protected void	doBind(SocketAddress localAddress) Bind the Channel to the SocketAddress
protected void	doClose() Close the Channel
protected void	doConnect(SocketAddress remoteAddress, SocketAddress localAddress) Connect to the remote peer using the given localAddress if one is specified or null otherwise.
protected void	doDisconnect() Disconnect this Channel from its remote peer
protected int	doReadBytes(ByteBuf buf) Read bytes from the underlying Socket.
boolean	isActive() Return true if the Channel is active and so connected.
boolean	isInputShutdown() Returns true if and only if the remote peer shut down its output so that no more data is received from this channel.
boolean	isOpen() Returns true if the Channel is open an may get active later
boolean	isOutputShutdown()
InetSocketAddress	localAddress() Returns the local address where this channel is bound to.
protected SocketAddress	localAddress0() Returns the SocketAddress which is bound locally.
ServerSocketChannel	parent() Returns the parent of this channel.
InetSocketAddress	remoteAddress() Returns the remote address where this channel is connected to.
protected SocketAddress	remoteAddress0() Return the SocketAddress which the Channel is connected to.
protected void	setReadPending(boolean readPending)
ChannelFuture	shutdownOutput()
ChannelFuture	shutdownOutput(ChannelPromise future)

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

activate, available, doWriteBytes, doWriteFileRegion

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

doRead, doWrite, filterOutboundMessage, metadata

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

doBeginRead, isCompatible, isReadPending, newUnsafe

Methods inherited from class io.netty.channel.AbstractChannel

alloc, bind, bind, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doDeregister, doRegister, equals, eventLoop, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, pipeline, read, 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

alloc, bind, bind, close, close, closeFuture, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, eventLoop, flush, id, isRegistered, isWritable, metadata, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, pipeline, read, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface io.netty.util.AttributeMap

attr, hasAttr

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

OioSocketChannel

public OioSocketChannel()

Create a new instance with an new Socket

OioSocketChannel

public OioSocketChannel(Socket socket)

Create a new instance from the given Socket

Parameters:

socket - the Socket which is used by this instance

OioSocketChannel

public OioSocketChannel(Channel parent,
                Socket socket)

Create a new instance from the given Socket

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.

socket - the Socket which is used by this instance

Method Detail

parent

public ServerSocketChannel parent()

Description copied from interface: Channel

Returns the parent of this channel.

Specified by:

parent in interface Channel

Specified by:

parent in interface SocketChannel

Overrides:

parent in class AbstractChannel

Returns:

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

config

public OioSocketChannelConfig config()

Description copied from interface: Channel

Returns the configuration of this channel.

Specified by:

config in interface Channel

Specified by:

config in interface SocketChannel

isOpen

public boolean isOpen()

Description copied from interface: Channel

Returns true if the Channel is open an may get active later

Specified by:

isOpen in interface Channel

isActive

public boolean isActive()

Description copied from interface: Channel

Return true if the Channel is active and so connected.

Specified by:

isActive in interface Channel

Overrides:

isActive in class OioByteStreamChannel

isInputShutdown

public boolean isInputShutdown()

Description copied from interface: SocketChannel

Returns true if and only if the remote peer shut down its output so that no more data is received from this channel. Note that the semantic of this method is different from that of Socket.shutdownInput() and Socket.isInputShutdown().

Specified by:

isInputShutdown in interface SocketChannel

Overrides:

isInputShutdown in class AbstractOioByteChannel

isOutputShutdown

public boolean isOutputShutdown()

Specified by:

isOutputShutdown in interface SocketChannel

See Also:

Socket.isOutputShutdown()

shutdownOutput

public ChannelFuture shutdownOutput()

Specified by:

shutdownOutput in interface SocketChannel

See Also:

Socket.shutdownOutput()

doReadBytes

protected int doReadBytes(ByteBuf buf)
                   throws Exception

Description copied from class: AbstractOioByteChannel

Read bytes from the underlying Socket.

Overrides:

doReadBytes in class OioByteStreamChannel

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

shutdownOutput

public ChannelFuture shutdownOutput(ChannelPromise future)

Specified by:

shutdownOutput in interface SocketChannel

See Also:

Will notify the given {@link ChannelPromise}

localAddress

public InetSocketAddress localAddress()

Description copied from interface: 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.

Specified by:

localAddress in interface Channel

Specified by:

localAddress in interface SocketChannel

Overrides:

localAddress in class AbstractChannel

Returns:

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

remoteAddress

public InetSocketAddress 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

Specified by:

remoteAddress in interface SocketChannel

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.

localAddress0

protected SocketAddress localAddress0()

Description copied from class: AbstractChannel

Returns the SocketAddress which is bound locally.

Specified by:

localAddress0 in class AbstractChannel

remoteAddress0

protected SocketAddress remoteAddress0()

Description copied from class: AbstractChannel

Return the SocketAddress which the Channel is connected to.

Specified by:

remoteAddress0 in class AbstractChannel

doBind

protected void doBind(SocketAddress localAddress)
               throws Exception

Description copied from class: AbstractChannel

Bind the Channel to the SocketAddress

Specified by:

doBind in class AbstractChannel

Throws:

Exception

doConnect

protected void doConnect(SocketAddress remoteAddress,
             SocketAddress localAddress)
                  throws Exception

Description copied from class: AbstractOioChannel

Connect to the remote peer using the given localAddress if one is specified or null otherwise.

Specified by:

doConnect in class AbstractOioChannel

Throws:

Exception

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

doClose

protected void doClose()
                throws Exception

Description copied from class: AbstractChannel

Close the Channel

Overrides:

doClose in class OioByteStreamChannel

Throws:

Exception

checkInputShutdown

protected boolean checkInputShutdown()

Description copied from class: AbstractOioByteChannel

Check if the input was shutdown and if so return true. The default implementation sleeps also for AbstractOioChannel.SO_TIMEOUT milliseconds to simulate some blocking.

Overrides:

checkInputShutdown in class AbstractOioByteChannel

setReadPending

protected void setReadPending(boolean readPending)

Overrides:

setReadPending in class AbstractOioChannel