finish docs

Author: veaba

SUMMARY.md

@@ -32,24 +32,24 @@
         * [2.2.3 给外部发送消息](docs/rooms_and_namespaces/sending_message_from_the_outside-world.md)
 
     * [2.3 从0.9迁移版本 migrating_from_0.9]()
-        * [2.3.1 authentication_differences](docs/migrating_from_0.9/authentication_differences.md )
-        * [2.3.2 log_differences](docs/migrating_from_0.9/log_differences.md)
-        * [2.3.3 shorcuts](docs/migrating_from_0.9/shorcuts.md)
-        * [2.3.4 configuration_differences](docs/migrating_from_0.9/configuration_differences.md)
-        * [2.3.5 parser_protocol_differences](docs/migrating_from_0.9/parser_protocol_differences.md)
+        * [2.3.1 身份验证差异](docs/migrating_from_0.9/authentication_differences.md )
+        * [2.3.2 日志差异](docs/migrating_from_0.9/log_differences.md)
+        * [2.3.3 快捷方式](docs/migrating_from_0.9/shorcuts.md)
+        * [2.3.4 配置差异](docs/migrating_from_0.9/configuration_differences.md)
+        * [2.3.5 解析器/协议差异](docs/migrating_from_0.9/parser_protocol_differences.md)
 
-    * [2.4 using_multiple_nodes]()
-        * [2.4.1 apache_httpd_configuration](docs/using_multiple_nodes/apache_httpd_configuration.md)
-        * [2.4.2 passing_events_between_nodes](docs/using_multiple_nodes/passing_events_between_nodes.md)
-        * [2.4.3 haproxy_configuration](docs/using_multiple_nodes/haproxy_configuration.md)
-        * [2.4.4 sticky_load_balancing](docs/using_multiple_nodes/sticky_load_balancing.md)
-        * [2.4.5 nginx_configuration](docs/using_multiple_nodes/nginx_configuration.md)
-        * [2.4.6 using_node.js_cluster](docs/using_multiple_nodes/using_node.js_cluster.md)
+    * [2.4 多路节点使用]()
+        * [2.4.1 Apache httpd配置](docs/using_multiple_nodes/apache_httpd_configuration.md)
+        * [2.4.2 在节点之间传递事件](docs/using_multiple_nodes/passing_events_between_nodes.md)
+        * [2.4.3 Haproxy配置](docs/using_multiple_nodes/haproxy_configuration.md)
+        * [2.4.4 粘性负载均衡](docs/using_multiple_nodes/sticky_load_balancing.md)
+        * [2.4.5 Nginx配置](docs/using_multiple_nodes/nginx_configuration.md)
+        * [2.4.6 使用node.js集群](docs/using_multiple_nodes/using_node.js_cluster.md)
 
-    * [2.5 logging_and_debugging]()
-        * [2.5.1 available_debugging_scopes](docs/logging_and_debugging/available_debugging_scopes.md)
+    * [2.5 日志和调试]()
+        * [2.5.1 可用的调试范围](docs/logging_and_debugging/available_debugging_scopes.md)
 
-    * [2.6 emit_cheatsheet](docs/emit_cheatsheet.md)
+    * [2.6 emit 备忘单](docs/emit_cheatsheet.md)
 
     * [2.7 internals_overview]()
         * [2.7.1 internals_overview_dependency_graph_under_the_hood](docs/internals_overview_dependency_graph_under_the_hood.md)

docs/emit_cheatsheet.md

@@ -0,0 +1,62 @@
+## emit备忘单
+
+```js
+io.on('connect',onConnect)
+
+function onConnect(){
+    // 发消息到客户端
+    socket.emit('hello',"can you hear me?",1,2,"abc");
+
+    // 发送到是所有客户端除了发送者
+    socket.broadcast.emit("boradcast","hello friends!");
+    
+    // 发送到 “game” room中除发件人以外的所有客户端
+    socket.to("game").emit("nice game","let't play a game");
+
+    // 发送到“game1”和/或“game2”房间中的所有客户端，发件人除外
+    socket.to('game1').to('game2').emit("nice game","let's play a game (too)");
+
+    // 发送给“游戏”室中的所有客户，包括发件人
+    io.in('game').emit('big-announcement',"the game will start soon");
+
+    // 发送到命名空间“mynamespace”中的所有客户端，包括发件人
+    io.of('myNamespace').emit('bigger-announcement',"the tournament will start soon");
+
+    // 发送到特定命名空间中的特定房间，包括发件人
+    io.of('myNamespace').to('root').emit('event',"message");
+
+    // 警告：`socket.to(socket.id).emit()` ,不会工作，因为它会发送给房间里的每个人
+    // 命名 `socket.id` ，但为发件人。请改用经典的“socket.emit（）”。
+
+    // 带确认发送
+    socket.emit('question',"do you think so?",(answer)=>{
+
+    })
+
+    // 不压缩发送
+    socket.compress(false).emit('uncomressed',"that's rough");
+
+    // 指定要发送的数据是否具有二进制数据
+    socket.binary(false).emit('what',"I hava no binaries!");
+
+    // 发送到此节点上的所有客户端（使用多个节点时
+    io.local.emit('hi',"my lovely babies");
+
+    // 发送到所有连接的客户端
+    io.emit('an event send to all connected clients';)
+
+}
+
+```
+
+**注意**：以下事件是保留的，应用程序不应将其用作事件名称：
+
+- `erorr`
+- `connect`
+- `disconnect`
+- `disconnecting` 
+- `newListener`
+- `removeListener`
+- `ping`
+- `pong`
+

docs/faq.md

@@ -1,12 +1,15 @@
-## 我可以在活动中使用通配符吗？
+## FAQ
+
+### 我可以在活动中使用通配符吗？
 不是直接在`Socket.IO`？可以看看 `Hao-kang Den`这个插件，提供了一个 Socket'.io中间件来处理通配符。
 
-## Apache Cordova中使用 `Socket.IO`？
+### Apache Cordova中使用 `Socket.IO`？
 看看这里[this tutorial](https://Socket.IO/socket-io-with-apache-cordova/)
-## iOS中使用 `Socket.IO`？
+
+### iOS中使用 `Socket.IO`？
 看看这里[SIOSocket.](https://github.com/MegaBits/SIOSocket)
 
-## Android 中使用 `Socket.IO` ？
+### Android 中使用 `Socket.IO` ？
 看看这里[socket.io-client.java.](https://github.com/nkzawa/socket.io-client.java)
 
 ————————————————————————————————

docs/internals_overview_dependency_graph.md

@@ -0,0 +1,71 @@
+## 依赖关系图
+
+socket.io codebase跨多个存储库拆分：
+
+- https://github.com/socketio/socket.io
+- https://github.com/socketio/socket.io-client
+- https://github.com/socketio/socket.io-parser
+- https://github.com/socketio/socket.io-adapter
+- https://github.com/socketio/socket.io-redis
+- https://github.com/socketio/engine.io
+- https://github.com/socketio/engine.io-client
+- https://github.com/socketio/engine.io-parser
+
+下图显示了每个项目之间的关系：
+
+![依赖图](/images/dependencies.jpg)
+
+每个项目都有自己的一套功能：
+
+### engine.io-parser
+
+是用于engine.io协议编码的javascript解析器，由 [engine.io-client](https://github.com/socketio/engine.io-client) 和 [engine.io](https://github.com/socketio/engine.io) 共享。
+
+协议的规范可以在这里找到：https://github.com/socketio/engine.io-protocol
+
+### engine.io
+
+engine.io是socket.io基于传输的跨浏览器/跨设备双向通信层的实现。
+
+它的主要特点是能够在飞行中交换传输。连接（由 [engine.io-client](https://github.com/socketio/engine.io-client) 对应方启动）从xhr轮询开始，但如果可能，可以切换到websocket。
+
+它使用 [engine.io-parser](https://github.com/socketio/engine.io-parser) 对数据包进行编码/解码。
+
+### engine.io-client
+
+这是[engine.io](https://github.com/socketio/engine.io)的客户机，是基于传输的[socket.io](https://github.com/socketio/socket.io)跨浏览器/跨设备双向通信层的实现。
+
+它在浏览器（包括HTML5 [WebWorker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) ）和node.js中运行。
+
+它使用 [engine.io-parser](https://github.com/socketio/engine.io-parser) 对数据包进行编码/解码。
+
+
+### socket.io-adapter
+
+这是默认的socket.io内存适配器类。
+
+此模块不适用于最终用户，但可以用作从您可能想要构建的其他适配器（如[socket.io-redis](https://github.com/socketio/socket.io-redis)）继承的接口。
+
+### socket.io-redis
+
+这是使用redis 发布/订阅 机制在多个节点之间广播消息的适配器。
+
+### socket.io-parser
+用符合[socket.io-protocol](https://socket.io/docs/internals/) 第3版的javascript编写的socket.io编码器和解码器。由[socket.io](https://github.com/socketio/socket.io)和[socket.io-client](https://github.com/socketio/socket.io-client)使用。
+
+
+### socket.io
+
+socket.io给engine.io“raw”api带来了一些语法上的优势。它还引入了两个新的概念，即`root`和`namespace`，这引入了通信通道之间的关注分离。请参阅[相关文档](https://socket.io/docs/rooms-and-namespaces/)。
+
+默认情况下，它在`/socket.io/socket.io.js`处公开客户端的浏览器构建。
+
+### socket.io-client
+
+这是[socket.io](https://github.com/socketio/socket.io)的客户端。它依赖于[engine.io-client](https://github.com/socketio/engine.io-client)，它管理传输交换和断开检测。
+
+它会自动处理重新连接，以防基础连接被切断。
+
+它使用[socket.io-parser](https://github.com/socketio/socket.io-parser)对数据包进行编码/解码。
+
+

docs/internals_overview_dependency_graph_under_the_hood.md

@@ -0,0 +1,86 @@
+## 引擎底层
+
+### Connection连接
+
+```js
+
+const client =io('https://myhost.com')
+
+```
+
+执行以下步骤：
+
+- 在客户端，创建一个`engine.io-client`实例
+- `engine.io-client`实例尝试建立`轮询`传输
+
+```txt
+GET https://myhost.com/socket.io/?EIO=3&transport=polling&t=ML4jUwU&b64=1
+
+如下:
+
+  "EIO=3"               # Engine.io协议的当前版本
+  "transport=polling"   # 正在建立的传输
+  "t=ML4jUwU&b64=1"     # 用于缓存总线的哈希时间戳
+
+```
+
+- engine.io服务器响应为：
+
+```json
+{
+  "type": "open",
+  "data": {
+    "sid": "36Yib8-rSutGQYLfAAAD",  // 唯一会话ID
+    "upgrades": ["websocket"],      // 可能的运输升级列表
+    "pingInterval": 25000,          // 心跳机制的第一个参数
+    "pingTimeout": 5000             // 心跳机制的第二个参数
+  }
+}
+
+```
+
+- 内容由`engine.io-parser`编码为：
+
+
+```txt
+'96:0{"sid":"hLOEJXN07AE0GQCNAAAB","upgrades":["websocket"],"pingInterval":25000,"pingTimeout":5000}2:40'
+
+详细:
+
+  "96"  # 第一条消息的长度
+  ":"   # 长度和内容之间的分隔符
+  "0"   # "打开的"消息类型
+  '{"sid":"hLOEJXN07AE0GQCNAAAB","upgrades":["websocket"],"pingInterval":25000,"pingTimeout":5000}' # JSON编码的握手数据
+  "2"   # 第二条消息的长度
+  ":"   # 长度和内容之间的分隔符
+  "4"   # 消息类型
+  "0"   # socket.io协议中的"打开的"消息类型
+
+```
+
+- 然后由客户端的`engine.io-parser`对内容进行解码。
+- 在`engine.io-client`级别发出`open`事件
+- 在`socket.io-client`级别发出`connect`事件
+
+
+### 升级
+
+一旦刷新了现有传输（XHR轮询）的所有缓冲区，就可以通过发送探测来测试升级。
+
+
+```txt
+GET wss://myhost.com/socket.io/?EIO=3&transport=websocket&sid=36Yib8-rSutGQYLfAAAD
+
+具体:
+
+  "EIO=3"                     # 同样，当前版本的engine.io协议
+  "transport=websocket"       # 正在调查的新传输
+  "sid=36Yib8-rSutGQYLfAAAD"  # 唯一的会话id
+
+```
+
+- 客户端在websocket帧中发送“ping”包，由`engine.io-parser`编码为`2probe`，其中`2`是“ping”消息类型。
+- 服务器响应一个“pong”包，编码为`3probe`，其中`3`是“pong”消息类型。
+- 在接收到“pong”包时，升级被认为是完成的，并且所有以下消息都通过新的传输。
+
+

docs/logging_and_debugging/available_debugging_scopes.md

@@ -0,0 +1,45 @@
+## 日志和调试
+
+socket.io现在完全由TJ Holowaychuk称之为[debug](https://github.com/visionmedia/debug)的一个极简但功能强大的实用程序进行了测
+试。
+
+在1.0之前，socket.io服务器默认将所有内容注销到控制台。这对许多用户来说是非常冗长的（尽管对其他用户非常有用），所以现在默认情况下我们完全保持沉默。
+
+基本思想是socket.io使用的每个模块提供不同的调试范围，使您能够深入了解内部。默认情况下，所有输出都被抑制，您可以通过提供`DEBUG `env变量（node.js）或`localstorage.debug`属性（browsers）来选择查看消息。
+
+您可以在我们的主页上看到它的实际应用：
+
+### 可用的调试范围
+
+查看可用信息的最佳方法是使用*：
+
+```js
+
+DEBUG=* node yourfile.js
+
+```
+
+或者在浏览器中：
+
+```js
+
+localStorage.debug = '*';
+
+```
+
+然后根据你感兴趣的范围进行过滤。您可以在`*`前面加上范围前缀，如果有多个范围，则用逗号分隔。例如，要仅查看node.js上socket.io客户机的调试语句，请尝试以下操作：
+
+```js
+
+DEBUG=socket.io:client* node yourfile.js
+
+```
+
+要查看来自engine和socket.io的所有调试消息：
+
+
+```js
+
+DEBUG=engine,socket.io* node yourfile.js
+
+```

docs/using_multiple_nodes/passing_events_between_nodes.md

@@ -11,3 +11,17 @@ const redis = require('socket.io-redis');
 io.adapter(redis({host:"localhost",port:6379}));
 
 ```
+
+如下调用：
+
+```js
+io.emit('hi',"all sockets")
+```
+
+将通过redis的[发布/订阅机制](https://redis.io/topics/pubsub)广播到每个节点。
+
+
+**注意**：使用Redis适配器时仍然需要粘性会话。
+
+如果您想通过`non-socket.io`进程将消息传递给它，您应该考虑[“从外部世界发送消息”](https://socket.io/docs/rooms-and-namespaces/#Sending-messages-from-the-outside-world)。
+

docs/using_multiple_nodes/using_node.js_cluster.md

@@ -4,4 +4,7 @@
 
 Fedor Indutny创建了一个名为[Sticky Session](https://github.com/indutny/sticky-session)的模块，该模块确保文件描述符（即：连接）基于`remoteAddress`（即：IP）进行路由。请注意，这可能会导致路由不平衡，这取决于散列方法。
 
-您还可以根据集群工作进程ID为集群中的每个工作进程分配不同的端口，并使用上面可以找到的配置来平衡负载。
+您还可以根据集群工作进程ID为集群中的每个工作进程分配不同的端口，并使用上面可以找到的配置来平衡负载。
+
+
+