io.netty.channel

Interface Channel.Unsafe

All Known Subinterfaces:

AbstractNioChannel.NioUnsafe

All Known Implementing Classes:

AbstractChannel.AbstractUnsafe, AbstractNioChannel.AbstractNioUnsafe, AbstractServerChannel.AbstractServerUnsafe

Enclosing interface:

Channel

public static interface Channel.Unsafe

Unsafe operations that should never be called from user-code. These methods are only provided to implement the actual transport.

Method Summary

Methods

Modifier and Type	Method and Description
void	bind(SocketAddress localAddress, ChannelFuture future) Bind the SocketAddress to the Channel of the ChannelFuture and notify it once its done.
void	close(ChannelFuture future) Close the Channel of the ChannelFuture and notify the ChannelFuture once the operation was complete.
void	closeForcibly() Closes the Channel immediately without firing any events.
void	connect(SocketAddress remoteAddress, SocketAddress localAddress, ChannelFuture future) Connect the Channel of the given ChannelFuture with the given remote SocketAddress.
void	deregister(ChannelFuture future) Deregister the Channel of the ChannelFuture from EventLoop and notify the ChannelFuture once the operation was complete.
ChannelHandlerContext	directOutboundContext() Return the ChannelHandlerContext which is directly connected to the outbound of the underlying transport.
void	disconnect(ChannelFuture future) Disconnect the Channel of the ChannelFuture and notify the ChannelFuture once the operation was complete.
void	flush(ChannelFuture future) Flush out all data that was buffered in the buffer of the directOutboundContext() and was not flushed out yet.
void	flushNow() Flush out all data now.
SocketAddress	localAddress() Return the SocketAddress to which is bound local or null if none.
void	register(EventLoop eventLoop, ChannelFuture future) Register the Channel of the ChannelFuture with the EventLoop and notify the ChannelFuture once the registration was complete.
SocketAddress	remoteAddress() Return the SocketAddress to which is bound remote or null if none is bound yet.
void	resumeRead() Resume reads from the underlying transport.
void	suspendRead() Suspend reads from the underlying transport, which basicly has the effect of no new data that will get dispatched.
ChannelFuture	voidFuture() Return a VoidChannelFuture.

Method Detail

directOutboundContext

ChannelHandlerContext directOutboundContext()

Return the ChannelHandlerContext which is directly connected to the outbound of the underlying transport.

voidFuture

ChannelFuture voidFuture()

Return a VoidChannelFuture. This method always return the same instance.

localAddress

SocketAddress localAddress()

Return the SocketAddress to which is bound local or null if none.

remoteAddress

SocketAddress remoteAddress()

Return the SocketAddress to which is bound remote or null if none is bound yet.

register

void register(EventLoop eventLoop,
            ChannelFuture future)

Register the Channel of the ChannelFuture with the EventLoop and notify the ChannelFuture once the registration was complete.

bind

void bind(SocketAddress localAddress,
        ChannelFuture future)

Bind the SocketAddress to the Channel of the ChannelFuture and notify it once its done.

connect

void connect(SocketAddress remoteAddress,
           SocketAddress localAddress,
           ChannelFuture future)

Connect the Channel of the given ChannelFuture with the given remote SocketAddress. If a specific local SocketAddress should be used it need to be given as argument. Otherwise just pass null to it. The ChannelFuture will get notified once the connect operation was complete.

disconnect

void disconnect(ChannelFuture future)

Disconnect the Channel of the ChannelFuture and notify the ChannelFuture once the operation was complete.

close

void close(ChannelFuture future)

Close the Channel of the ChannelFuture and notify the ChannelFuture once the operation was complete.

closeForcibly

void closeForcibly()

Closes the Channel immediately without firing any events. Probably only useful when registration attempt failed.

deregister

void deregister(ChannelFuture future)

Deregister the Channel of the ChannelFuture from EventLoop and notify the ChannelFuture once the operation was complete.

flush

void flush(ChannelFuture future)

Flush out all data that was buffered in the buffer of the directOutboundContext() and was not flushed out yet. After that is done the ChannelFuture will get notified

flushNow

void flushNow()

Flush out all data now.

suspendRead

void suspendRead()

Suspend reads from the underlying transport, which basicly has the effect of no new data that will get dispatched.

resumeRead

void resumeRead()

Resume reads from the underlying transport. If suspendRead() was not called before, this has no effect.