Interface SocketChannel

All Superinterfaces:

AttributeMap, Channel, ChannelOutboundInvoker, Comparable<Channel>, DuplexChannel

All Known Implementing Classes:

EpollSocketChannel, IoUringSocketChannel, KQueueSocketChannel, NioSocketChannel, OioSocketChannel

public interface SocketChannel
extends DuplexChannel

A TCP/IP socket Channel.

Nested Class Summary

Nested classes/interfaces inherited from interface Channel

Channel.Unsafe

Method Summary

Modifier and Type	Method	Description
SocketChannelConfig	config()	Returns the configuration of this channel.
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.

Methods inherited from interface AttributeMap

attr, hasAttr

Methods inherited from interface Channel

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

Methods inherited from interface Comparable

compareTo

Methods inherited from interface DuplexChannel

isInputShutdown, isOutputShutdown, isShutdown, shutdown, shutdown, shutdownInput, shutdownInput, shutdownOutput, shutdownOutput

Method Details

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.