Emitter类
Emitter类可以说是socket.io-client 中极其的类,Socket.class 便继承自该类.
先看看Emitter类中定义的变量callbacks:
private ConcurrentMap<String, ConcurrentLinkedQueue<Listener>> callbacks = new ConcurrentHashMap<String, ConcurrentLinkedQueue<Listener>>();
可以说整个Emitter类就是围绕着callbacks在进行操作,callbacks通过将事件名-回调接口保存在map类型的数据结构中,以便在事件发生时触发相应的回调接口通知监听者。
ConcurrentMap 和 ConcurrentLinkedQueue 都是线程安全的
Emitter类中定义的监听接口 Listener:
public static interface Listener {
public void call(Object... args);
}
外部监听者通过该接口监听Emitter的事件触发,同时另外一个一次性的接口OnceListener继承自这一接口。
看看Emitter类中最重要的几个方法:
public Emitter on(String event, Listener fn)
public Emitter off()
public Emitter off(String event)
public Emitter off(String event, Listener fn)
这三个方法顾名思义,都是解除事件监听器。区别在于,
第一个方法: 为callbacks解除所有事件的所有监听器。
第二个方法: 为所传入的event事件解除该事件所有的监听器。
第三个方法: 解除所传入event事件的fn监听器。
三个方法各有各的使用范围。
public Emitter emit(String event, Object... args)
Emitter 通过调用该方法触发事件,回调所有的监听接口,同时为每一个监听接口传入变量args. 使得每一个监听接口都能够操作相应事件所携带的数据args.
Socket类
说完Emitter类,便该说说Emitter类的子类Socket类了,Socket类是 Socket.io 的Client类,负责管理Socket.io 通信过程中的一些细节操作。
进入Socket先看看定义的一些事件常量和变量,这里的事件常量不是我们用于传输数据的自定义事件,而是Socket.io 同服务器链接过程中的各种事件。
其中有几个变量需要注意一下,
private String nsp;
该Socket所链接到的命名空间.
private Map<Integer, Ack> acks = new HashMap<Integer, Ack>();
acks 通过Map容器装载了一个标识符(是一个回调接口),在之后服务器广播相应的事件之后会回调该接口,同ids相对应。
private final Queue<List<Object>> receiveBuffer = new LinkedList<List<Object>>();
receiveBuffer 缓存队列装载了收到从服务器发过来却未处理的事件信息(不能够立即处理而放在缓冲区的)。
private final Queue<Packet<JSONArray>> sendBuffer = new LinkedList<Packet<JSONArray>>();
sendBuffer 缓存队列装载了将要发送到服务器的的事件信息(缓冲区的,不是立即发送的)。
为什么要使用队列,当然是因为要FIFO啦!
来看看其中一些比较重要的方法:
public Emitter emit(final String event, final Object... args)
public Emitter emit(final String event, final Object[] args, final Ack ack)
这两个方法非常重要,Client就是从这里开始触发事件,向服务器提交事件信息的。区别在于第二个方法传入了一个回调接口Ack, emit()方法的调用者可以通过传入一个实现了Ack接口的回调函数来对数据传输之后的结果进行处理。
private void onpacket(Packet<?> packet)
对不同的Packet类型进行转发。
private void onevent(Packet<JSONArray> packet)
对从服务器返回的数据包进行处理。
private void onack(Packet<JSONArray> packet)
接收到从服务器传过来的数据包之后对Ack接口进行回调。
private void emitBuffered()
将receiveBuffer, sendBuffer缓存区中的数据全部推到服务器端并清空缓存区。