【Firefly API文档】—— Package Netconnect

openfirefly

package netconnect

该包中包含的服务端与客户端通信的一些处理方法，包括发送数据的封装，协议头的封装，tcp通信时进行分包，处理粘包问题。

class Connection
与客户端的一条连接对象，通过他可以与客户端进行通信，主动断开连接，主动推送消息等。

loseConnection
断开与客户端的连接
type method
//cwd firefly/ netconnect / connection.py
Params loseConnection(self)

safeToWriteData
向客户端发送消息
type method
//cwd firefly/ netconnect / connection.py
Params safeToWriteData(self,topicID,msg)

class DataPackProtoc
数据包协议。

getHeadLenght
获取数据包的长度
type method
//cwd firefly/ netconnect / datapack.py
Params getHeadLenght(self)

unpack
解包
type method
//cwd firefly/ netconnect / datapack.py
Params unpack(self,dpack)

pack
打包数据包
type method
//cwd firefly/ netconnect / datapack.py
Params pack(self,response,command)

class ConnectionManager
连接管理器

getNowConnCnt
获取当前连接数量
type method
//cwd firefly/ netconnect / manager.py
Params getNowConnCnt(self)

addConnection
加入一条连接
type method
//cwd firefly/ netconnect / manager.py
Params addConnection(self, conn)

dropConnectionByID
更加连接的id删除连接实例
type method
//cwd firefly/ netconnect / manager.py
Params dropConnectionByID(self, connID)

getConnectionByID
根据ID获取一条连接
type method
//cwd firefly/ netconnect / manager.py
Params getConnectionByID(self, connID)

loseConnection
根据连接ID主动端口与客户端的连接
type method
//cwd firefly/ netconnect / manager.py
Params loseConnection(self,connID)

pushObject
主动推送消息
type method
//cwd firefly/ netconnect / manager.py
Params pushObject(self,topicID , msg, sendList)

class LiberateProtocol
与客户端通信协议类

connectionMade
与客户端连接建立时候的处理
type method
//cwd firefly/ netconnect / protoc.py
Params connectionMade(self)

connectionLost
处理与客户端连接断开时候的处理
type method
//cwd firefly/ netconnect / protoc.py
connectionLost(self,reason)

safeToWriteData
向客户端发送数据
@param data: str 要向客户端写的数据
type method
//cwd firefly/ netconnect / protoc.py
safeToWriteData(self,data,command)

dataHandleCoroutine
接受客户端数据处理的协程。
type method
//cwd firefly/ netconnect / protoc.py
Params dataHandleCoroutine(self)

dataReceived
数据到达处理
@param data: str 客户端传送过来的数据
type method
//cwd firefly/ netconnect / protoc.py
Params dataReceived(self, data)

class LiberateFactory
协议工厂

setDataProtocl
设置数据包协议，指定数据包协议。
type method
//cwd firefly/ netconnect / protoc.py
Params setDataProtocl(self,dataprotocl)

doConnectionMade
当连接建立时的处理
type method
//cwd firefly/ netconnect / protoc.py
Params doConnectionMade(self,conn)

doConnectionLost
连接断开时的处理
type method
//cwd firefly/ netconnect / protoc.py
Params doConnectionLost(self,conn)

addServiceChannel
添加服务通道
type method
//cwd firefly/ netconnect / protoc.py
Params addServiceChannel(self,service)

doDataReceived
数据到达时的处理
type method
//cwd firefly/ netconnect / protoc.py
Params doDataReceived(self,conn,commandID,data)

produceResult
产生客户端需要的最终结果
@param response: str 分布式客户端获取的结果
type method
//cwd firefly/ netconnect / protoc.py
Params produceResult(self,command,response)

loseConnection
主动端口与客户端的连接
type method
//cwd firefly/ netconnect / protoc.py
Params主动端口与客户端的连接

pushObject
服务端向客户端推消息
@param topicID: int 消息的主题id号
@param msg: 消息的类容，protobuf结构类型
@param sendList: 推向的目标列表(客户端id 列表)
type method
//cwd firefly/ netconnect / protoc.py
Params pushObject(self,topicID , msg, sendList)