com.tuisongbao.engine.channel

Class PresenceChannel

java.lang.Object

com.github.nkzawa.emitter.Emitter

com.tuisongbao.engine.common.EventEmitter

com.tuisongbao.engine.channel.Channel

com.tuisongbao.engine.channel.PrivateChannel

com.tuisongbao.engine.channel.PresenceChannel

public class PresenceChannel
extends PrivateChannel

Presence Channel

在 PrivateChannel 的基础上，可以监听用户上下线的通知，使用 EventEmitter.bind(String, Emitter.Listener) 方法可以获取以下事件的回调通知：

• engine:user_added
• engine:user_removed

Nested Class Summary

Nested classes/interfaces inherited from class com.github.nkzawa.emitter.Emitter

com.github.nkzawa.emitter.Emitter.Listener

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EVENT_USER_ADDED 用户上线时会触发该事件，事件回调有一个参数，类型为 PresenceChannelUser；
static java.lang.String	EVENT_USER_REMOVED 用户下线时会触发该事件，事件回调有一个参数，类型为 PresenceChannelUser；

Fields inherited from class com.tuisongbao.engine.channel.Channel

EVENT_SUBSCRIPTION_ERROR, EVENT_SUBSCRIPTION_SUCCESS

Constructor Summary

Constructors

Constructor and Description
PresenceChannel(java.lang.String name, Engine engine)

Method Summary

Modifier and Type	Method and Description
void	setAuthData(java.lang.String authData)

Methods inherited from class com.tuisongbao.engine.channel.PrivateChannel

setSignature

Methods inherited from class com.tuisongbao.engine.channel.Channel

getName, subscribe, toString, unsubscribe

Methods inherited from class com.tuisongbao.engine.common.EventEmitter

bind, bindOnce, trigger, unbind, unbind

Methods inherited from class com.github.nkzawa.emitter.Emitter

emit, hasListeners, listeners, off, off, off, on, once

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EVENT_USER_ADDED

public static final java.lang.String EVENT_USER_ADDED

用户上线时会触发该事件，事件回调有一个参数，类型为 PresenceChannelUser；

See Also:

Constant Field Values

EVENT_USER_REMOVED

public static final java.lang.String EVENT_USER_REMOVED

用户下线时会触发该事件，事件回调有一个参数，类型为 PresenceChannelUser；

See Also:

Constant Field Values

Constructor Detail

PresenceChannel

public PresenceChannel(java.lang.String name,
                       Engine engine)

Method Detail

setAuthData

public void setAuthData(java.lang.String authData)