ChannelContext (mica-net-core 0.1.2 API)

java.lang.Object
- org.tio.utils.prop.MapPropSupport
- - org.tio.core.ChannelContext

所有已实现的接口:

IPropSupport

直接已知子类:

ClientChannelContext, ServerChannelContext
```
public abstract class ChannelContext
extends MapPropSupport
```
作者:

tanyaowu 2017年10月19日上午9:39:46

嵌套类概要

嵌套类
限定符和类型类和说明

static class ChannelContext.CloseCode
连接关闭码

static class ChannelContext.CloseMeta

嵌套类
限定符和类型	类和说明
`static class`	`ChannelContext.CloseCode` 连接关闭码
`static class`	`ChannelContext.CloseMeta`

字段概要

字段
限定符和类型	字段和说明
`AsynchronousSocketChannel`	`asynchronousSocketChannel` The asynchronous socket channel.
`ReentrantReadWriteLock`	`closeLock`
`ChannelContext.CloseMeta`	`closeMeta`
`DecodeRunnable`	`decodeRunnable`
`HandlerRunnable`	`handlerRunnable`
`Long`	`heartbeatTimeout` 此值不设时，心跳时间取org.tio.core.TioConfig.heartbeatTimeout 当然这个值如果小于org.tio.core.TioConfig.heartbeatTimeout，定时检查的时间间隔还是以org.tio.core.TioConfig.heartbeatTimeout为准，只是在判断时用此值
`boolean`	`isClosed`
`boolean`	`isReconnect`
`boolean`	`isRemoved`
`boolean`	`isVirtual`
`boolean`	`isWaitingClose`
`boolean`	`logWhenDecodeError` 解码出现异常时，是否打印异常日志此值默认与org.tio.core.TioConfig.logWhenDecodeError保持一致
`Integer`	`packetNeededLength` 一个packet所需要的字节数（用于应用告诉框架，下一次解码所需要的字节长度，省去冗余解码带来的性能损耗）
`SendRunnable`	`sendRunnable`
`SslFacadeContext`	`sslFacadeContext`
`ChannelStat`	`stat`
`TioConfig`	`tioConfig`
`static String`	`UNKNOWN_ADDRESS_IP`
`static AtomicInteger`	`UNKNOWN_ADDRESS_PORT_SEQ`
`WriteCompletionHandler`	`writeCompletionHandler`

构造器概要

构造器
构造器和说明
`ChannelContext(TioConfig tioConfig)` 创建一个虚拟ChannelContext，主要用来模拟一些操作，譬如压力测试，真实场景中用得少
`ChannelContext(TioConfig tioConfig, AsynchronousSocketChannel asynchronousSocketChannel)`
`ChannelContext(TioConfig tioConfig, String id)` 创建一个虚拟ChannelContext，主要用来模拟一些操作，譬如压力测试，真实场景中用得少

方法概要

所有方法静态方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`protected void`	`assignAnUnknownClientNode()`
`abstract Node`	`createClientNode(AsynchronousSocketChannel asynchronousSocketChannel)` 创建Node
`static Node`	`createUnknownNode()`
`boolean`	`equals(Object obj)`
`String`	`getBsId()`
`Node`	`getClientNode()`
`ChannelContext.CloseCode`	`getCloseCode()`
`Set<String>`	`getGroups()`
`Long`	`getHeartbeatTimeout()`
`String`	`getId()`
`Node`	`getProxyClientNode()`
`int`	`getReadBufferSize()`
`ReadCompletionHandler`	`getReadCompletionHandler()`
`Node`	`getServerNode()`
`TioConfig`	`getTioConfig()`
`String`	`getToken()`
`String`	`getUserId()` 获取用户 id
`WriteCompletionHandler`	`getWriteCompletionHandler()`
`int`	`hashCode()`
`void`	`init(TioConfig tioConfig, AsynchronousSocketChannel asynchronousSocketChannel)`
`abstract boolean`	`isServer()` 是否是服务器端
`void`	`processAfterSent(Packet packet, boolean isSentSuccess)`
`void`	`setAsynchronousSocketChannel(AsynchronousSocketChannel asynchronousSocketChannel)`
`void`	`setBsId(String bsId)`
`void`	`setClientNode(Node clientNode)`
`void`	`setCloseCode(ChannelContext.CloseCode closeCode)`
`void`	`setClosed(boolean isClosed)`
`void`	`setHeartbeatTimeout(Long heartbeatTimeout)`
`void`	`setPacketNeededLength(Integer packetNeededLength)`
`void`	`setProxyClientNode(Node proxyClientNode)`
`void`	`setReadBufferSize(int readBufferSize)`
`void`	`setReconnect(boolean isReconnect)`
`void`	`setRemoved(boolean isRemoved)`
`void`	`setServerNode(Node serverNode)`
`void`	`setSslFacadeContext(SslFacadeContext sslFacadeContext)`
`void`	`setTioConfig(TioConfig tioConfig)`
`void`	`setToken(String token)`
`void`	`setUserId(String userId)`
`String`	`toString()`

从类继承的方法 org.tio.utils.prop.MapPropSupport
clear, computeIfAbsent, containsKey, get, remove, set

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

字段详细资料
- UNKNOWN_ADDRESS_IP
```
public static final String UNKNOWN_ADDRESS_IP
```
  另请参阅:
  
  常量字段值
- UNKNOWN_ADDRESS_PORT_SEQ
```
public static final AtomicInteger UNKNOWN_ADDRESS_PORT_SEQ
```
- closeLock
```
public final ReentrantReadWriteLock closeLock
```
- stat
```
public final ChannelStat stat
```
- closeMeta
```
public final ChannelContext.CloseMeta closeMeta
```
- isReconnect
```
public boolean isReconnect
```
- logWhenDecodeError
```
public boolean logWhenDecodeError
```
  解码出现异常时，是否打印异常日志此值默认与org.tio.core.TioConfig.logWhenDecodeError保持一致
- heartbeatTimeout
```
public Long heartbeatTimeout
```
  此值不设时，心跳时间取org.tio.core.TioConfig.heartbeatTimeout 当然这个值如果小于org.tio.core.TioConfig.heartbeatTimeout，定时检查的时间间隔还是以org.tio.core.TioConfig.heartbeatTimeout为准，只是在判断时用此值
- packetNeededLength
```
public Integer packetNeededLength
```
  一个packet所需要的字节数（用于应用告诉框架，下一次解码所需要的字节长度，省去冗余解码带来的性能损耗）
- tioConfig
```
public TioConfig tioConfig
```
- decodeRunnable
```
public DecodeRunnable decodeRunnable
```
- handlerRunnable
```
public HandlerRunnable handlerRunnable
```
- sendRunnable
```
public SendRunnable sendRunnable
```
- writeCompletionHandler
```
public WriteCompletionHandler writeCompletionHandler
```
- sslFacadeContext
```
public SslFacadeContext sslFacadeContext
```
- isWaitingClose
```
public boolean isWaitingClose
```
- isClosed
```
public boolean isClosed
```
- isRemoved
```
public boolean isRemoved
```
- isVirtual
```
public boolean isVirtual
```
- asynchronousSocketChannel
```
public AsynchronousSocketChannel asynchronousSocketChannel
```
  The asynchronous socket channel.

构造器详细资料
- ChannelContext
```
public ChannelContext(TioConfig tioConfig,
                      AsynchronousSocketChannel asynchronousSocketChannel)
```
  参数:
  
  tioConfig -
  
  asynchronousSocketChannel -
- ChannelContext
```
public ChannelContext(TioConfig tioConfig)
```
  创建一个虚拟ChannelContext，主要用来模拟一些操作，譬如压力测试，真实场景中用得少
  
  参数:
  
  tioConfig -
- ChannelContext
```
public ChannelContext(TioConfig tioConfig,
                      String id)
```
  创建一个虚拟ChannelContext，主要用来模拟一些操作，譬如压力测试，真实场景中用得少
  
  参数:
  
  tioConfig -
  
  id - ChannelContext id

方法详细资料

assignAnUnknownClientNode

protected void assignAnUnknownClientNode()

createUnknownNode

public static Node createUnknownNode()

createClientNode

public abstract Node createClientNode(AsynchronousSocketChannel asynchronousSocketChannel)
                               throws IOException

创建Node

参数:: asynchronousSocketChannel - AsynchronousSocketChannel
返回:: Node
抛出:: IOException - IOException

equals
```
public boolean equals(Object obj)
```
覆盖:

equals 在类中 Object

getClientNode
```
public Node getClientNode()
```
返回:

the remoteNode

setClientNode
```
public void setClientNode(Node clientNode)
```
参数:

clientNode - the clientNode to set

getGroups
```
public Set<String> getGroups()
```

getId
```
public String getId()
```
返回:

the id

getReadCompletionHandler

public ReadCompletionHandler getReadCompletionHandler()

返回:: the readCompletionHandler

getServerNode
```
public Node getServerNode()
```
返回:

the serverNode

setServerNode
```
public void setServerNode(Node serverNode)
```
参数:

serverNode - the serverNode to set

getToken
```
public String getToken()
```

setToken
```
public void setToken(String token)
```

getWriteCompletionHandler

public WriteCompletionHandler getWriteCompletionHandler()

返回:: the writeCompletionHandler

hashCode
```
public int hashCode()
```
覆盖:

hashCode 在类中 Object

返回:

init

public void init(TioConfig tioConfig,
                 AsynchronousSocketChannel asynchronousSocketChannel)

processAfterSent

public void processAfterSent(Packet packet,
                             boolean isSentSuccess)

参数:: packet - Packet; isSentSuccess - isSentSuccess

setAsynchronousSocketChannel

public void setAsynchronousSocketChannel(AsynchronousSocketChannel asynchronousSocketChannel)

参数:: asynchronousSocketChannel - the asynchronousSocketChannel to set

setClosed
```
public void setClosed(boolean isClosed)
```
参数:

isClosed - the isClosed to set

setPacketNeededLength

public void setPacketNeededLength(Integer packetNeededLength)

setReconnect

public void setReconnect(boolean isReconnect)

setRemoved
```
public void setRemoved(boolean isRemoved)
```
参数:

isRemoved - the isRemoved to set

setSslFacadeContext

public void setSslFacadeContext(SslFacadeContext sslFacadeContext)

getUserId
```
public String getUserId()
```
获取用户 id

返回:

用户 id

setUserId
```
public void setUserId(String userId)
```
参数:

userId - the userid to set 给框架内部用的，用户请勿调用此方法

toString
```
public String toString()
```
覆盖:

toString 在类中 Object

getBsId
```
public String getBsId()
```
返回:

the bsId

setBsId
```
public void setBsId(String bsId)
```
参数:

bsId - the bsId to set

getTioConfig
```
public TioConfig getTioConfig()
```

setTioConfig

public void setTioConfig(TioConfig tioConfig)

参数:: tioConfig - the tioConfig to set

isServer
```
public abstract boolean isServer()
```
是否是服务器端

返回:

getHeartbeatTimeout
```
public Long getHeartbeatTimeout()
```
返回:

the heartbeatTimeout

setHeartbeatTimeout
```
public void setHeartbeatTimeout(Long heartbeatTimeout)
```
参数:

heartbeatTimeout - the heartbeatTimeout to set

getReadBufferSize
```
public int getReadBufferSize()
```

setReadBufferSize

public void setReadBufferSize(int readBufferSize)

getProxyClientNode
```
public Node getProxyClientNode()
```
返回:

the proxyClientNode

setProxyClientNode
```
public void setProxyClientNode(Node proxyClientNode)
```
参数:

proxyClientNode - the proxyClientNode to set

getCloseCode

public ChannelContext.CloseCode getCloseCode()

setCloseCode

public void setCloseCode(ChannelContext.CloseCode closeCode)

类 ChannelContext

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 org.tio.utils.prop.MapPropSupport

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

字段详细资料

UNKNOWN_ADDRESS_IP

UNKNOWN_ADDRESS_PORT_SEQ

closeLock

stat

closeMeta

isReconnect

logWhenDecodeError

heartbeatTimeout

packetNeededLength

tioConfig

decodeRunnable

handlerRunnable

sendRunnable

writeCompletionHandler

sslFacadeContext

isWaitingClose

isClosed

isRemoved

isVirtual

asynchronousSocketChannel

构造器详细资料

ChannelContext

ChannelContext

ChannelContext

方法详细资料

assignAnUnknownClientNode

createUnknownNode

createClientNode

equals

getClientNode

setClientNode

getGroups

getId

getReadCompletionHandler

getServerNode

setServerNode

getToken

setToken

getWriteCompletionHandler

hashCode

init

processAfterSent

setAsynchronousSocketChannel

setClosed

setPacketNeededLength

setReconnect

setRemoved

setSslFacadeContext

getUserId

setUserId

toString

getBsId

setBsId

getTioConfig

setTioConfig

isServer

getHeartbeatTimeout

setHeartbeatTimeout

getReadBufferSize

setReadBufferSize

getProxyClientNode

setProxyClientNode

getCloseCode

setCloseCode