io.netty.channel.socket

Interface SocketChannel

All Superinterfaces:

AttributeMap, Channel, Comparable<Channel>

All Known Implementing Classes:

EpollSocketChannel, NioSocketChannel, OioSocketChannel

public interface SocketChannel
extends Channel

A TCP/IP socket Channel.

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.
ServerSocketChannel	parent() Returns the parent of this channel.
InetSocketAddress	remoteAddress() Returns the remote address where this channel is connected to.
ChannelFuture	shutdownOutput()
ChannelFuture	shutdownOutput(ChannelPromise future)

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, isActive, isOpen, 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

Method Detail

parent

ServerSocketChannel parent()

Description copied from interface: Channel

Returns the parent of this channel.

Specified by:

parent in interface Channel

Returns:

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

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 DefaultAddressedEnvelope.recipient() 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()

shutdownOutput

ChannelFuture shutdownOutput(ChannelPromise future)

See Also:

Will notify the given {@link ChannelPromise}