ChannelContext (mica-net-core 1.0.6 API)

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

All Implemented Interfaces:

IPropSupport

Direct Known Subclasses:

ClientChannelContext, ServerChannelContext
```
public abstract class ChannelContext
extends MapPropSupport
```
Author:

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ChannelContext.CloseCode
连接关闭码

static class ChannelContext.CloseMeta

Nested Classes
Modifier and Type	Class and Description
`static class`	`ChannelContext.CloseCode` 连接关闭码
`static class`	`ChannelContext.CloseMeta`

Field Summary

Fields
Modifier and Type	Field and Description
`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为准，只是在判断时用此值
`Integer`	`packetNeededLength` 一个packet所需要的字节数（用于应用告诉框架，下一次解码所需要的字节长度，省去冗余解码带来的性能损耗）
`SendRunnable`	`sendRunnable`
`SslFacadeContext`	`sslFacadeContext`
`ChannelStat`	`stat`
`TioConfig`	`tioConfig`
`static String`	`UNKNOWN_ADDRESS_IP`
`static AtomicInteger`	`UNKNOWN_ADDRESS_PORT_SEQ`
`WriteCompletionHandler`	`writeCompletionHandler`

Constructor Summary

Constructors
Constructor and Description
`ChannelContext(TioConfig tioConfig)` 创建一个虚拟ChannelContext，主要用来模拟一些操作，譬如压力测试，真实场景中用得少
`ChannelContext(TioConfig tioConfig, AsynchronousSocketChannel asynchronousSocketChannel)` ChannelContext
`ChannelContext(TioConfig tioConfig, String id)` 创建一个虚拟ChannelContext，主要用来模拟一些操作，譬如压力测试，真实场景中用得少

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`assignAnUnknownClientNode()`
`boolean`	`bSend(Packet packet)` 发送消息
`abstract Node`	`createClientNode(AsynchronousSocketChannel asynchronousSocketChannel)` 创建Node
`static Node`	`createUnknownNode()`
`boolean`	`equals(Object obj)`
`String`	`getBsId()`
`Node`	`getClientNode()`
`ChannelContext.CloseCode`	`getCloseCode()`
`int`	`getDecodeQueueSize()` 获取解码队列目前消息数
`Set<String>`	`getGroups()`
`int`	`getHandlerQueueSize()` 获取处理队列目前消息数
`Long`	`getHeartbeatTimeout()`
`String`	`getId()`
`Node`	`getProxyClientNode()`
`int`	`getReadBufferSize()`
`ReadCompletionHandler`	`getReadCompletionHandler()`
`int`	`getSendQueueSize()` 获取发送队列目前消息数
`Node`	`getServerNode()`
`SslFacadeContext`	`getSslFacadeContext()`
`TioConfig`	`getTioConfig()`
`String`	`getToken()`
`String`	`getUserId()` 获取用户 id
`WriteCompletionHandler`	`getWriteCompletionHandler()`
`int`	`hashCode()`
`void`	`init(TioConfig tioConfig, AsynchronousSocketChannel asynchronousSocketChannel)`
`boolean`	`isAccepted()`
`boolean`	`isBizStatus()`
`boolean`	`isClosed()`
`boolean`	`isLogWhenDecodeError()`
`boolean`	`isReconnect()`
`boolean`	`isRemoved()`
`abstract boolean`	`isServer()` 是否是服务器端
`boolean`	`isVirtual()`
`boolean`	`isWaitingClose()`
`void`	`processAfterSent(Packet packet, boolean isSentSuccess)`
`boolean`	`send(Packet packet)` 发送消息
`void`	`setAccepted(boolean accepted)`
`void`	`setAsynchronousSocketChannel(AsynchronousSocketChannel asynchronousSocketChannel)`
`void`	`setBizStatus(boolean bizStatus)`
`void`	`setBsId(String bsId)`
`void`	`setClientNode(Node clientNode)`
`void`	`setCloseCode(ChannelContext.CloseCode closeCode)`
`void`	`setClosed(boolean isClosed)`
`void`	`setHeartbeatTimeout(Long heartbeatTimeout)`
`void`	`setLogWhenDecodeError(boolean logWhenDecodeError)`
`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)` 设置 SslFacadeContext 用于动态 ssl 的过程
`void`	`setToken(String token)`
`void`	`setUpSSL()` 设置 ssl
`void`	`setUserId(String userId)`
`void`	`setVirtual(boolean virtual)`
`void`	`setWaitingClose(boolean waitingClose)`
`String`	`toString()`

Methods inherited from class org.tio.utils.prop.MapPropSupport
clear, computeIfAbsent, containsKey, get, remove, set

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

Methods inherited from interface org.tio.utils.prop.IPropSupport
get, getAndRemove, getAndRemove

Field Detail
- UNKNOWN_ADDRESS_IP
```
public static final String UNKNOWN_ADDRESS_IP
```
  See Also:
  
  Constant Field Values
- 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
```
- 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
```
- asynchronousSocketChannel
```
public AsynchronousSocketChannel asynchronousSocketChannel
```
  The asynchronous socket channel.

Constructor Detail
- ChannelContext
```
public ChannelContext(TioConfig tioConfig,
                      AsynchronousSocketChannel asynchronousSocketChannel)
```
  ChannelContext
  
  Parameters:
  
  tioConfig - TioConfig
  
  asynchronousSocketChannel - AsynchronousSocketChannel
- ChannelContext
```
public ChannelContext(TioConfig tioConfig)
```
  创建一个虚拟ChannelContext，主要用来模拟一些操作，譬如压力测试，真实场景中用得少
  
  Parameters:
  
  tioConfig - TioConfig
- ChannelContext
```
public ChannelContext(TioConfig tioConfig,
                      String id)
```
  创建一个虚拟ChannelContext，主要用来模拟一些操作，譬如压力测试，真实场景中用得少
  
  Parameters:
  
  tioConfig - TioConfig
  
  id - ChannelContext id

Method Detail

assignAnUnknownClientNode

protected void assignAnUnknownClientNode()

createUnknownNode

public static Node createUnknownNode()

setUpSSL
```
public void setUpSSL()
```
设置 ssl

createClientNode

public abstract Node createClientNode(AsynchronousSocketChannel asynchronousSocketChannel)
                               throws IOException

创建Node

Parameters:: asynchronousSocketChannel - AsynchronousSocketChannel
Returns:: Node
Throws:: IOException - IOException

getClientNode
```
public Node getClientNode()
```
Returns:

the remoteNode

setClientNode
```
public void setClientNode(Node clientNode)
```
Parameters:

clientNode - the clientNode to set

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

getId
```
public String getId()
```
Returns:

the id

getReadCompletionHandler

public ReadCompletionHandler getReadCompletionHandler()

Returns:: the readCompletionHandler

getServerNode
```
public Node getServerNode()
```
Returns:

the serverNode

setServerNode
```
public void setServerNode(Node serverNode)
```
Parameters:

serverNode - the serverNode to set

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

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

getWriteCompletionHandler

public WriteCompletionHandler getWriteCompletionHandler()

Returns:: the writeCompletionHandler

init

public void init(TioConfig tioConfig,
                 AsynchronousSocketChannel asynchronousSocketChannel)

processAfterSent

public void processAfterSent(Packet packet,
                             boolean isSentSuccess)

Parameters:: packet - Packet; isSentSuccess - isSentSuccess

setAsynchronousSocketChannel
```
public void setAsynchronousSocketChannel(AsynchronousSocketChannel asynchronousSocketChannel)
```
Parameters:

asynchronousSocketChannel - the asynchronousSocketChannel to set

isVirtual
```
public boolean isVirtual()
```

setVirtual

public void setVirtual(boolean virtual)

isReconnect
```
public boolean isReconnect()
```

setReconnect

public void setReconnect(boolean isReconnect)

isLogWhenDecodeError
```
public boolean isLogWhenDecodeError()
```

setLogWhenDecodeError

public void setLogWhenDecodeError(boolean logWhenDecodeError)

isWaitingClose
```
public boolean isWaitingClose()
```

setWaitingClose

public void setWaitingClose(boolean waitingClose)

isClosed
```
public boolean isClosed()
```

setClosed
```
public void setClosed(boolean isClosed)
```
Parameters:

isClosed - the isClosed to set

isRemoved
```
public boolean isRemoved()
```

setRemoved
```
public void setRemoved(boolean isRemoved)
```
Parameters:

isRemoved - the isRemoved to set

isAccepted
```
public boolean isAccepted()
```

setAccepted

public void setAccepted(boolean accepted)

isBizStatus
```
public boolean isBizStatus()
```

setBizStatus

public void setBizStatus(boolean bizStatus)

setPacketNeededLength

public void setPacketNeededLength(Integer packetNeededLength)

getSslFacadeContext

public SslFacadeContext getSslFacadeContext()

setSslFacadeContext
```
public void setSslFacadeContext(SslFacadeContext sslFacadeContext)
```
设置 SslFacadeContext 用于动态 ssl 的过程

Parameters:

sslFacadeContext - sslFacadeContext

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

Returns:

用户 id

setUserId
```
public void setUserId(String userId)
```
Parameters:

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

getBsId
```
public String getBsId()
```
Returns:

the bsId

setBsId
```
public void setBsId(String bsId)
```
Parameters:

bsId - the bsId to set

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

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

Returns:

boolean

getHeartbeatTimeout
```
public Long getHeartbeatTimeout()
```
Returns:

the heartbeatTimeout

setHeartbeatTimeout
```
public void setHeartbeatTimeout(Long heartbeatTimeout)
```
Parameters:

heartbeatTimeout - the heartbeatTimeout to set

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

setReadBufferSize

public void setReadBufferSize(int readBufferSize)

getProxyClientNode
```
public Node getProxyClientNode()
```
Returns:

the proxyClientNode

setProxyClientNode
```
public void setProxyClientNode(Node proxyClientNode)
```
Parameters:

proxyClientNode - the proxyClientNode to set

getCloseCode

public ChannelContext.CloseCode getCloseCode()

setCloseCode

public void setCloseCode(ChannelContext.CloseCode closeCode)

send
```
public boolean send(Packet packet)
```
发送消息

Parameters:

packet - Packet

Returns:

发送结果

bSend
```
public boolean bSend(Packet packet)
```
发送消息

Parameters:

packet - Packet

Returns:

发送结果

getDecodeQueueSize
```
public int getDecodeQueueSize()
```
获取解码队列目前消息数

Returns:

数据量

getHandlerQueueSize
```
public int getHandlerQueueSize()
```
获取处理队列目前消息数

Returns:

数据量

getSendQueueSize
```
public int getSendQueueSize()
```
获取发送队列目前消息数

Returns:

数据量

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

Class ChannelContext

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.tio.utils.prop.MapPropSupport

Methods inherited from class java.lang.Object

Methods inherited from interface org.tio.utils.prop.IPropSupport

Field Detail

UNKNOWN_ADDRESS_IP

UNKNOWN_ADDRESS_PORT_SEQ

closeLock

stat

closeMeta

heartbeatTimeout

packetNeededLength

tioConfig

decodeRunnable

handlerRunnable

sendRunnable

writeCompletionHandler

sslFacadeContext

asynchronousSocketChannel

Constructor Detail

ChannelContext

ChannelContext

ChannelContext

Method Detail

assignAnUnknownClientNode

createUnknownNode

setUpSSL

createClientNode

getClientNode

setClientNode

getGroups

getId

getReadCompletionHandler

getServerNode

setServerNode

getToken

setToken

getWriteCompletionHandler

init

processAfterSent

setAsynchronousSocketChannel

isVirtual

setVirtual

isReconnect

setReconnect

isLogWhenDecodeError

setLogWhenDecodeError

isWaitingClose

setWaitingClose

isClosed

setClosed

isRemoved

setRemoved

isAccepted

setAccepted

isBizStatus

setBizStatus

setPacketNeededLength

getSslFacadeContext

setSslFacadeContext

getUserId

setUserId

getBsId

setBsId

getTioConfig

isServer

getHeartbeatTimeout

setHeartbeatTimeout

getReadBufferSize

setReadBufferSize

getProxyClientNode

setProxyClientNode

getCloseCode

setCloseCode

send

bSend