ChannelOutboundInvoker (Netty API Reference (4.1.128.Final))

All Known Subinterfaces:

Channel, ChannelHandlerContext, ChannelPipeline, DatagramChannel, DomainDatagramChannel, DomainSocketChannel, DuplexChannel, Http2StreamChannel, SctpChannel, SctpServerChannel, ServerChannel, ServerDomainSocketChannel, ServerSocketChannel, SocketChannel, UdtChannel, UdtServerChannel, UnixChannel

All Known Implementing Classes:

AbstractChannel, AbstractEpollServerChannel, AbstractEpollStreamChannel, AbstractKQueueServerChannel, AbstractKQueueStreamChannel, AbstractNioByteChannel, AbstractNioChannel, AbstractNioMessageChannel, AbstractOioByteChannel, AbstractOioChannel, AbstractOioMessageChannel, AbstractServerChannel, DefaultChannelPipeline, EmbeddedChannel, EpollDatagramChannel, EpollDomainDatagramChannel, EpollDomainSocketChannel, EpollServerDomainSocketChannel, EpollServerSocketChannel, EpollSocketChannel, KQueueDatagramChannel, KQueueDomainDatagramChannel, KQueueDomainSocketChannel, KQueueServerDomainSocketChannel, KQueueServerSocketChannel, KQueueSocketChannel, LocalChannel, LocalServerChannel, NioDatagramChannel, NioDomainSocketChannel, NioSctpChannel, NioSctpServerChannel, NioServerDomainSocketChannel, NioServerSocketChannel, NioSocketChannel, NioUdtAcceptorChannel, NioUdtByteAcceptorChannel, NioUdtByteConnectorChannel, NioUdtByteRendezvousChannel, NioUdtMessageAcceptorChannel, NioUdtMessageConnectorChannel, NioUdtMessageRendezvousChannel, OioByteStreamChannel, OioDatagramChannel, OioSctpChannel, OioSctpServerChannel, OioServerSocketChannel, OioSocketChannel, RxtxChannel
```
public interface ChannelOutboundInvoker
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and 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.
`ChannelOutboundInvoker`	`flush()` Request to flush all pending messages via this ChannelOutboundInvoker.
`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.
`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.
`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 `write(Object)` and `flush()`.
`ChannelFuture`	`writeAndFlush(Object msg, ChannelPromise promise)` Shortcut for call `write(Object, ChannelPromise)` and `flush()`.

- Method Detail
  - bind
```
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.
  - connect
```
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
```
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.
  - disconnect
```
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.
  - close
```
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.
  - deregister
```
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.
  - bind
```
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.
  - connect
```
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.
  - connect
```
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.
  - disconnect
```
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.
  - close
```
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.
  - deregister
```
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.
  - read
```
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.
  - write
```
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
```
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.
  - flush
```
ChannelOutboundInvoker flush()
```
    Request to flush all pending messages via this ChannelOutboundInvoker.
  - writeAndFlush
```
ChannelFuture writeAndFlush(Object msg,
                            ChannelPromise promise)
```
    Shortcut for call write(Object, ChannelPromise) and flush().
  - writeAndFlush
```
ChannelFuture writeAndFlush(Object msg)
```
    Shortcut for call write(Object) and flush().
  - newPromise
```
ChannelPromise newPromise()
```
    Return a new ChannelPromise.
  - newProgressivePromise
```
ChannelProgressivePromise newProgressivePromise()
```
    Return an new ChannelProgressivePromise
  - newSucceededFuture
```
ChannelFuture newSucceededFuture()
```
    Create a new ChannelFuture which is marked as succeeded already. So Future.isSuccess() will return true. All FutureListener added to it will be notified directly. Also every call of blocking methods will just return without blocking.
  - newFailedFuture
```
ChannelFuture newFailedFuture(Throwable cause)
```
    Create a new ChannelFuture which is marked as failed already. So Future.isSuccess() will return false. All FutureListener added to it will be notified directly. Also every call of blocking methods will just return without blocking.
  - voidPromise
```
ChannelPromise voidPromise()
```
    Return a special ChannelPromise which can be reused for different operations.
    It's only supported to use it for 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!

Interface ChannelOutboundInvoker

Method Summary

Method Detail

bind

connect

connect

disconnect

close

deregister

bind

connect

connect

disconnect

close

deregister

read

write

write

flush

writeAndFlush

writeAndFlush

newPromise

newProgressivePromise

newSucceededFuture

newFailedFuture

voidPromise