NioSocketChannel (TiKV Java Client 3.3.0-SNAPSHOT API)

java.lang.Object
- io.netty.util.DefaultAttributeMap
- - io.netty.channel.AbstractChannel
  - - io.netty.channel.nio.AbstractNioChannel
    - - io.netty.channel.nio.AbstractNioByteChannel
      - io.netty.channel.socket.nio.NioSocketChannel

All Implemented Interfaces:

io.netty.channel.Channel, io.netty.channel.ChannelOutboundInvoker, io.netty.channel.socket.DuplexChannel, io.netty.channel.socket.SocketChannel, io.netty.util.AttributeMap, Comparable<io.netty.channel.Channel>
```
public class NioSocketChannel
extends io.netty.channel.nio.AbstractNioByteChannel
implements io.netty.channel.socket.SocketChannel
```
SocketChannel which uses NIO selector based implementation.

Nested Class Summary
- Nested classes/interfaces inherited from class io.netty.channel.nio.AbstractNioByteChannel
  io.netty.channel.nio.AbstractNioByteChannel.NioByteUnsafe
- Nested classes/interfaces inherited from class io.netty.channel.nio.AbstractNioChannel
  io.netty.channel.nio.AbstractNioChannel.AbstractNioUnsafe, io.netty.channel.nio.AbstractNioChannel.NioUnsafe
- Nested classes/interfaces inherited from class io.netty.channel.AbstractChannel
  io.netty.channel.AbstractChannel.AbstractUnsafe
- Nested classes/interfaces inherited from interface io.netty.channel.Channel
  io.netty.channel.Channel.Unsafe

Field Summary

Fields
Modifier and Type	Field and Description
`static io.prometheus.client.Histogram`	`socketReadBytes`
`static io.prometheus.client.Histogram`	`socketReadDuration`
`static io.prometheus.client.Histogram`	`socketReadLeftBytes`
`static io.prometheus.client.Histogram`	`socketWriteBytes`
`static io.prometheus.client.Histogram`	`socketWriteDuration`
`static io.prometheus.client.Histogram`	`socketWriteLeftBytes`
`static io.prometheus.client.Histogram`	`socketWrittenBytes`

Fields inherited from class io.netty.channel.nio.AbstractNioChannel
readInterestOp

Constructor Summary

Constructors
Constructor and Description
`NioSocketChannel()` Create a new instance
`NioSocketChannel(io.netty.channel.Channel parent, SocketChannel socket)` Create a new instance
`NioSocketChannel(SelectorProvider provider)` Create a new instance using the given `SelectorProvider`.
`NioSocketChannel(SocketChannel socket)` Create a new instance using the given `SocketChannel`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`io.netty.channel.socket.SocketChannelConfig`	`config()`
`protected void`	`doBind(SocketAddress localAddress)`
`protected void`	`doClose()`
`protected boolean`	`doConnect(SocketAddress remoteAddress, SocketAddress localAddress)`
`protected void`	`doDisconnect()`
`protected void`	`doFinishConnect()`
`protected int`	`doReadBytes(io.netty.buffer.ByteBuf byteBuf)`
`protected void`	`doShutdownOutput()`
`protected void`	`doWrite(io.netty.channel.ChannelOutboundBuffer in)`
`protected int`	`doWriteBytes(io.netty.buffer.ByteBuf buf)`
`protected long`	`doWriteFileRegion(io.netty.channel.FileRegion region)`
`boolean`	`isActive()`
`boolean`	`isInputShutdown()`
`protected boolean`	`isInputShutdown0()`
`boolean`	`isOutputShutdown()`
`boolean`	`isShutdown()`
`protected SocketChannel`	`javaChannel()`
`InetSocketAddress`	`localAddress()`
`protected SocketAddress`	`localAddress0()`
`protected io.netty.channel.nio.AbstractNioChannel.AbstractNioUnsafe`	`newUnsafe()`
`io.netty.channel.socket.ServerSocketChannel`	`parent()`
`InetSocketAddress`	`remoteAddress()`
`protected SocketAddress`	`remoteAddress0()`
`io.netty.channel.ChannelFuture`	`shutdown()`
`io.netty.channel.ChannelFuture`	`shutdown(io.netty.channel.ChannelPromise promise)`
`io.netty.channel.ChannelFuture`	`shutdownInput()`
`io.netty.channel.ChannelFuture`	`shutdownInput(io.netty.channel.ChannelPromise promise)`
`io.netty.channel.ChannelFuture`	`shutdownOutput()`
`io.netty.channel.ChannelFuture`	`shutdownOutput(io.netty.channel.ChannelPromise promise)`

Methods inherited from class io.netty.channel.nio.AbstractNioByteChannel
clearOpWrite, doWrite0, filterOutboundMessage, incompleteWrite, metadata, setOpWrite

Methods inherited from class io.netty.channel.nio.AbstractNioChannel
clearReadPending, doBeginRead, doDeregister, doRegister, eventLoop, isCompatible, isOpen, isReadPending, newDirectBuffer, newDirectBuffer, selectionKey, setReadPending, unsafe

Methods inherited from class io.netty.channel.AbstractChannel
alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, equals, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, pipeline, read, toString, validateFileRegion, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from class io.netty.util.DefaultAttributeMap
attr, hasAttr

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

Methods inherited from interface io.netty.channel.Channel
alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, flush, id, isOpen, isRegistered, isWritable, metadata, pipeline, read, unsafe

Methods inherited from interface io.netty.util.AttributeMap
attr, hasAttr

Methods inherited from interface io.netty.channel.ChannelOutboundInvoker
bind, bind, close, close, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface java.lang.Comparable
compareTo

- Field Detail
  - socketWriteDuration
```
public static final io.prometheus.client.Histogram socketWriteDuration
```
  - socketWriteBytes
```
public static final io.prometheus.client.Histogram socketWriteBytes
```
  - socketWrittenBytes
```
public static final io.prometheus.client.Histogram socketWrittenBytes
```
  - socketWriteLeftBytes
```
public static final io.prometheus.client.Histogram socketWriteLeftBytes
```
  - socketReadDuration
```
public static final io.prometheus.client.Histogram socketReadDuration
```
  - socketReadBytes
```
public static final io.prometheus.client.Histogram socketReadBytes
```
  - socketReadLeftBytes
```
public static final io.prometheus.client.Histogram socketReadLeftBytes
```
- Constructor Detail
  - NioSocketChannel
```
public NioSocketChannel()
```
    Create a new instance
  - NioSocketChannel
```
public NioSocketChannel(SelectorProvider provider)
```
    Create a new instance using the given SelectorProvider.
  - NioSocketChannel
```
public NioSocketChannel(SocketChannel socket)
```
    Create a new instance using the given SocketChannel.
  - NioSocketChannel
```
public NioSocketChannel(io.netty.channel.Channel parent,
                        SocketChannel socket)
```
    Create a new instance
    
    Parameters:
    
    parent - the Channel which created this instance or null if it was created by the user
    
    socket - the SocketChannel which will be used
- Method Detail
  - parent
```
public io.netty.channel.socket.ServerSocketChannel parent()
```
    Specified by:
    
    parent in interface io.netty.channel.Channel
    
    Specified by:
    
    parent in interface io.netty.channel.socket.SocketChannel
    
    Overrides:
    
    parent in class io.netty.channel.AbstractChannel
  - config
```
public io.netty.channel.socket.SocketChannelConfig config()
```
    Specified by:
    
    config in interface io.netty.channel.Channel
    
    Specified by:
    
    config in interface io.netty.channel.socket.SocketChannel
  - javaChannel
```
protected SocketChannel javaChannel()
```
    Overrides:
    
    javaChannel in class io.netty.channel.nio.AbstractNioChannel
  - isActive
```
public boolean isActive()
```
    Specified by:
    
    isActive in interface io.netty.channel.Channel
  - isOutputShutdown
```
public boolean isOutputShutdown()
```
    Specified by:
    
    isOutputShutdown in interface io.netty.channel.socket.DuplexChannel
  - isInputShutdown
```
public boolean isInputShutdown()
```
    Specified by:
    
    isInputShutdown in interface io.netty.channel.socket.DuplexChannel
  - isShutdown
```
public boolean isShutdown()
```
    Specified by:
    
    isShutdown in interface io.netty.channel.socket.DuplexChannel
  - localAddress
```
public InetSocketAddress localAddress()
```
    Specified by:
    
    localAddress in interface io.netty.channel.Channel
    
    Specified by:
    
    localAddress in interface io.netty.channel.socket.SocketChannel
    
    Overrides:
    
    localAddress in class io.netty.channel.AbstractChannel
  - remoteAddress
```
public InetSocketAddress remoteAddress()
```
    Specified by:
    
    remoteAddress in interface io.netty.channel.Channel
    
    Specified by:
    
    remoteAddress in interface io.netty.channel.socket.SocketChannel
    
    Overrides:
    
    remoteAddress in class io.netty.channel.AbstractChannel
  - doShutdownOutput
```
@UnstableApi
protected final void doShutdownOutput()
                                            throws Exception
```
    Overrides:
    
    doShutdownOutput in class io.netty.channel.AbstractChannel
    
    Throws:
    
    Exception
  - shutdownOutput
```
public io.netty.channel.ChannelFuture shutdownOutput()
```
    Specified by:
    
    shutdownOutput in interface io.netty.channel.socket.DuplexChannel
  - shutdownOutput
```
public io.netty.channel.ChannelFuture shutdownOutput(io.netty.channel.ChannelPromise promise)
```
    Specified by:
    
    shutdownOutput in interface io.netty.channel.socket.DuplexChannel
  - shutdownInput
```
public io.netty.channel.ChannelFuture shutdownInput()
```
    Specified by:
    
    shutdownInput in interface io.netty.channel.socket.DuplexChannel
    
    Specified by:
    
    shutdownInput in class io.netty.channel.nio.AbstractNioByteChannel
  - isInputShutdown0
```
protected boolean isInputShutdown0()
```
    Overrides:
    
    isInputShutdown0 in class io.netty.channel.nio.AbstractNioByteChannel
  - shutdownInput
```
public io.netty.channel.ChannelFuture shutdownInput(io.netty.channel.ChannelPromise promise)
```
    Specified by:
    
    shutdownInput in interface io.netty.channel.socket.DuplexChannel
  - shutdown
```
public io.netty.channel.ChannelFuture shutdown()
```
    Specified by:
    
    shutdown in interface io.netty.channel.socket.DuplexChannel
  - shutdown
```
public io.netty.channel.ChannelFuture shutdown(io.netty.channel.ChannelPromise promise)
```
    Specified by:
    
    shutdown in interface io.netty.channel.socket.DuplexChannel
  - localAddress0
```
protected SocketAddress localAddress0()
```
    Specified by:
    
    localAddress0 in class io.netty.channel.AbstractChannel
  - remoteAddress0
```
protected SocketAddress remoteAddress0()
```
    Specified by:
    
    remoteAddress0 in class io.netty.channel.AbstractChannel
  - doBind
```
protected void doBind(SocketAddress localAddress)
               throws Exception
```
    Specified by:
    
    doBind in class io.netty.channel.AbstractChannel
    
    Throws:
    
    Exception
  - doConnect
```
protected boolean doConnect(SocketAddress remoteAddress,
                            SocketAddress localAddress)
                     throws Exception
```
    Specified by:
    
    doConnect in class io.netty.channel.nio.AbstractNioChannel
    
    Throws:
    
    Exception
  - doFinishConnect
```
protected void doFinishConnect()
                        throws Exception
```
    Specified by:
    
    doFinishConnect in class io.netty.channel.nio.AbstractNioChannel
    
    Throws:
    
    Exception
  - doDisconnect
```
protected void doDisconnect()
                     throws Exception
```
    Specified by:
    
    doDisconnect in class io.netty.channel.AbstractChannel
    
    Throws:
    
    Exception
  - doClose
```
protected void doClose()
                throws Exception
```
    Overrides:
    
    doClose in class io.netty.channel.nio.AbstractNioChannel
    
    Throws:
    
    Exception
  - doReadBytes
```
protected int doReadBytes(io.netty.buffer.ByteBuf byteBuf)
                   throws Exception
```
    Specified by:
    
    doReadBytes in class io.netty.channel.nio.AbstractNioByteChannel
    
    Throws:
    
    Exception
  - doWriteBytes
```
protected int doWriteBytes(io.netty.buffer.ByteBuf buf)
                    throws Exception
```
    Specified by:
    
    doWriteBytes in class io.netty.channel.nio.AbstractNioByteChannel
    
    Throws:
    
    Exception
  - doWriteFileRegion
```
protected long doWriteFileRegion(io.netty.channel.FileRegion region)
                          throws Exception
```
    Specified by:
    
    doWriteFileRegion in class io.netty.channel.nio.AbstractNioByteChannel
    
    Throws:
    
    Exception
  - doWrite
```
protected void doWrite(io.netty.channel.ChannelOutboundBuffer in)
                throws Exception
```
    Overrides:
    
    doWrite in class io.netty.channel.nio.AbstractNioByteChannel
    
    Throws:
    
    Exception
  - newUnsafe
```
protected io.netty.channel.nio.AbstractNioChannel.AbstractNioUnsafe newUnsafe()
```
    Overrides:
    
    newUnsafe in class io.netty.channel.nio.AbstractNioByteChannel

Class NioSocketChannel

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.channel.nio.AbstractNioByteChannel

Nested classes/interfaces inherited from class io.netty.channel.nio.AbstractNioChannel

Nested classes/interfaces inherited from class io.netty.channel.AbstractChannel

Nested classes/interfaces inherited from interface io.netty.channel.Channel

Field Summary

Fields inherited from class io.netty.channel.nio.AbstractNioChannel

Constructor Summary

Method Summary

Methods inherited from class io.netty.channel.nio.AbstractNioByteChannel

Methods inherited from class io.netty.channel.nio.AbstractNioChannel

Methods inherited from class io.netty.channel.AbstractChannel

Methods inherited from class io.netty.util.DefaultAttributeMap

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.Channel

Methods inherited from interface io.netty.util.AttributeMap

Methods inherited from interface io.netty.channel.ChannelOutboundInvoker

Methods inherited from interface java.lang.Comparable

Field Detail

socketWriteDuration

socketWriteBytes

socketWrittenBytes

socketWriteLeftBytes

socketReadDuration

socketReadBytes

socketReadLeftBytes

Constructor Detail

NioSocketChannel

NioSocketChannel

NioSocketChannel

NioSocketChannel

Method Detail

parent

config

javaChannel

isActive

isOutputShutdown

isInputShutdown

isShutdown

localAddress

remoteAddress

doShutdownOutput

shutdownOutput

shutdownOutput

shutdownInput

isInputShutdown0

shutdownInput

shutdown

shutdown

localAddress0

remoteAddress0

doBind

doConnect

doFinishConnect

doDisconnect

doClose

doReadBytes

doWriteBytes

doWriteFileRegion

doWrite

newUnsafe