com.tuisongbao.engine.channel

Class Channel

java.lang.Object

com.github.nkzawa.emitter.Emitter

com.tuisongbao.engine.common.EventEmitter

com.tuisongbao.engine.channel.Channel

Direct Known Subclasses:

PrivateChannel

public class Channel
extends com.tuisongbao.engine.common.EventEmitter

普通 Channel

使用 #bind(String, Listener) 方法可以获取以下事件的回调通知：

• EVENT_SUBSCRIPTION_SUCCESS
• EVENT_SUBSCRIPTION_ERROR

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_SUBSCRIPTION_ERROR 订阅 Channel 失败时会触发该事件，事件回调接收一个参数，类型为 String，表明失败原因
static java.lang.String	EVENT_SUBSCRIPTION_SUCCESS 订阅 Channel 成功时会触发该事件，对于普通 Channel，事件回调没有参数； 对于 PresenceChannel，事件回调接收一个参数，类型为 List<OnlineUser>：

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName()
void	subscribe() 订阅此 Channel, 针对不同的 Channel 会进行相应的鉴权 该操作是异步的，需要通过绑定 engine:subscription_succeeded 和 engine:subscription_error Event 来获取订阅结果
java.lang.String	toString()
void	unsubscribe() 取消订阅此 Channel

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_SUBSCRIPTION_SUCCESS

public static final java.lang.String EVENT_SUBSCRIPTION_SUCCESS

订阅 Channel 成功时会触发该事件，对于普通 Channel，事件回调没有参数； 对于 PresenceChannel，事件回调接收一个参数，类型为 List<OnlineUser>：

    connection.bind(Channel.EVENT_SUBSCRIPTION_SUCCESS, new Emitter.Listener() {
        @Override
        public void call(final Object... args) {
            List<OnlineUser> onlineUsers = (List)args[0];
            Log.i(TAG, "当前在线用户有 " + onlineUsers.size() + " 个");
        }
    });
 

See Also:

Constant Field Values

EVENT_SUBSCRIPTION_ERROR

public static final java.lang.String EVENT_SUBSCRIPTION_ERROR

订阅 Channel 失败时会触发该事件，事件回调接收一个参数，类型为 String，表明失败原因

See Also:

Constant Field Values

Constructor Detail

Channel

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

Method Detail

getName

public java.lang.String getName()

subscribe

public void subscribe()

订阅此 Channel, 针对不同的 Channel 会进行相应的鉴权 该操作是异步的，需要通过绑定 engine:subscription_succeeded 和 engine:subscription_error Event 来获取订阅结果

unsubscribe

public void unsubscribe()

取消订阅此 Channel

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object