Netty/Transport 4.1.107.Final · io.netty.channel.ChannelOutboundInvoker

Method Summary

Modifier and Type	Method and Description
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public ChannelOutboundInvoker	flush() Request to flush all pending messages via this ChannelOutboundInvoker.
public ChannelFuture	newFailedFuture(Throwable cause) Create a new `ChannelFuture` which is marked as failed already.
public ChannelProgressivePromise	newProgressivePromise() Return an new `ChannelProgressivePromise`
public ChannelPromise	newPromise() Return a new `ChannelPromise`.
public ChannelFuture	newSucceededFuture() Create a new `ChannelFuture` which is marked as succeeded already.
public ChannelOutboundInvoker	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.
public ChannelPromise	voidPromise() Return a special ChannelPromise which can be reused for different operations.
public ChannelFuture	write(Object msg) Request to write a message via this `ChannelHandlerContext` through the `ChannelPipeline`.
public ChannelFuture	write(Object msg, ChannelPromise promise) Request to write a message via this `ChannelHandlerContext` through the `ChannelPipeline`.
public ChannelFuture	writeAndFlush(Object msg, ChannelPromise promise) Shortcut for call `write(Object, ChannelPromise)` and `flush()`.
public ChannelFuture	writeAndFlush(Object msg) Shortcut for call `write(Object)` and `flush()`.

Method Detail

bind back to summary

bind	back to summary
public 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. This will result in having the `ChannelOutboundHandler#bind(ChannelHandlerContext, SocketAddress, ChannelPromise)` method called of the next `ChannelOutboundHandler` contained in the `ChannelPipeline` of the `Channel`.

public 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.

This will result in having the ChannelOutboundHandler#bind(ChannelHandlerContext, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

bind back to summary

bind	back to summary
public 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. The given `ChannelPromise` will be notified. This will result in having the `ChannelOutboundHandler#bind(ChannelHandlerContext, SocketAddress, ChannelPromise)` method called of the next `ChannelOutboundHandler` contained in the `ChannelPipeline` of the `Channel`.

public 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. The given ChannelPromise will be notified.

close back to summary

close	back to summary
public 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. After it is closed it is not possible to reuse it again. This will result in having the `ChannelOutboundHandler#close(ChannelHandlerContext, ChannelPromise)` method called of the next `ChannelOutboundHandler` contained in the `ChannelPipeline` of the `Channel`.

public 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. After it is closed it is not possible to reuse it again.

This will result in having the ChannelOutboundHandler#close(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

close back to summary

close	back to summary
public 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. After it is closed it is not possible to reuse it again. The given `ChannelPromise` will be notified. This will result in having the `ChannelOutboundHandler#close(ChannelHandlerContext, ChannelPromise)` method called of the next `ChannelOutboundHandler` contained in the `ChannelPipeline` of the `Channel`.

public ChannelFuture close(ChannelPromise promise)

connect back to summary

connect	back to summary
public 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. If the connection fails because of a connection timeout, the `ChannelFuture` will get failed with a `ConnectTimeoutException`. If it fails because of connection refused a `ConnectException` will be used. This will result in having the `ChannelOutboundHandler#connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise)` method called of the next `ChannelOutboundHandler` contained in the `ChannelPipeline` of the `Channel`.

public 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.

If the connection fails because of a connection timeout, the ChannelFuture will get failed with a ConnectTimeoutException. If it fails because of connection refused a ConnectException will be used.

This will result in having the ChannelOutboundHandler#connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

connect back to summary

connect	back to summary
public 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. This will result in having the `ChannelOutboundHandler#connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise)` method called of the next `ChannelOutboundHandler` contained in the `ChannelPipeline` of the `Channel`.

public 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.

connect back to summary

connect	back to summary
public 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. The given `ChannelFuture` will be notified. If the connection fails because of a connection timeout, the `ChannelFuture` will get failed with a `ConnectTimeoutException`. If it fails because of connection refused a `ConnectException` will be used. This will result in having the `ChannelOutboundHandler#connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise)` method called of the next `ChannelOutboundHandler` contained in the `ChannelPipeline` of the `Channel`.

public 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. The given ChannelFuture will be notified.

connect back to summary

connect	back to summary
public 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. The given `ChannelPromise` will be notified and also returned. This will result in having the `ChannelOutboundHandler#connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise)` method called of the next `ChannelOutboundHandler` contained in the `ChannelPipeline` of the `Channel`.

public ChannelFuture connect(SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise)

deregister back to summary

deregister	back to summary
public 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. This will result in having the `ChannelOutboundHandler#deregister(ChannelHandlerContext, ChannelPromise)` method called of the next `ChannelOutboundHandler` contained in the `ChannelPipeline` of the `Channel`.

public 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.

This will result in having the ChannelOutboundHandler#deregister(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

deregister back to summary

deregister	back to summary
public 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. The given `ChannelPromise` will be notified. This will result in having the `ChannelOutboundHandler#deregister(ChannelHandlerContext, ChannelPromise)` method called of the next `ChannelOutboundHandler` contained in the `ChannelPipeline` of the `Channel`.

public 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. The given ChannelPromise will be notified.

disconnect back to summary

disconnect	back to summary
public 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. This will result in having the `ChannelOutboundHandler#disconnect(ChannelHandlerContext, ChannelPromise)` method called of the next `ChannelOutboundHandler` contained in the `ChannelPipeline` of the `Channel`.

public 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.

This will result in having the ChannelOutboundHandler#disconnect(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

disconnect back to summary

disconnect	back to summary
public 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. The given `ChannelPromise` will be notified. This will result in having the `ChannelOutboundHandler#disconnect(ChannelHandlerContext, ChannelPromise)` method called of the next `ChannelOutboundHandler` contained in the `ChannelPipeline` of the `Channel`.

public 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. The given ChannelPromise will be notified.

flush	back to summary
public ChannelOutboundInvoker flush() Request to flush all pending messages via this ChannelOutboundInvoker.

newFailedFuture	back to summary
public ChannelFuture newFailedFuture(Throwable cause) Create a new `ChannelFuture` which is marked as failed already. So `ChannelFuture#isSuccess()` will return `false`. All `FutureListener` added to it will be notified directly. Also every call of blocking methods will just return without blocking.

newProgressivePromise	back to summary
public ChannelProgressivePromise newProgressivePromise() Return an new `ChannelProgressivePromise`

newPromise	back to summary
public ChannelPromise newPromise() Return a new `ChannelPromise`.

newSucceededFuture	back to summary
public ChannelFuture newSucceededFuture() Create a new `ChannelFuture` which is marked as succeeded already. So `ChannelFuture#isSuccess()` will return `true`. All `FutureListener` added to it will be notified directly. Also every call of blocking methods will just return without blocking.

read back to summary

read	back to summary
public ChannelOutboundInvoker 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. If there's a pending read operation already, this method does nothing. This will result in having the `ChannelOutboundHandler#read(ChannelHandlerContext)` method called of the next `ChannelOutboundHandler` contained in the `ChannelPipeline` of the `Channel`.

public ChannelOutboundInvoker 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. If there's a pending read operation already, this method does nothing.

This will result in having the ChannelOutboundHandler#read(ChannelHandlerContext) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

voidPromise back to summary

voidPromise	back to summary
public ChannelPromise voidPromise() Return a special ChannelPromise which can be reused for different operations. It's only supported to use it for `ChannelOutboundInvoker#write(Object, ChannelPromise)`. Be aware that the returned `ChannelPromise` will not support most operations and should only be used if you want to save an object allocation for every write operation. You will not be able to detect if the operation was complete, only if it failed as the implementation will call `ChannelPipeline#fireExceptionCaught(Throwable)` in this case. Be aware this is an expert feature and should be used with care!

public ChannelPromise voidPromise()

Return a special ChannelPromise which can be reused for different operations.

It's only supported to use it for ChannelOutboundInvoker#write(Object, ChannelPromise).

Be aware that the returned ChannelPromise will not support most operations and should only be used if you want to save an object allocation for every write operation. You will not be able to detect if the operation was complete, only if it failed as the implementation will call ChannelPipeline#fireExceptionCaught(Throwable) in this case.

Be aware this is an expert feature and should be used with care!

write	back to summary
public ChannelFuture write(Object msg) Request to write a message via this `ChannelHandlerContext` through the `ChannelPipeline`. This method will not request to actual flush, so be sure to call `flush()` once you want to request to flush all pending data to the actual transport.

write	back to summary
public ChannelFuture write(Object msg, ChannelPromise promise) Request to write a message via this `ChannelHandlerContext` through the `ChannelPipeline`. This method will not request to actual flush, so be sure to call `flush()` once you want to request to flush all pending data to the actual transport.

writeAndFlush	back to summary
public ChannelFuture writeAndFlush(Object msg, ChannelPromise promise) Shortcut for call `write(Object, ChannelPromise)` and `flush()`.

writeAndFlush	back to summary
public ChannelFuture writeAndFlush(Object msg) Shortcut for call `write(Object)` and `flush()`.

public Interface ChannelOutboundInvoker

Method Summary

Method Detail