io.netty.channel.socket

Interface SocketChannel

All Superinterfaces:

io.netty.util.AttributeMap, Channel, ChannelFutureFactory, ChannelOutboundInvoker, Comparable<Channel>

All Known Implementing Classes:

AioSocketChannel, NioSocketChannel, OioSocketChannel

public interface SocketChannel
extends Channel

A TCP/IP socket Channel which was either accepted by ServerSocketChannel or created by ClientSocketChannelFactory.

Nested Class Summary

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

Channel.Unsafe

Method Summary

Methods

Modifier and Type	Method and Description
SocketChannelConfig	config() Returns the configuration of this channel.
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	isOutputShutdown()
InetSocketAddress	localAddress() Returns the local address where this channel is bound to.
InetSocketAddress	remoteAddress() Returns the remote address where this channel is connected to.
ChannelFuture	shutdownOutput()

Methods inherited from interface io.netty.channel.Channel

closeFuture, eventLoop, id, isActive, isOpen, isRegistered, metadata, outboundByteBuffer, outboundMessageBuffer, parent, pipeline, unsafe

Methods inherited from interface io.netty.util.AttributeMap

attr

Methods inherited from interface io.netty.channel.ChannelOutboundInvoker

bind, bind, close, close, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, flush, flush, write, write

Methods inherited from interface io.netty.channel.ChannelFutureFactory

newFailedFuture, newFuture, newSucceededFuture

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

config

SocketChannelConfig config()

Description copied from interface: Channel

Returns the configuration of this channel.

Specified by:

config in interface Channel

localAddress

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

Returns:

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

remoteAddress

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

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 MessageEvent#getRemoteAddress() to determine the origination of the received message as this method will return null.

isInputShutdown

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. Note that the semantic of this method is different from that of Socket.shutdownInput() and Socket.isInputShutdown().

isOutputShutdown

boolean isOutputShutdown()

See Also:

Socket.isOutputShutdown()

shutdownOutput

ChannelFuture shutdownOutput()

See Also:

Socket.shutdownOutput()