Skip to content

Commit af44858

Browse files
committed
更新文档
1 parent b18a660 commit af44858

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,14 @@
3939
* [配置握手时的超时时间](#配置握手时的超时时间)
4040
* [配置自动回复ping消息](#配置自动回复ping消息)
4141
* [配置客户端最大读取message](#配置客户端最大读message)
42+
* [配置客户端压缩和解压消息](#配置客户端压缩和解压消息)
43+
* [配置客户端上下文接管](#配置客户端上下文接管)
4244
* [服务配置参数](#服务端配置)
4345
* [配置服务自动回复ping消息](#配置服务自动回复ping消息)
4446
* [配置服务端最大读取message](#配置服务端最大读message)
47+
* [配置服务端解压消息](#配置服务端解压消息)
48+
* [配置服务端压缩和解压消息](#配置服务端压缩和解压消息)
49+
* [配置服务端上下文接管](#配置服务端上下文接管)
4550
# 例子-服务端
4651
### net http升级到websocket服务端
4752
```go
@@ -248,6 +253,20 @@ func main() {
248253
greatws.Dial("ws://127.0.0.1:12345/test", greatws.WithClientReadMaxMessage(1024))
249254
```
250255
[返回](#内容)
256+
#### 配置客户端压缩和解压消息
257+
```go
258+
func main() {
259+
greatws.Dial("ws://127.0.0.1:12345/test", greatws.WithClientDecompressAndCompress())
260+
}
261+
```
262+
[返回](#内容)
263+
#### 配置客户端上下文接管
264+
```go
265+
func main() {
266+
greatws.Dial("ws://127.0.0.1:12345/test", greatws.WithClientContextTakeover())
267+
}
268+
```
269+
[返回](#内容)
251270
### 服务端配置参数
252271
#### 配置服务自动回复ping消息
253272
```go
@@ -273,6 +292,41 @@ func main() {
273292
}
274293
```
275294
[返回](#内容)
295+
#### 配置服务端解压消息
296+
```go
297+
func main() {
298+
// 配置服务端读取客户端最大的包是1024大小, 超过该值报错
299+
c, err := greatws.Upgrade(w, r, greatws.WithServerDecompression())
300+
if err != nil {
301+
fmt.Println("Upgrade fail:", err)
302+
return
303+
}
304+
}
305+
```
306+
[返回](#内容)
307+
#### 配置服务端压缩和解压消息
308+
```go
309+
func main() {
310+
c, err := greatws.Upgrade(w, r, greatws.WithServerDecompressAndCompress())
311+
if err != nil {
312+
fmt.Println("Upgrade fail:", err)
313+
return
314+
}
315+
}
316+
```
317+
[返回](#内容)
318+
#### 配置服务端上下文接管
319+
```go
320+
func main() {
321+
// 配置服务端读取客户端最大的包是1024大小, 超过该值报错
322+
c, err := greatws.Upgrade(w, r, greatws.WithServerContextTakeover)
323+
if err != nil {
324+
fmt.Println("Upgrade fail:", err)
325+
return
326+
}
327+
}
328+
```
329+
[返回](#内容)
276330
## 100w websocket长链接测试
277331

278332
### e5 洋垃圾机器

0 commit comments

Comments
 (0)