PHP Class Gateway, thinksns

显示文件 Open project: medz/thinksns-4 Class Usage Examples

Protected Properties

Property Type Description
$businessWorker object gateway实例

Public Methods

Method Description
closeClient ( integer $client_id ) 关闭某个客户端
getOnlineStatus ( ) : array 获取在线状态,目前返回一个在线client_id数组
isOnline ( integer $client_id ) : 0/1 判断某个客户端是否在线
sendToAll ( string $message, array $client_id_array = null ) 向所有客户端(或者client_id_array指定的客户端)广播消息
sendToClient ( integer $client_id, string $message ) 向某个客户端发消息
setBusinessWorker ( $business_worker_instance ) 设置gateway实例
updateSocketSession ( integer $client_id, string $session_str ) 更新session,框架自动调用,开发者不要调用

Protected Methods

Method Description
kickAddress ( $address, integer $client_id ) 踢掉某个网关的socket
sendCmdAndMessageToClient ( integer $client_id, integer $cmd, string $message ) : boolean 想某个用户网关发送命令和消息
sendToGateway ( string $address, $gateway_data ) 发送数据到网关
sendUdpAndRecv ( integer $address, $data ) : boolean 发送udp数据并返回

Method Details

closeClient() public static method

关闭某个客户端
public static closeClient ( integer $client_id )
$client_id integer

getOnlineStatus() public static method

获取在线状态,目前返回一个在线client_id数组
public static getOnlineStatus ( ) : array
return array

isOnline() public static method

判断某个客户端是否在线
public static isOnline ( integer $client_id ) : 0/1
$client_id integer
return 0/1

kickAddress() protected static method

踢掉某个网关的socket
protected static kickAddress ( $address, integer $client_id )
$client_id integer

sendCmdAndMessageToClient() protected static method

想某个用户网关发送命令和消息
protected static sendCmdAndMessageToClient ( integer $client_id, integer $cmd, string $message ) : boolean
$client_id integer
$cmd integer
$message string
return boolean

sendToAll() public static method

向所有客户端(或者client_id_array指定的客户端)广播消息
public static sendToAll ( string $message, array $client_id_array = null )
$message string 向客户端发送的消息(可以是二进制数据)
$client_id_array array 客户端id数组

sendToClient() public static method

向某个客户端发消息
public static sendToClient ( integer $client_id, string $message )
$client_id integer
$message string

sendToGateway() protected static method

发送数据到网关
protected static sendToGateway ( string $address, $gateway_data )
$address string

sendUdpAndRecv() protected static method

发送udp数据并返回
protected static sendUdpAndRecv ( integer $address, $data ) : boolean
$address integer
return boolean

setBusinessWorker() public static method

设置gateway实例
public static setBusinessWorker ( $business_worker_instance )

updateSocketSession() public static method

更新session,框架自动调用,开发者不要调用
public static updateSocketSession ( integer $client_id, string $session_str )
$client_id integer
$session_str string

Property Details

$businessWorker protected_oe static_oe property

gateway实例
protected static object $businessWorker
return object