Skip to content

Commit c0e7049

Browse files
veabaveaba
committed
fix: conflict
1 parent 42d43d9 commit c0e7049

File tree

111 files changed

+1231
-189
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

111 files changed

+1231
-189
lines changed

‎README.md

+149-39
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
gitbook 见 ：https://socket.gitbook.io/docs/
1+
- gitbook 见 ：https://socket.gitbook.io/docs/
2+
- github page 见：https://veaba.github.io/socket.io-docs/
3+
24

35
# Socket.io 文档中文翻译项目
46

@@ -13,9 +15,11 @@ gitbook 见 ：https://socket.gitbook.io/docs/
1315
- 更新新版的socket.io docs
1416

1517
## 目录
16-
* [关于本socket.io中文文档](README.md)
17-
* [socke.IO website](https://socket.io/)
1818

19+
* [关于本socket.io中文文档](https://github.com/veaba/socket.io-docs)
20+
* [socket.IO官方网站](https://socket.io/)
21+
* [gitbook见](https://socket.gitbook.io/docs/)
22+
* [github page 见](https://veaba.github.io/socket.io-docs/)
1923
* [1 指南(Guide)]()
2024
* [1-1 介绍(Introduction)](guide/introduction.md)
2125
* [1-2 web框架(The web framework)](guide/the_web_framework.md)
@@ -82,8 +86,7 @@ gitbook 见 ：https://socket.gitbook.io/docs/
8286
* [3.1.7 初始化示例-额外Headers](client-api/io/initialization_examples_with_extraHeaders.md)
8387
* [3.1.8 初始化示例-仅限websocket传输](client-api/io/initialization_examples_with_websockets_transport_only.md)
8488
* [3.1.9 初始化示例-自定义解析器](client-api/io/initialization_examples_with_a_custom_parser.md)
85-
* [3.1.10 初始化示例-自签名](client-api/io/initialization_examples_with_a_self-signed.md)
86-
* [3.1.11 初始化示例-证书](client-api/io/initialization_examples_certificate.md)
89+
* [3.1.11 初始化示例-自签名证书](client-api/io/initialization_examples_width_a_sele-signed_certificate.md)
8790

8891
* [3.2 manager]()
8992
* [3.2.1 new Manager(url[,options])](client-api/manager/new_manager_url_options.md)
@@ -134,38 +137,40 @@ gitbook 见 ：https://socket.gitbook.io/docs/
134137
* [4 服务端-API(Server-API)]()
135138

136139
* [4.1 server]()
137-
* [4.1.1 new_server_httpserver_options](server-api/server/new_server_httpserver_options.md)
138-
* [4.1.2 new_server_port_options](server-api/server/new_server_port_options.md)
139-
* [4.1.3 new_server_options](server-api/server/new_server_options.md)
140-
* [4.1.4 server_sockets](server-api/server/server_sockets.md)
141-
* [4.1.5 server_serverClient_value](server-api/server/server_serverClient_value.md)
142-
* [4.1.6 server_path_value](server-api/server/server_path_value.md)
143-
* [4.1.7 server_adapter_value](server-api/server/server_adapter_value.md)
144-
* [4.1.8 server_origins_value](server-api/server/server_origins_value.md)
145-
* [4.1.9 server_origins_fn](server-api/server/server_origins_fn.md)
146-
* [4.1.10 server_attach_port_options](server-api/server/server_attach_port_options.md)
147-
* [4.1.11 server_listen_httpServer_options](server-api/server/server_listen_httpServer_options.md)
148-
* [4.1.12 server_listent_port_options](server-api/server/server_listent_port_options.md)
149-
* [4.1.13 server_bind_engine](server-api/server/server_bind_engine.md)
150-
* [4.1.14 server_onconnection_socket](server-api/server/server_onconnection_socket.md)
151-
* [4.1.15 server_of_nsp](server-api/server/server_of_nsp.md)
152-
* [4.1.16 server_close_callback](server-api/server/server_close_callback.md)
153-
* [4.1.17 server_engine_generateid](server-api/server/server_engine_generateid.md)
154-
155-
* [4.2 namespace]()
156-
* [4.2.1 namespace_name](server-api/namespace/namespace_name.md)
157-
* [4.2.2 namespace_connectid](server-api/namespace/namespace_connectid.md)
158-
* [4.2.3 namespace_adapter](server-api/namespace/namespace_adapter.md)
159-
* [4.2.4 namespace_to_room](server-api/namespace/namespace_to_room.md)
160-
* [4.2.4 namespace_in_room](server-api/namespace/namespace_in_room.md)
161-
* [4.2.5 namespace_emit_eventname_args](server-api/namespace/namespace_emit_eventname_args.md)
162-
* [4.2.6 namespace_clients_callback](server-api/namespace/namespace_clients_callback.md)
163-
* [4.2.7 namespace_use_fn](server-api/namespace/namespace_use_fn.md)
164-
* [4.2.8 event_connect](server-api/namespace/event_connect.md)
165-
* [4.2.9 event_connection](server-api/namespace/event_connection.md)
166-
* [4.2.10 flag_volatile](server-api/namespace/flag_volatile.md)
167-
* [4.2.11 flag_binary](server-api/namespace/flag_binary.md)
168-
* [4.2.12 flag_local](server-api/namespace/flag_local.md)
140+
* [4.1.1 HTTP服务选项 new_server_httpserver_options](server-api/server/new_server_httpserver_options.md)
141+
* [4.1.2 服务器端口选项 new_server_port_options](server-api/server/new_server_port_options.md)
142+
* [4.1.3 服务器选项 new_server_options](server-api/server/new_server_options.md)
143+
* [4.1.4 服务器sockets server_sockets](server-api/server/server_sockets.md)
144+
* [4.1.5 服务器serverClient值 server_serverClient_value](server-api/server/server_serverClient_value.md)
145+
* [4.1.6 服务器路径值 server_path_value](server-api/server/server_path_value.md)
146+
* [4.1.7 服务器适配器值 server_adapter_value](server-api/server/server_adapter_value.md)
147+
* [4.1.8 服务器源值 server_origins_value](server-api/server/server_origins_value.md)
148+
* [4.1.9 服务器源函数 server_origins_fn](server-api/server/server_origins_fn.md)
149+
* [4.1.10 服务器附加HTTP服务选项 server_attach_httpServer_options](server-api/server/server_attach_httpServer_options.md)
150+
* [4.1.11 服务器附加端口选项 server_attach_port_options](server-api/server/server_attach_port_options.md)
151+
* [4.1.12 服务器监听HTTP服务选项 server_listen_httpServer_options](server-api/server/server_listen_httpServer_options.md)
152+
* [4.1.13 服务器监听端口选项 server_listent_port_options](server-api/server/server_listent_port_options.md)
153+
* [4.1.14 服务器绑定引擎 server_bind_engine](server-api/server/server_bind_engine.md)
154+
* [4.1.15 服务器连接socket server_onconnection_socket](server-api/server/server_onconnection_socket.md)
155+
* [4.1.16 服务器命名空间(nsp) server_of_nsp](server-api/server/server_of_nsp.md)
156+
* [4.1.17 服务器关闭回调 server_close_callback](server-api/server/server_close_callback.md)
157+
* [4.1.18 服务器引擎生成socket ID server_engine_generateid](server-api/server/server_engine_generateid.md)
158+
159+
* [4.2 命名空间(namespace)]()
160+
* [4.2.1 命名空间 namespace](server-api/namespace/namespace.md)
161+
* [4.2.2 命名空间名称 namespace_name](server-api/namespace/namespace_name.md)
162+
* [4.2.3 命名空间连接 namespace_connected](server-api/namespace/namespace_connected.md)
163+
* [4.2.4 命名空间适配器 namespace_adapter](server-api/namespace/namespace_adapter.md)
164+
* [4.2.5 命名空间到房间 namespace_to_room](server-api/namespace/namespace_to_room.md)
165+
* [4.2.6 命名空间在房间 namespace_in_room](server-api/namespace/namespace_in_room.md)
166+
* [4.2.7 命名空间发送事件参数 namespace_emit_eventname_args](server-api/namespace/namespace_emit_eventname_args.md)
167+
* [4.2.8 命名空间客户端回调 namespace_clients_callback](server-api/namespace/namespace_clients_callback.md)
168+
* [4.2.9 命名空间中间件函数 namespace_use_fn](server-api/namespace/namespace_use_fn.md)
169+
* [4.2.10 连接事件 event_connect](server-api/namespace/event_connect.md)
170+
* [4.2.11 事件连接 event_connection](server-api/namespace/event_connection.md)
171+
* [4.2.12 可见性标志位 flag_volatile](server-api/namespace/flag_volatile.md)
172+
* [4.2.13 二进制标志位 flag_binary](server-api/namespace/flag_binary.md)
173+
* [4.2.14 本地标记位 flag_local](server-api/namespace/flag_local.md)
169174

170175
* [4.3 socket]()
171176
* [4.3.1 socket_id](server-api/socket/socket_id.md)
@@ -196,8 +201,113 @@ gitbook 见 ：https://socket.gitbook.io/docs/
196201
* [4.3.26 event_error](server-api/socket/event_error.md)
197202
* [4.3.27 event_disconnecting](server-api/socket/event_disconnecting.md)
198203
* [4.4 client]()
199-
* [4.4.1 client_conn](server-api/client/client_conn.md)
200-
* [4.4.2 client_request](server-api/client/client_request.md)
204+
* [4.4.1 client](server-api/client/client.md)
205+
* [4.4.2 client_conn](server-api/client/client_conn.md)
206+
* [4.4.3 client_request](server-api/client/client_request.md)
207+
208+
209+
210+
## 术语
211+
212+
### 术语转换
213+
|错误|校正|
214+
|---|----|
215+
|`客户机`|客户端|
216+
|`套接字`|socket|
217+
|`插座`|socket|
218+
|`发射`|发送|
219+
|`分析器`|解析器|
220+
|`underlying`|底层|
221+
|`激发`|触发|
222+
|||
223+
224+
### 英文翻译
225+
- `traditionally 传统，一直以来`
226+
- `involves 涉及`
227+
- `polling 投票、轮询`
228+
- `goal 目标，得分，母的`
229+
- `populate 填充、补完`
230+
- `confufing 混乱 混淆`
231+
- `entire 整个`
232+
- `placed 放置`
233+
- `instead 相反的`
234+
- `refactor 重构`
235+
- `composed 组成`
236+
- `exposes 暴露`
237+
- `several 一些`
238+
- `behind 背后`
239+
- `prevents 放置`
240+
- `broadcasting 广播`
241+
- `the rest 其余`
242+
- `in order to 为了`
243+
- `except 除了`
244+
- `certain 某些`
245+
- `in the case 在这种情况下`
246+
- `for the sake of simplicity 为了简单起见`
247+
- `capture 捕获`
248+
- `total 全部`
249+
- `amounts 量、等于、合计`
250+
- `directly z直接地 `
251+
- `presses 按下`
252+
- `typing 打字`
253+
- `functionality 功能`
254+
- `improvements 改进`
255+
- `enables 可以，使能够`
256+
- `real-time 实时`
257+
- `bidirectional 双向的`
258+
- `event-based 基于事件`
259+
- `communication 通信、沟通`
260+
- `between 之间`
261+
- `consists 包括`
262+
- `which can 也可以`
263+
- `Multiplexing 多路复用`
264+
- `established 建立`
265+
- `presence 存在`
266+
- `load balancers 负载均衡器`
267+
- `firewall 防火墙`
268+
- `purpose 目的`
269+
- `antivirus 防病毒`
270+
- `relies 依赖`
271+
- `polling 轮询 `
272+
- `goals 目标`
273+
- `For this purpose 为此`
274+
- `Unless 除非`
275+
- `instructed 得到指示`
276+
- `otherwise 否则`
277+
- `heartbeat 心跳`
278+
- `mechanism 机智`
279+
- `implemented 实现、实施，贯彻，使生效`
280+
- `allowing 允许`
281+
- `anymore 不在`
282+
- `functionality 功能`
283+
- `acheieved 实现、达到`
284+
- `handshake 握手`
285+
- `serializable 可序列化的`
286+
- `structures 结构`
287+
- `separation 分离`
288+
- `concerns 关注`
289+
- `per 每`
290+
- `underlying connection 底层连接`
291+
- `arbitrary 任意`
292+
- `reaching 到达`
293+
- `given 给定、特定、指定`
294+
- `useful 有用`
295+
- `standalone 独立`
296+
- `served 服务`
297+
- `implementations 实现方式`
298+
- `several 几个`
299+
- `maintained 维护、保持`
300+
- `besides 此外，除了`
301+
- `restricting 限制`
302+
- `reception 接待、接受`
303+
- `volatile 不稳定的`
304+
- `certain 某些 `
305+
- `essentially 本质上`
306+
- `assigning 分配`
307+
- `minimize 减少`
308+
- `identified `
309+
- `short form 简写`
310+
201311

202312
_________________________________________
203313

‎SUMMARY.md

+20-20
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Table of contents
22
* [关于本socket.io中文文档](README.md)
3-
* [socke.IO website](https://socket.io/)
3+
* [socket.IO website](https://socket.io/)
44

55
* [1 指南(Guide)]()
66
* [1-1 介绍(Introduction)](guide/introduction.md)
@@ -68,8 +68,7 @@
6868
* [3.1.7 初始化示例-额外Headers](client-api/io/initialization_examples_with_extraHeaders.md)
6969
* [3.1.8 初始化示例-仅限websocket传输](client-api/io/initialization_examples_with_websockets_transport_only.md)
7070
* [3.1.9 初始化示例-自定义解析器](client-api/io/initialization_examples_with_a_custom_parser.md)
71-
* [3.1.10 初始化示例-自签名](client-api/io/initialization_examples_with_a_self-signed.md)
72-
* [3.1.11 初始化示例-证书](client-api/io/initialization_examples_certificate.md)
71+
* [3.1.11 初始化示例-自签名证书](client-api/io/initialization_examples_width_a_sele-signed_certificate.md)
7372

7473
* [3.2 manager]()
7574
* [3.2.1 new Manager(url[,options])](client-api/manager/new_manager_url_options.md)
@@ -139,21 +138,21 @@
139138
* [4.1.17 服务器关闭回调 server_close_callback](server-api/server/server_close_callback.md)
140139
* [4.1.18 服务器引擎生成socket ID server_engine_generateid](server-api/server/server_engine_generateid.md)
141140

142-
* [4.2 namespace]()
143-
* [4.2.1 namespace](server-api/namespace/namespace.md)
144-
* [4.2.2 namespace_name](server-api/namespace/namespace_name.md)
145-
* [4.2.3 namespace_connected](server-api/namespace/namespace_connected.md)
146-
* [4.2.4 namespace_adapter](server-api/namespace/namespace_adapter.md)
147-
* [4.2.5 namespace_to_room](server-api/namespace/namespace_to_room.md)
148-
* [4.2.6 namespace_in_room](server-api/namespace/namespace_in_room.md)
149-
* [4.2.7 namespace_emit_eventname_args](server-api/namespace/namespace_emit_eventname_args.md)
150-
* [4.2.8 namespace_clients_callback](server-api/namespace/namespace_clients_callback.md)
151-
* [4.2.9 namespace_use_fn](server-api/namespace/namespace_use_fn.md)
152-
* [4.2.10 event_connect](server-api/namespace/event_connect.md)
153-
* [4.2.11 event_connection](server-api/namespace/event_connection.md)
154-
* [4.2.12 flag_volatile](server-api/namespace/flag_volatile.md)
155-
* [4.2.13 flag_binary](server-api/namespace/flag_binary.md)
156-
* [4.2.14 flag_local](server-api/namespace/flag_local.md)
141+
* [4.2 命名空间(namespace)]()
142+
* [4.2.1 命名空间 namespace](server-api/namespace/namespace.md)
143+
* [4.2.2 命名空间名称 namespace_name](server-api/namespace/namespace_name.md)
144+
* [4.2.3 命名空间连接 namespace_connected](server-api/namespace/namespace_connected.md)
145+
* [4.2.4 命名空间适配器 namespace_adapter](server-api/namespace/namespace_adapter.md)
146+
* [4.2.5 命名空间到房间 namespace_to_room](server-api/namespace/namespace_to_room.md)
147+
* [4.2.6 命名空间在房间 namespace_in_room](server-api/namespace/namespace_in_room.md)
148+
* [4.2.7 命名空间发送事件参数 namespace_emit_eventname_args](server-api/namespace/namespace_emit_eventname_args.md)
149+
* [4.2.8 命名空间客户端回调 namespace_clients_callback](server-api/namespace/namespace_clients_callback.md)
150+
* [4.2.9 命名空间中间件函数 namespace_use_fn](server-api/namespace/namespace_use_fn.md)
151+
* [4.2.10 连接事件 event_connect](server-api/namespace/event_connect.md)
152+
* [4.2.11 事件连接 event_connection](server-api/namespace/event_connection.md)
153+
* [4.2.12 可见性标志位 flag_volatile](server-api/namespace/flag_volatile.md)
154+
* [4.2.13 二进制标志位 flag_binary](server-api/namespace/flag_binary.md)
155+
* [4.2.14 本地标记位 flag_local](server-api/namespace/flag_local.md)
157156

158157
* [4.3 socket]()
159158
* [4.3.1 socket_id](server-api/socket/socket_id.md)
@@ -184,5 +183,6 @@
184183
* [4.3.26 event_error](server-api/socket/event_error.md)
185184
* [4.3.27 event_disconnecting](server-api/socket/event_disconnecting.md)
186185
* [4.4 client]()
187-
* [4.4.1 client_conn](server-api/client/client_conn.md)
188-
* [4.4.2 client_request](server-api/client/client_request.md)
186+
* [4.4.1 client](server-api/client/client.md)
187+
* [4.4.2 client_conn](server-api/client/client_conn.md)
188+
* [4.4.3 client_request](server-api/client/client_request.md)

‎client-api/io/initialization_examples_certificate.md

Whitespace-only changes.

‎client-api/io/initialization_examples_with_a_custom_parser.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## 初始化示例：使用自定义解析器
2+
3+
默认的[解析器](https://github.com/socketio/socket.io-parser)以牺牲性能为代价来提升兼容性（对`blob`、`文件`、二进制检查的支持）。可以提供一个定制的解析器来满足应用程序的需求。请看[这里](https://github.com/socketio/socket.io/tree/master/examples/custom-parsers)的例子。
4+
5+
```js
6+
const parser = require('socket.io-msgpack-parser');//or require('socket.io-json-parser')
7+
const socket=io({
8+
parser
9+
})
10+
11+
// 服务器端必须具有相同的解析器，才能进行通信
12+
const io= require('socekt.io')({
13+
parser
14+
})
15+
```

‎client-api/io/initialization_examples_with_a_self-signed.md

Whitespace-only changes.

‎client-api/io/initialization_examples_with_a_self-signed_certificate.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
## 初始化示例：使带有自签名证书
2+
3+
4+
5+
```js
6+
// 服务端
7+
const fs= require('fs');
8+
const server= require('https').createServer({
9+
key:fs.readFileSync('server-key.pem'),
10+
cert:fs.readFileSync('server-cert.pem')
11+
})
12+
13+
const io = require('socket.io')(server);
14+
server.listen(3000);
15+
16+
17+
// 客户端
18+
19+
const socket=io({
20+
// 选项 1
21+
ca:fs.readFileSync('server-cert.pem'),
22+
// 选项2 警告!!：它让你很容易受到MITM(中间人)攻击
23+
rejectUnauthorized:false
24+
})
25+
```

‎client-api/io/initialization_examples_with_custom_path.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## 初始化示例：自定义路径
2+
3+
```js
4+
const socket= io('http://localhost',{
5+
path:"/myownpath"
6+
})
7+
8+
// 服务端
9+
const io =require('socket.io')({
10+
path:"/myownpath"
11+
})
12+
```
13+
14+
请求的URLS会像:`localhost/myownpath/?EIO=3&transport=polling&sid=<id>`
15+
16+
```js
17+
const socket= io('http://localhost/admin',{
18+
path:"/mypath"
19+
})
20+
```
21+
22+
在这里，socket通过自定义路径`mypath`连接到`admin`命名空间。
23+
24+
请求的URLS会像:`localhost/mypath/?EIO=3&transport=polling&sid=<id>` (命名空间作为有效负载的一部分发送)

‎client-api/io/initialization_examples_with_extraHeaders.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## 初始化示例：额外Headers
2+
3+
这仅在启用了`轮询`传输（默认情况下）时才有效。将`WebSocket`用作传输时，不会附加自定义头。这是因为WebSocket握手不支持自定义头文件。（见[WebSocket协议RFC](https://tools.ietf.org/html/rfc6455#section-4)）
4+
5+
6+
客户端：
7+
```js
8+
const socket=io({
9+
transportOptions:{
10+
polling:{
11+
extraHeaders:{
12+
"x-clientId":"abc"
13+
}
14+
}
15+
}
16+
})
17+
```
18+
19+
服务端
20+
```js
21+
const io= require('socket.io')()
22+
23+
// 中间器件
24+
25+
io.use((socket,next)=>{
26+
const clientId= socket.handshake.headers['x-clientId'];
27+
if (isValid(clientId)){
28+
return next()
29+
}
30+
return next(new Error("authentication error"))
31+
})
32+
```

0 commit comments

Comments
 (0)