Global channel service.
GlobalChannelService is created by globalChannel component which is a default
component of pomelo enabled by app.set('globalChannelConfig', {...})
and global channel service would be accessed by
app.get('globalChannelService')
.
Parameters
app
opts
构造函数
Parameters
app
any pomelo instanceopts
Object 参数列表
发送消息给指定服务器 中的某一些人
Parameters
route
String route stringmsg
Object 消息内容uids
Array userId arrayserverType
String frontend server typefrontServerId
String frontend server Id
Returns Array send message fail userList
群发消息给玩家
Parameters
uidArr
(String | Array) 要发送的玩家列表route
String 消息号msg
String 消息内容frontServerId
(String | null) 指定的前端服务器Id, 默认不指定 (optional, defaultnull
)
Returns Array send message fail userList
Send message by global channel. 发送消息给指定 channelName 的所有玩家
Parameters
serverType
String frontend server typeroute
String route stringmsg
Object message would be sent to clientschannelName
String channel name
Get members by channel name. 获取指定 channelName 和 服务器类型的成员
Parameters
Get members by frontend server id. 获取指定服务器和channelName 的玩家列表
Parameters
获得指定玩家在所在的服务器
Parameters
uid
要查找的 玩家id
Returns Array
获取指定玩家的服务器列表
Parameters
uidArr
要查找的玩家列表
Returns Object
Destroy a global channel.
Parameters
channelName
String global channel name
添加一个玩家 到指定channelName Add a member into channel.
Parameters
uid
String user idsid
String frontend server idchannelName
(String | Array) 指定的 channelName (optional, defaultnull
)
Returns number is add: 1 add success, 0 fail
Remove user from channel. 移除一个玩家
Parameters