AbstractChannel.AbstractUnsafe (Netty API Reference (4.1.115.Final))

java.lang.Object
- io.netty.channel.AbstractChannel.AbstractUnsafe

All Implemented Interfaces:

Channel.Unsafe

Direct Known Subclasses:

AbstractNioChannel.AbstractNioUnsafe

Enclosing class:

AbstractChannel
```
protected abstract class AbstractChannel.AbstractUnsafe
extends Object
implements Channel.Unsafe
```
Unsafe implementation which sub-classes must extend and use.

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractUnsafe()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractUnsafe()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Throwable`	`annotateConnectException(Throwable cause, SocketAddress remoteAddress)` Appends the remote address to the message of the exceptions caused by connection attempt failure.
`void`	`beginRead()` Schedules a read operation that fills the inbound buffer of the first `ChannelInboundHandler` in the `ChannelPipeline`.
`void`	`bind(SocketAddress localAddress, ChannelPromise promise)` Bind the `SocketAddress` to the `Channel` of the `ChannelPromise` and notify it once its done.
`void`	`close(ChannelPromise promise)` Close the `Channel` of the `ChannelPromise` and notify the `ChannelPromise` once the operation was complete.
`void`	`closeForcibly()` Closes the `Channel` immediately without firing any events.
`protected void`	`closeIfClosed()`
`void`	`deregister(ChannelPromise promise)` Deregister the `Channel` of the `ChannelPromise` from `EventLoop` and notify the `ChannelPromise` once the operation was complete.
`void`	`disconnect(ChannelPromise promise)` Disconnect the `Channel` of the `ChannelFuture` and notify the `ChannelPromise` once the operation was complete.
`protected boolean`	`ensureOpen(ChannelPromise promise)`
`void`	`flush()` Flush out all write operations scheduled via `Channel.Unsafe.write(Object, ChannelPromise)`.
`protected void`	`flush0()`
`protected void`	`handleWriteError(Throwable t)`
`SocketAddress`	`localAddress()` Return the `SocketAddress` to which is bound local or `null` if none.
`ChannelOutboundBuffer`	`outboundBuffer()` Returns the `ChannelOutboundBuffer` of the `Channel` where the pending write requests are stored.
`protected Executor`	`prepareToClose()` Prepares to close the `Channel`.
`RecvByteBufAllocator.Handle`	`recvBufAllocHandle()` Return the assigned `RecvByteBufAllocator.Handle` which will be used to allocate `ByteBuf`'s when receiving data.
`void`	`register(EventLoop eventLoop, ChannelPromise promise)` Register the `Channel` of the `ChannelPromise` 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.
`protected void`	`safeSetFailure(ChannelPromise promise, Throwable cause)` Marks the specified `promise` as failure.
`protected void`	`safeSetSuccess(ChannelPromise promise)` Marks the specified `promise` as success.
`void`	`shutdownOutput(ChannelPromise promise)` Shutdown the output portion of the corresponding `Channel`.
`ChannelPromise`	`voidPromise()` Return a special ChannelPromise which can be reused and passed to the operations in `Channel.Unsafe`.
`void`	`write(Object msg, ChannelPromise promise)` Schedules a write operation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty.channel.Channel.Unsafe
connect

- Constructor Detail
  - AbstractUnsafe
```
protected AbstractUnsafe()
```
- Method Detail
  - recvBufAllocHandle
```
public RecvByteBufAllocator.Handle recvBufAllocHandle()
```
    Description copied from interface: Channel.Unsafe
    
    Return the assigned RecvByteBufAllocator.Handle which will be used to allocate ByteBuf's when receiving data.
    
    Specified by:
    
    recvBufAllocHandle in interface Channel.Unsafe
  - outboundBuffer
```
public final ChannelOutboundBuffer outboundBuffer()
```
    Description copied from interface: Channel.Unsafe
    
    Returns the ChannelOutboundBuffer of the Channel where the pending write requests are stored.
    
    Specified by:
    
    outboundBuffer in interface Channel.Unsafe
  - localAddress
```
public final SocketAddress localAddress()
```
    Description copied from interface: Channel.Unsafe
    
    Return the SocketAddress to which is bound local or null if none.
    
    Specified by:
    
    localAddress in interface Channel.Unsafe
  - remoteAddress
```
public final SocketAddress remoteAddress()
```
    Description copied from interface: Channel.Unsafe
    
    Return the SocketAddress to which is bound remote or null if none is bound yet.
    
    Specified by:
    
    remoteAddress in interface Channel.Unsafe
  - register
```
public final void register(EventLoop eventLoop,
                           ChannelPromise promise)
```
    Description copied from interface: Channel.Unsafe
    
    Register the Channel of the ChannelPromise and notify the ChannelFuture once the registration was complete.
    
    Specified by:
    
    register in interface Channel.Unsafe
  - bind
```
public final void bind(SocketAddress localAddress,
                       ChannelPromise promise)
```
    Description copied from interface: Channel.Unsafe
    
    Bind the SocketAddress to the Channel of the ChannelPromise and notify it once its done.
    
    Specified by:
    
    bind in interface Channel.Unsafe
  - disconnect
```
public final void disconnect(ChannelPromise promise)
```
    Description copied from interface: Channel.Unsafe
    
    Disconnect the Channel of the ChannelFuture and notify the ChannelPromise once the operation was complete.
    
    Specified by:
    
    disconnect in interface Channel.Unsafe
  - close
```
public void close(ChannelPromise promise)
```
    Description copied from interface: Channel.Unsafe
    
    Close the Channel of the ChannelPromise and notify the ChannelPromise once the operation was complete.
    
    Specified by:
    
    close in interface Channel.Unsafe
  - shutdownOutput
```
public final void shutdownOutput(ChannelPromise promise)
```
    Shutdown the output portion of the corresponding Channel. For example this will clean up the ChannelOutboundBuffer and not allow any more writes.
  - closeForcibly
```
public final void closeForcibly()
```
    Description copied from interface: Channel.Unsafe
    
    Closes the Channel immediately without firing any events. Probably only useful when registration attempt failed.
    
    Specified by:
    
    closeForcibly in interface Channel.Unsafe
  - deregister
```
public final void deregister(ChannelPromise promise)
```
    Description copied from interface: Channel.Unsafe
    
    Deregister the Channel of the ChannelPromise from EventLoop and notify the ChannelPromise once the operation was complete.
    
    Specified by:
    
    deregister in interface Channel.Unsafe
  - beginRead
```
public final void beginRead()
```
    Description copied from interface: Channel.Unsafe
    
    Schedules a read operation that fills the inbound buffer of the first ChannelInboundHandler in the ChannelPipeline. If there's already a pending read operation, this method does nothing.
    
    Specified by:
    
    beginRead in interface Channel.Unsafe
  - write
```
public final void write(Object msg,
                        ChannelPromise promise)
```
    Description copied from interface: Channel.Unsafe
    
    Schedules a write operation.
    
    Specified by:
    
    write in interface Channel.Unsafe
  - flush
```
public final void flush()
```
    Description copied from interface: Channel.Unsafe
    
    Flush out all write operations scheduled via Channel.Unsafe.write(Object, ChannelPromise).
    
    Specified by:
    
    flush in interface Channel.Unsafe
  - flush0
```
protected void flush0()
```
  - handleWriteError
```
protected final void handleWriteError(Throwable t)
```
  - voidPromise
```
public final ChannelPromise voidPromise()
```
    Description copied from interface: Channel.Unsafe
    
    Return a special ChannelPromise which can be reused and passed to the operations in Channel.Unsafe. It will never be notified of a success or error and so is only a placeholder for operations that take a ChannelPromise as argument but for which you not want to get notified.
    
    Specified by:
    
    voidPromise in interface Channel.Unsafe
  - ensureOpen
```
protected final boolean ensureOpen(ChannelPromise promise)
```
  - safeSetSuccess
```
protected final void safeSetSuccess(ChannelPromise promise)
```
    Marks the specified promise as success. If the promise is done already, log a message.
  - safeSetFailure
```
protected final void safeSetFailure(ChannelPromise promise,
                                    Throwable cause)
```
    Marks the specified promise as failure. If the promise is done already, log a message.
  - closeIfClosed
```
protected final void closeIfClosed()
```
  - annotateConnectException
```
protected final Throwable annotateConnectException(Throwable cause,
                                                   SocketAddress remoteAddress)
```
    Appends the remote address to the message of the exceptions caused by connection attempt failure.
  - prepareToClose
```
protected Executor prepareToClose()
```
    Prepares to close the Channel. If this method returns an Executor, the caller must call the Executor.execute(Runnable) method with a task that calls AbstractChannel.doClose() on the returned Executor. If this method returns null, AbstractChannel.doClose() must be called from the caller thread. (i.e. EventLoop)

Class AbstractChannel.AbstractUnsafe

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.Channel.Unsafe

Constructor Detail

AbstractUnsafe

Method Detail

recvBufAllocHandle

outboundBuffer

localAddress

remoteAddress

register

bind

disconnect

close

shutdownOutput

closeForcibly

deregister

beginRead

write

flush

flush0

handleWriteError

voidPromise

ensureOpen

safeSetSuccess

safeSetFailure

closeIfClosed

annotateConnectException

prepareToClose