Interface DuplexChannel

All Superinterfaces:

AttributeMap, Channel, ChannelOutboundInvoker, Comparable<Channel>

All Known Subinterfaces:

DomainSocketChannel, SocketChannel

All Known Implementing Classes:

AbstractEpollStreamChannel, AbstractKQueueStreamChannel, EpollDomainSocketChannel, EpollSocketChannel, KQueueDomainSocketChannel, KQueueSocketChannel, NioDomainSocketChannel, NioSocketChannel, OioSocketChannel

public interface DuplexChannel
extends Channel

A duplex Channel that has two sides that can be shutdown independently.

Nested Class Summary

Nested classes/interfaces inherited from interface Channel

Channel.Unsafe

Modifier and Type	Interface	Description
static interface	Channel.Unsafe	Unsafe operations that should never be called from user-code.

Method Summary

Modifier and Type	Method	Description
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()
boolean	isShutdown()	Determine if both the input and output of this channel have been shutdown.
ChannelFuture	shutdown()	Will shutdown the input and output sides of this channel.
ChannelFuture	shutdown(ChannelPromise promise)	Will shutdown the input and output sides of this channel.
ChannelFuture	shutdownInput()
ChannelFuture	shutdownInput(ChannelPromise promise)	Will shutdown the input and notify ChannelPromise.
ChannelFuture	shutdownOutput()
ChannelFuture	shutdownOutput(ChannelPromise promise)	Will shutdown the output and notify ChannelPromise.

Methods inherited from interface AttributeMap

attr, hasAttr

Modifier and Type	Method	Description
<T> Attribute<T>	attr(AttributeKey<T> key)	Get the Attribute for the given AttributeKey.
<T> boolean	hasAttr(AttributeKey<T> key)	Returns true if and only if the given Attribute exists in this AttributeMap.

Methods inherited from interface Channel

alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, config, eventLoop, flush, id, isActive, isOpen, isRegistered, isWritable, localAddress, metadata, parent, pipeline, read, remoteAddress, unsafe

Modifier and Type	Method	Description
ByteBufAllocator	alloc()	Return the assigned ByteBufAllocator which will be used to allocate ByteBufs.
long	bytesBeforeUnwritable()	Get how many bytes can be written until Channel.isWritable() returns false.
long	bytesBeforeWritable()	Get how many bytes must be drained from underlying buffers until Channel.isWritable() returns true.
ChannelFuture	closeFuture()	Returns the ChannelFuture which will be notified when this channel is closed.
ChannelConfig	config()	Returns the configuration of this channel.
EventLoop	eventLoop()	Return the EventLoop this Channel was registered to.
Channel	flush()	Request to flush all pending messages via this ChannelOutboundInvoker.
ChannelId	id()	Returns the globally unique identifier of this Channel.
boolean	isActive()	Return true if the Channel is active and so connected.
boolean	isOpen()	Returns true if the Channel is open and may get active later
boolean	isRegistered()	Returns true if the Channel is registered with an EventLoop.
boolean	isWritable()	Returns true if and only if the I/O thread will perform the requested write operation immediately.
SocketAddress	localAddress()	Returns the local address where this channel is bound to.
ChannelMetadata	metadata()	Return the ChannelMetadata of the Channel which describe the nature of the Channel.
Channel	parent()	Returns the parent of this channel.
ChannelPipeline	pipeline()	Return the assigned ChannelPipeline.
Channel	read()	Request to Read data from the Channel into the first inbound buffer, triggers an ChannelInboundHandler.channelRead(ChannelHandlerContext, Object) event if data was read, and triggers a channelReadComplete event so the handler can decide to continue reading.
SocketAddress	remoteAddress()	Returns the remote address where this channel is connected to.
Channel.Unsafe	unsafe()	Returns an internal-use-only object that provides unsafe operations.

Methods inherited from interface ChannelOutboundInvoker

bind, bind, close, close, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, voidPromise, write, write, writeAndFlush, writeAndFlush

Modifier and Type	Method	Description
ChannelFuture	bind(SocketAddress localAddress)	Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	bind(SocketAddress localAddress, ChannelPromise promise)	Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	close()	Request to close the Channel and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	close(ChannelPromise promise)	Request to close the Channel and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	connect(SocketAddress remoteAddress)	Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	connect(SocketAddress remoteAddress, ChannelPromise promise)	Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	connect(SocketAddress remoteAddress, SocketAddress localAddress)	Request to connect to the given SocketAddress while bind to the localAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	connect(SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise)	Request to connect to the given SocketAddress while bind to the localAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	deregister()	Request to deregister from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	deregister(ChannelPromise promise)	Request to deregister from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	disconnect()	Request to disconnect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	disconnect(ChannelPromise promise)	Request to disconnect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	newFailedFuture(Throwable cause)	Create a new ChannelFuture which is marked as failed already.
ChannelProgressivePromise	newProgressivePromise()	Return an new ChannelProgressivePromise
ChannelPromise	newPromise()	Return a new ChannelPromise.
ChannelFuture	newSucceededFuture()	Create a new ChannelFuture which is marked as succeeded already.
ChannelPromise	voidPromise()	Return a special ChannelPromise which can be reused for different operations.
ChannelFuture	write(Object msg)	Request to write a message via this ChannelHandlerContext through the ChannelPipeline.
ChannelFuture	write(Object msg, ChannelPromise promise)	Request to write a message via this ChannelHandlerContext through the ChannelPipeline.
ChannelFuture	writeAndFlush(Object msg)	Shortcut for call ChannelOutboundInvoker.write(Object) and ChannelOutboundInvoker.flush().
ChannelFuture	writeAndFlush(Object msg, ChannelPromise promise)	Shortcut for call ChannelOutboundInvoker.write(Object, ChannelPromise) and ChannelOutboundInvoker.flush().

Methods inherited from interface Comparable

compareTo

Method Details

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

shutdownInput

ChannelFuture shutdownInput()

See Also:

• Socket.shutdownInput()

shutdownInput

ChannelFuture shutdownInput(ChannelPromise promise)

Will shutdown the input and notify ChannelPromise.

See Also:

• Socket.shutdownInput()

isOutputShutdown

boolean isOutputShutdown()

See Also:

• Socket.isOutputShutdown()

shutdownOutput

ChannelFuture shutdownOutput()

See Also:

• Socket.shutdownOutput()

shutdownOutput

ChannelFuture shutdownOutput(ChannelPromise promise)

Will shutdown the output and notify ChannelPromise.

See Also:

• Socket.shutdownOutput()

isShutdown

boolean isShutdown()

Determine if both the input and output of this channel have been shutdown.

shutdown

ChannelFuture shutdown()

Will shutdown the input and output sides of this channel.

Returns:

will be completed when both shutdown operations complete.

shutdown

ChannelFuture shutdown(ChannelPromise promise)

Will shutdown the input and output sides of this channel.

Parameters:

promise - will be completed when both shutdown operations complete.

Returns:

will be completed when both shutdown operations complete.