文档更新

master
zcy 2020-08-27 16:49:38 +08:00
parent d4a3ca3f8d
commit 129c86e54f
5 changed files with 19 additions and 21 deletions

3
.vscode/settings.json vendored Normal file
View File

@ -0,0 +1,3 @@
{
"go.inferGopath": false
}

View File

@ -1,5 +1,4 @@
FROM alpine:latest FROM alpine:latest
MAINTAINER caiyu "a7458969@gmail.com"
WORKDIR /home/ubuntu/api/bin WORKDIR /home/ubuntu/api/bin
@ -9,4 +8,4 @@ RUN mkdir /lib64 && ln -s /lib/libc.musl-x86_64.so.1 /lib64/ld-linux-x86-64.so.2
EXPOSE 9850 EXPOSE 9850
ENTRYPOINT ["/bin/go-tcpFramework-rudy","--conf_path=/bin/TcpServConfig.json"] ENTRYPOINT ["/bin/go-tcpFramework-rudy","--conf_path=/bin/TcpServConfig.json"]

View File

@ -1,21 +1,17 @@
## go-tcpFramework-rudy
#### 介绍 #### 介绍
tcp流转包服务端
基于 golang 的 tcp 长连接框架--rudy。 #### 特性
#### 软件架构
功能: 功能:
提供连接数管理,支持熔断,热重启 提供连接数管理,支持熔断,热重启。
提供路由管理,支持 context 化 timeout 和 cancel 支持 context 化回调机制。
支持分布式,和主节点选举 ##### 支持分布式,和主节点选举。
支持 apolo 配置 主节点的作用
心跳包支持 心跳包支持。
服务端推送支持 服务端推送支持。
##### 可选并行回调或者同步回调方式。
并行回调就是异步回调,回调不保证执行得有序性。
同步回调一定会在上个回调函数执行完毕后执行。
#### How to use #### How to use
```go ```go
package main package main
@ -63,13 +59,10 @@ server.Run() 服务启动
包头格式 7 个字节,首个字节标识符 40 41 ,然后包长度,最后是 verify 是包头长度的校验和 包头格式 7 个字节,首个字节标识符 40 41 ,然后包长度,最后是 verify 是包头长度的校验和
### secure tcp ### secure tcp
secure tcp 提供了类似于 tls,ssl 的机制的安全 tcp 连接,流程如下 secure tcp 提供了类似于 tls,ssl 的机制的安全 tcp 连接,流程如下
</br> </br>
</br> </br>
![image.png](https://www.testingcloud.club/sapi/api/image_download/692bf256-e121-11ea-bc55-525400dc6cec.png) ![image.png](https://www.testingcloud.club/sapi/api/image_download/692bf256-e121-11ea-bc55-525400dc6cec.png)
</br> </br>
#### 服务端下发公钥的报文

View File

@ -10,4 +10,5 @@ ssh -t -i ./id_rsa ubuntu@118.24.238.198 'cp /home/ubuntu/api/bin/go-tcpFramew
ssh -t -i ./id_rsa root@118.24.238.198 'cd /home/ubuntu/api/bin/;docker build ./ -t "caiyuzheng\rudy"' ssh -t -i ./id_rsa root@118.24.238.198 'cd /home/ubuntu/api/bin/;docker build ./ -t "caiyuzheng\rudy"'
ssh -t -i ./id_rsa ubuntu@118.24.238.198 'chmod 777 /home/ubuntu/api/bin/rudy' ssh -t -i ./id_rsa ubuntu@118.24.238.198 'chmod 777 /home/ubuntu/api/bin/rudy'
ssh -t -i ./id_rsa ubuntu@118.24.238.198 '/home/ubuntu/api/bin/restart.sh rudy' ssh -t -i ./id_rsa ubuntu@118.24.238.198 '/home/ubuntu/api/bin/restart.sh rudy'

2
go.mod
View File

@ -1,5 +1,7 @@
module go-tcpFramework-rudy module go-tcpFramework-rudy
go 1.14
require ( require (
github.com/davecgh/go-spew v1.1.1 github.com/davecgh/go-spew v1.1.1
github.com/gin-contrib/sse v0.0.0-20190301062529-5545eab6dad3 // indirect github.com/gin-contrib/sse v0.0.0-20190301062529-5545eab6dad3 // indirect