Channel()

channel

new Channel()
lib/common/service/channelService.js, line 207

Channel maintains the receiver collection for a subject. You can add users into a channel and then broadcast message to them by channel.

Methods

add(uid, sid)
lib/common/service/channelService.js, line 222

Add user to channel.
Parameters:
Name Type Description
uid Number user id
sid String frontend server id which user has connected to

destroy()
lib/common/service/channelService.js, line 301

Destroy channel.

getMember(uid) → {Object}
lib/common/service/channelService.js, line 294

Get Member info.
Parameters:
Name Type Description
uid String user id
Returns:
Object - member info

getMembers() → {Array}
lib/common/service/channelService.js, line 276

Get channel members. Notice: Heavy operation.
Returns:
Array - channel member uid list

getUserAmount() → {number}
lib/common/service/channelService.js, line 265

Get channel UserAmount in a channel.
Returns:
number - channel member amount

leave(uid, sid)
lib/common/service/channelService.js, line 243

Remove user from channel.
Parameters:
Name Type Description
uid Number user id
sid String frontend server id which user has connected to.
Returns:
- [Boolean] true if success or false if fail

pushMessage(route, msg, opts, cb)
lib/common/service/channelService.js, line 314

Push message to all the members in the channel
Parameters:
Name Type Description
route String message route
msg Object message that would be sent to client
opts Object user-defined push options, optional
cb function callback function