NetChannel (Neta Core 1.0.1 API)

java.lang.Object
- net.hasor.neta.channel.AttributeChannel<NetChannel>
- - net.hasor.neta.channel.NetChannel

所有已实现的接口:

SoChannel<NetChannel>
```
public class NetChannel
extends AttributeChannel<NetChannel>
```
A tcp network channel the channel that binds to the Application layer network protocol stack.

版本:

: 2023-09-24

作者:

赵永春 (zyc@hasor.net)

字段概要

字段
限定符和类型	字段和说明
`protected net.hasor.neta.channel.SoAsyncChannel`	`channel`
`protected net.hasor.cobble.concurrent.future.Future<NetChannel>`	`closeFuture`
`protected AtomicBoolean`	`closeStatus`
`protected net.hasor.neta.channel.SoContextImpl`	`context`
`protected PipeContextImpl`	`pipeCtx`
`protected Pipeline<ByteBuf>`	`pipeline`
`protected net.hasor.neta.channel.SoSndContext`	`wContext`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`net.hasor.cobble.concurrent.future.Future<NetChannel>`	`close()` close this channel.
`net.hasor.cobble.concurrent.future.Future<NetChannel>`	`closeNow()` close this channel now.
`<T> T`	`findPipeContext(Class<T> serviceType)` Get the attachment for `PipeContext`
`net.hasor.cobble.concurrent.future.Future<NetChannel>`	`flush()` flash
`net.hasor.cobble.concurrent.future.Future<?>`	`flush(String pipeName)` sent data to remote, The network IO transfer operation is performed asynchronously.
`long`	`getChannelID()` channel id
`SoContext`	`getContext()` get context
`long`	`getCreatedTime()` channel accept time
`long`	`getLastActiveTime()` The last time data was received or sent
`long`	`getLastRcvTime()` last received data time
`long`	`getLastSndTime()` last sent data time
`SocketAddress`	`getLocalAddr()` local `SocketAddress`
`int`	`getRcvBufferSize()` Returns the received buffer size.
`int`	`getRcvBufferUsed()` Returns the size of the received buffer used.
`long`	`getRcvBytes()` Number of bytes received
`SoHandlerStatus`	`getRcvHandlerStatus()` Returns the receiving Handler state
`int`	`getRcvSlotSize()` Returns the number of pipeline received slots.
`SocketAddress`	`getRemoteAddr()` get remote address of the channel
`int`	`getSndBufferSize()` Returns the send buffer size.
`int`	`getSndBufferUsed()` Returns the size of the send buffer used.
`long`	`getSndBytes()` Number of bytes send
`SoHandlerStatus`	`getSndHandlerStatus()` Returns the send Handler state
`int`	`getSndSlotSize()` Returns the number of pipeline send slots.
`NetListen`	`getSource()` Returns the `NetListen` that accepts this channel
`void`	`ignoreReadEofFlag()` When shutdownOutput is called remotely, an end of read flag was encountered, which usually means closing the channel.
`protected void`	`initPipe(PipeContextImpl pipeContext, Pipeline<?> pipeline)`
`boolean`	`isClient()` a connect `NetChannel`
`boolean`	`isClose()` return close status.
`boolean`	`isListen()` a `NetListen`
`boolean`	`isServer()` an accept `NetChannel`
`boolean`	`isShutdownInput()` Returns whether the read channel is closed.
`boolean`	`isShutdownOutput()` Returns whether the write channel is closed.
`net.hasor.cobble.concurrent.future.Future<?>`	`sendData(Object writeData)` sent data to remote, The network IO transfer operation is performed asynchronously.
`net.hasor.cobble.concurrent.future.Future<NetChannel>`	`sendData(Object writeData, String pipeName)` sent data to remote, The network IO transfer operation is performed asynchronously.
`void`	`setReadTimeout()` Sets a timer that will fire readTimeout if no network data is received within a specified amount of time.
`void`	`setReadTimeout(int timeout, TimeUnit unit)` Sets a timer that will fire readTimeout if no network data is received within a specified amount of time.
`void`	`shutdownInput()` Shutdown the connection for reading without closing the channel.
`void`	`shutdownOutput()` Shutdown the connection for write without closing the channel.
`void`	`waitReceive()` expect new data to be received within SoReadTimeoutMs
`void`	`waitReceive(int timeout, TimeUnit unit)` expect new data to be received within timeout.

从类继承的方法 net.hasor.neta.channel.AttributeChannel
getAttribute, setAttribute

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - channel
```
protected final net.hasor.neta.channel.SoAsyncChannel channel
```
  - wContext
```
protected final net.hasor.neta.channel.SoSndContext wContext
```
  - context
```
protected final net.hasor.neta.channel.SoContextImpl context
```
  - pipeCtx
```
protected PipeContextImpl pipeCtx
```
  - pipeline
```
protected Pipeline<ByteBuf> pipeline
```
  - closeStatus
```
protected final AtomicBoolean closeStatus
```
  - closeFuture
```
protected final net.hasor.cobble.concurrent.future.Future<NetChannel> closeFuture
```
- 方法详细资料
  - initPipe
```
protected void initPipe(PipeContextImpl pipeContext,
                        Pipeline<?> pipeline)
```
  - getChannelID
```
public long getChannelID()
```
    从接口复制的说明: SoChannel
    
    channel id
  - isListen
```
public boolean isListen()
```
    从接口复制的说明: SoChannel
    
    a NetListen
  - getCreatedTime
```
public long getCreatedTime()
```
    从接口复制的说明: SoChannel
    
    channel accept time
  - getLastActiveTime
```
public long getLastActiveTime()
```
    从接口复制的说明: SoChannel
    
    The last time data was received or sent
  - getLastSndTime
```
public long getLastSndTime()
```
    last sent data time
  - getLastRcvTime
```
public long getLastRcvTime()
```
    last received data time
  - isServer
```
public boolean isServer()
```
    从接口复制的说明: SoChannel
    
    an accept NetChannel
  - isClient
```
public boolean isClient()
```
    从接口复制的说明: SoChannel
    
    a connect NetChannel
  - isShutdownInput
```
public boolean isShutdownInput()
```
    Returns whether the read channel is closed.
  - ignoreReadEofFlag
```
public void ignoreReadEofFlag()
```
    When shutdownOutput is called remotely, an end of read flag was encountered, which usually means closing the channel. But the remote still has the ability to receive data.
    
    so use ignoreReadEofFlag() method, keep the channel state and continue to send data
    
    Once ignoreReadEofFlag() is activated, the release of remote connections needs to be managed manually, leading to NetChannel leakage if not released in time
  - shutdownInput
```
public void shutdownInput()
```
    Shutdown the connection for reading without closing the channel.
  - getRcvHandlerStatus
```
public SoHandlerStatus getRcvHandlerStatus()
```
    Returns the receiving Handler state
  - isShutdownOutput
```
public boolean isShutdownOutput()
```
    Returns whether the write channel is closed.
  - shutdownOutput
```
public void shutdownOutput()
```
    Shutdown the connection for write without closing the channel.
  - getSndHandlerStatus
```
public SoHandlerStatus getSndHandlerStatus()
```
    Returns the send Handler state
  - getLocalAddr
```
public SocketAddress getLocalAddr()
```
    从接口复制的说明: SoChannel
    
    local SocketAddress
  - getRemoteAddr
```
public SocketAddress getRemoteAddr()
```
    从接口复制的说明: SoChannel
    
    get remote address of the channel
  - getContext
```
public SoContext getContext()
```
    从接口复制的说明: SoChannel
    
    get context
  - findPipeContext
```
public <T> T findPipeContext(Class<T> serviceType)
```
    从接口复制的说明: SoChannel
    
    Get the attachment for PipeContext
  - getSource
```
public NetListen getSource()
```
    Returns the NetListen that accepts this channel
  - isClose
```
public boolean isClose()
```
    从接口复制的说明: SoChannel
    
    return close status.
  - close
```
public net.hasor.cobble.concurrent.future.Future<NetChannel> close()
```
    从接口复制的说明: SoChannel
    
    close this channel.
  - For the Listen channel, listening is turned off.
  - For the Socket channel, will be closed after all data are written.

closeNow

public net.hasor.cobble.concurrent.future.Future<NetChannel> closeNow()

从接口复制的说明: SoChannel

close this channel now.

getRcvBytes
```
public long getRcvBytes()
```
Number of bytes received

getSndBytes
```
public long getSndBytes()
```
Number of bytes send

getRcvBufferSize
```
public int getRcvBufferSize()
```
Returns the received buffer size.

getSndBufferSize
```
public int getSndBufferSize()
```
Returns the send buffer size.

getRcvBufferUsed
```
public int getRcvBufferUsed()
```
Returns the size of the received buffer used.

getSndBufferUsed
```
public int getSndBufferUsed()
```
Returns the size of the send buffer used.

getRcvSlotSize
```
public int getRcvSlotSize()
```
Returns the number of pipeline received slots.

getSndSlotSize
```
public int getSndSlotSize()
```
Returns the number of pipeline send slots.

sendData
```
public net.hasor.cobble.concurrent.future.Future<?> sendData(Object writeData)
```
sent data to remote, The network IO transfer operation is performed asynchronously.
data goes through the application layer network protocol stack

sendData

public net.hasor.cobble.concurrent.future.Future<NetChannel> sendData(Object writeData,
                                                                      String pipeName)

sent data to remote, The network IO transfer operation is performed asynchronously.

data goes through the application layer network protocol stack

flush

public net.hasor.cobble.concurrent.future.Future<NetChannel> flush()

flash

flush
```
public net.hasor.cobble.concurrent.future.Future<?> flush(String pipeName)
```
sent data to remote, The network IO transfer operation is performed asynchronously.
data goes through the application layer network protocol stack

setReadTimeout
```
public void setReadTimeout()
```
Sets a timer that will fire readTimeout if no network data is received within a specified amount of time.

另请参阅:

SoConfig.getSoReadTimeoutMs()

setReadTimeout
```
public void setReadTimeout(int timeout,
                           TimeUnit unit)
```
Sets a timer that will fire readTimeout if no network data is received within a specified amount of time.

waitReceive
```
public void waitReceive()
                 throws InterruptedException,
                        SoReadTimeoutException
```
expect new data to be received within SoReadTimeoutMs

抛出:

InterruptedException

SoReadTimeoutException

另请参阅:

SoConfig.getSoReadTimeoutMs()

waitReceive

public void waitReceive(int timeout,
                        TimeUnit unit)
                 throws InterruptedException,
                        SoReadTimeoutException

expect new data to be received within timeout.

抛出:: InterruptedException; SoReadTimeoutException
另请参阅:: SoConfig.getSoReadTimeoutMs()

类 NetChannel

字段概要

方法概要

从类继承的方法 net.hasor.neta.channel.AttributeChannel

从类继承的方法 java.lang.Object

字段详细资料

channel

wContext

context

pipeCtx

pipeline

closeStatus

closeFuture

方法详细资料

initPipe

getChannelID

isListen

getCreatedTime

getLastActiveTime

getLastSndTime

getLastRcvTime

isServer

isClient

isShutdownInput

ignoreReadEofFlag

shutdownInput

getRcvHandlerStatus

isShutdownOutput

shutdownOutput

getSndHandlerStatus

getLocalAddr

getRemoteAddr

getContext

findPipeContext

getSource

isClose

close

closeNow

getRcvBytes

getSndBytes

getRcvBufferSize

getSndBufferSize

getRcvBufferUsed

getSndBufferUsed

getRcvSlotSize

getSndSlotSize

sendData

sendData

flush

flush

setReadTimeout

setReadTimeout

waitReceive

waitReceive