EmbeddedChannel (Neta Core 1.0.3 API)

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

所有已实现的接口:

NetDuplexChannel<EmbeddedChannel>, SoChannel<EmbeddedChannel>
```
public class EmbeddedChannel
extends AttributeChannel<EmbeddedChannel>
implements NetDuplexChannel<EmbeddedChannel>
```
Base class for SoChannel implementations that are used in an embedded fashion.

版本:

: 2023-09-24

作者:

赵永春 (zyc@hasor.net)

字段概要

字段
限定符和类型字段和说明

protected PipeContext pipeCtx

protected Pipeline<?> pipeline

字段
限定符和类型	字段和说明
`protected PipeContext`	`pipeCtx`
`protected Pipeline<?>`	`pipeline`

构造器概要

构造器
构造器和说明

EmbeddedChannel(boolean asServer, EmbeddedInitializer initializer, EmbeddedSoContext context)

构造器
构造器和说明
`EmbeddedChannel(boolean asServer, EmbeddedInitializer initializer, EmbeddedSoContext context)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`clearRcvError()` Clear the RcvError status.
`void`	`clearSndError()` Clear the SndError status.
`net.hasor.cobble.concurrent.future.Future<EmbeddedChannel>`	`close()` close this channel.
`net.hasor.cobble.concurrent.future.Future<EmbeddedChannel>`	`closeNow()` close this channel now.
`<T> T`	`findPipeContext(Class<T> serviceType)` Get the attachment for `PipeContext`
`long`	`getChannelID()` channel id
`SoContext`	`getContext()` get context
`long`	`getCreatedTime()` channel accept time
`long`	`getLastActiveTime()` The last time data was received or sent
`SocketAddress`	`getLocalAddr()` local `SocketAddress`
`PipeStatistical`	`getPipeStatistical()` Get protocol stack statistics
`Throwable`	`getRcvError()` Get the possible received data protocol layer error
`int`	`getRcvSize()` read messages limit from the RCV_DOWN of this `SoChannel`.
`SocketAddress`	`getRemoteAddr()` get remote address of the channel
`Throwable`	`getSndError()` Get the possible send data protocol layer error
`int`	`getSndSize()` read messages limit from the SND_DOWN of this `SoChannel`.
`boolean`	`hasRcvError()` Receive data protocol layer error
`boolean`	`hasSndError()` send data protocol layer error
`void`	`ignoreReadEofFlag()` When shutdownOutput is called remotely, an end of read flag was encountered, which usually means closing the channel.
`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.
`void`	`printStackTrace()` Prints this pipline status and its backtrace to the System.out.
`void`	`printStackTrace(PrintStream s)` Prints this pipline status and its backtrace to the specified print stream.
`Object`	`readRcv()` read messages from the RCV_DOWN of this `SoChannel`.
`Object[]`	`readRcvArray()` read messages from the RCV_DOWN of this `SoChannel`.
`Object`	`readSnd()` read messages from the SND_DOWN of this `SoChannel`.
`Object[]`	`readSndArray(int readSize)` read messages from the SND_DOWN of this `SoChannel`.
`void`	`receive(Object... object)` Write messages to the RCV_UP of this `SoChannel`.
`void`	`receiveError(String pipeName, Throwable e)` Write error to the RCV_UP of this `SoChannel`, the message will only be sent to the specific protocol layer
`void`	`receiveError(Throwable e)` Write error to the RCV_UP of this `SoChannel`.
`void`	`receiveTo(String pipeName, Object... object)` Write messages to the RCV_UP of this `SoChannel`, the message will only be sent to the specific protocol layer
`void`	`send(Object... object)` Write messages to the SND_UP of this `SoChannel`.
`void`	`sendError(String pipeName, Throwable e)` Write error to the SND_UP of this `SoChannel`, the message will only be sent to the specific protocol layer
`void`	`sendError(Throwable e)` Write error to the SND_UP of this `SoChannel`.
`void`	`sendTo(String pipeName, Object... object)` Write messages to the SND_UP of this `SoChannel`, the message will only be sent to the specific protocol layer
`void`	`shutdownInput()` Shutdown the connection for reading without closing the channel.
`void`	`shutdownOutput()` Shutdown the connection for write without closing the channel.

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

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

从接口继承的方法 net.hasor.neta.channel.SoChannel
getAttribute, setAttribute

- 字段详细资料
  - pipeCtx
```
protected final PipeContext pipeCtx
```
  - pipeline
```
protected final Pipeline<?> pipeline
```
- 构造器详细资料
  - EmbeddedChannel
```
public EmbeddedChannel(boolean asServer,
                       EmbeddedInitializer initializer,
                       EmbeddedSoContext context)
```
- 方法详细资料
  - getChannelID
```
public long getChannelID()
```
    从接口复制的说明: SoChannel
    
    channel id
    
    指定者:
    
    getChannelID 在接口中 SoChannel<EmbeddedChannel>
  - getCreatedTime
```
public long getCreatedTime()
```
    从接口复制的说明: SoChannel
    
    channel accept time
    
    指定者:
    
    getCreatedTime 在接口中 SoChannel<EmbeddedChannel>
  - getLastActiveTime
```
public long getLastActiveTime()
```
    从接口复制的说明: SoChannel
    
    The last time data was received or sent
    
    指定者:
    
    getLastActiveTime 在接口中 SoChannel<EmbeddedChannel>
  - isListen
```
public boolean isListen()
```
    从接口复制的说明: SoChannel
    
    a NetListen
    
    指定者:
    
    isListen 在接口中 SoChannel<EmbeddedChannel>
  - isServer
```
public boolean isServer()
```
    从接口复制的说明: SoChannel
    
    an accept NetChannel
    
    指定者:
    
    isServer 在接口中 SoChannel<EmbeddedChannel>
  - isClient
```
public boolean isClient()
```
    从接口复制的说明: SoChannel
    
    a connect NetChannel
    
    指定者:
    
    isClient 在接口中 SoChannel<EmbeddedChannel>
  - getLocalAddr
```
public SocketAddress getLocalAddr()
```
    从接口复制的说明: SoChannel
    
    local SocketAddress
    
    指定者:
    
    getLocalAddr 在接口中 SoChannel<EmbeddedChannel>
  - getRemoteAddr
```
public SocketAddress getRemoteAddr()
```
    从接口复制的说明: SoChannel
    
    get remote address of the channel
    
    指定者:
    
    getRemoteAddr 在接口中 SoChannel<EmbeddedChannel>
  - getContext
```
public SoContext getContext()
```
    从接口复制的说明: SoChannel
    
    get context
    
    指定者:
    
    getContext 在接口中 SoChannel<EmbeddedChannel>
  - findPipeContext
```
public <T> T findPipeContext(Class<T> serviceType)
```
    从接口复制的说明: SoChannel
    
    Get the attachment for PipeContext
    
    指定者:
    
    findPipeContext 在接口中 SoChannel<EmbeddedChannel>
  - close
```
public net.hasor.cobble.concurrent.future.Future<EmbeddedChannel> 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.

指定者:: close 在接口中 SoChannel<EmbeddedChannel>

closeNow
```
public net.hasor.cobble.concurrent.future.Future<EmbeddedChannel> closeNow()
```
从接口复制的说明: SoChannel

close this channel now.

指定者:

closeNow 在接口中 SoChannel<EmbeddedChannel>

isClose
```
public boolean isClose()
```
从接口复制的说明: SoChannel

return close status.

指定者:

isClose 在接口中 SoChannel<EmbeddedChannel>

isShutdownInput
```
public boolean isShutdownInput()
```
从接口复制的说明: NetDuplexChannel

Returns whether the read channel is closed.

指定者:

isShutdownInput 在接口中 NetDuplexChannel<EmbeddedChannel>

shutdownInput
```
public void shutdownInput()
```
从接口复制的说明: NetDuplexChannel

Shutdown the connection for reading without closing the channel.

指定者:

shutdownInput 在接口中 NetDuplexChannel<EmbeddedChannel>

ignoreReadEofFlag
```
public void ignoreReadEofFlag()
```
从接口复制的说明: NetDuplexChannel

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 NetDuplexChannel.ignoreReadEofFlag() method, keep the channel state and continue to send data

Once NetDuplexChannel.ignoreReadEofFlag() is activated, the release of remote connections needs to be managed manually, leading to NetChannel leakage if not released in time

指定者:

ignoreReadEofFlag 在接口中 NetDuplexChannel<EmbeddedChannel>

isShutdownOutput
```
public boolean isShutdownOutput()
```
从接口复制的说明: NetDuplexChannel

Returns whether the write channel is closed.

指定者:

isShutdownOutput 在接口中 NetDuplexChannel<EmbeddedChannel>

shutdownOutput
```
public void shutdownOutput()
```
从接口复制的说明: NetDuplexChannel

Shutdown the connection for write without closing the channel.

指定者:

shutdownOutput 在接口中 NetDuplexChannel<EmbeddedChannel>

getPipeStatistical

public PipeStatistical getPipeStatistical()

Get protocol stack statistics

receive
```
public void receive(Object... object)
```
Write messages to the RCV_UP of this SoChannel.

参数:

object - the messages to be written

receiveTo
```
public void receiveTo(String pipeName,
                      Object... object)
```
Write messages to the RCV_UP of this SoChannel, the message will only be sent to the specific protocol layer

参数:

pipeName - specific protocol layer

object - the messages to be written

receiveError
```
public void receiveError(Throwable e)
```
Write error to the RCV_UP of this SoChannel.

参数:

e - the messages to be written

receiveError
```
public void receiveError(String pipeName,
                         Throwable e)
```
Write error to the RCV_UP of this SoChannel, the message will only be sent to the specific protocol layer

参数:

e - the messages to be written

readRcv
```
public Object readRcv()
```
read messages from the RCV_DOWN of this SoChannel.

readRcvArray
```
public Object[] readRcvArray()
```
read messages from the RCV_DOWN of this SoChannel.

getRcvSize
```
public int getRcvSize()
```
read messages limit from the RCV_DOWN of this SoChannel.

hasRcvError
```
public boolean hasRcvError()
```
Receive data protocol layer error

getRcvError
```
public Throwable getRcvError()
```
Get the possible received data protocol layer error

clearRcvError
```
public void clearRcvError()
```
Clear the RcvError status.

send
```
public void send(Object... object)
```
Write messages to the SND_UP of this SoChannel.

参数:

object - the messages to be written

sendTo
```
public void sendTo(String pipeName,
                   Object... object)
```
Write messages to the SND_UP of this SoChannel, the message will only be sent to the specific protocol layer

参数:

pipeName - specific protocol layer

object - the messages to be written

sendError
```
public void sendError(Throwable e)
```
Write error to the SND_UP of this SoChannel.

参数:

e - the messages to be written

sendError
```
public void sendError(String pipeName,
                      Throwable e)
```
Write error to the SND_UP of this SoChannel, the message will only be sent to the specific protocol layer

参数:

e - the messages to be written

readSnd
```
public Object readSnd()
```
read messages from the SND_DOWN of this SoChannel.

readSndArray
```
public Object[] readSndArray(int readSize)
```
read messages from the SND_DOWN of this SoChannel.

getSndSize
```
public int getSndSize()
```
read messages limit from the SND_DOWN of this SoChannel.

hasSndError
```
public boolean hasSndError()
```
send data protocol layer error

getSndError
```
public Throwable getSndError()
```
Get the possible send data protocol layer error

clearSndError
```
public void clearSndError()
```
Clear the SndError status.

printStackTrace
```
public void printStackTrace()
```
Prints this pipline status and its backtrace to the System.out.

printStackTrace
```
public void printStackTrace(PrintStream s)
```
Prints this pipline status and its backtrace to the specified print stream.

参数:

s - PrintStream to use for output

类 EmbeddedChannel

字段概要

构造器概要

方法概要

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

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

从接口继承的方法 net.hasor.neta.channel.SoChannel

字段详细资料

pipeCtx

pipeline

构造器详细资料

EmbeddedChannel

方法详细资料

getChannelID

getCreatedTime

getLastActiveTime

isListen

isServer

isClient

getLocalAddr

getRemoteAddr

getContext

findPipeContext

close

closeNow

isClose

isShutdownInput

shutdownInput

ignoreReadEofFlag

isShutdownOutput

shutdownOutput

getPipeStatistical

receive

receiveTo

receiveError

receiveError

readRcv

readRcvArray

getRcvSize

hasRcvError

getRcvError

clearRcvError

send

sendTo

sendError

sendError

readSnd

readSndArray

getSndSize

hasSndError

getSndError

clearSndError

printStackTrace

printStackTrace