# tcpx
**Repository Path**: develop1024/tcpx
## Basic Information
- **Project Name**: tcpx
- **Description**: tcpx为golang实现的tcp框架，支持中间件，常用的api和使用方式，非常贴近gin框架。
操作案例可以查看说明文档。
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 4
- **Created**: 2021-12-11
- **Last Updated**: 2021-12-11
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
A very convenient tcp framework in golang.
- [Have fun](https://github.com/fwhezfwhez/tcpx/tree/master/markdowns/have-fun.md)
- [Heartbeat](https://github.com/fwhezfwhez/tcpx/tree/master/markdowns/heartbeat.md)
- [Auth](https://github.com/fwhezfwhez/tcpx/tree/master/markdowns/auth.md)
- [User pool](https://github.com/fwhezfwhez/tcpx/tree/master/markdowns/user-pool.md)
- [Graceful](https://github.com/fwhezfwhez/tcpx/tree/master/markdowns/graceful.md)
- [Middleware](https://github.com/fwhezfwhez/tcpx/tree/master/markdowns/middleware.md)
- [Message](https://github.com/fwhezfwhez/tcpx/tree/master/markdowns/message.md)
- [Marshaller](https://github.com/fwhezfwhez/tcpx/tree/master/markdowns/marshaller.md)
- [TLS](https://github.com/fwhezfwhez/tcpx/tree/master/markdowns/tls.md)
## Start
`go get github.com/fwhezfwhez/tcpx`
#### Dependency
if you want to run program in this repo,you should prepare protoc,proto-gen-go environment.
It's good to compile yourself from these repos,but there is already release versions referring to their doc.
Make sure run `protoc --version` available.
**protoc**: https://github.com/golang/protobuf
**proto-gen-go**:https://github.com/golang/protobuf/tree/master/protoc-gen-go
#### Benchmark
https://github.com/fwhezfwhez/tcpx/blob/master/benchmark_test.go
| cases | exec times | cost time per loop | cost mem per loop | cost object num per loop | url |
|-----------| ---- |------|-------------|-----|-----|
| OnMessage | 2000000 | 643 ns/op | 1368 B/op | 5 allocs/op| [click to location](https://github.com/fwhezfwhez/tcpx/blob/9c70f4bd5a0042932728ed44681ff70d6a22f7e3/benchmark_test.go#L9) |
| Mux without middleware | 2000000 | 761 ns/op | 1368 B/op | 5 allocs/op| [click to location](https://github.com/fwhezfwhez/tcpx/blob/9c70f4bd5a0042932728ed44681ff70d6a22f7e3/benchmark_test.go#L17) |
| Mux with middleware | 2000000 | 768 ns/op | 1368 B/op | 5 allocs/op| [click to location](https://github.com/fwhezfwhez/tcpx/blob/9c70f4bd5a0042932728ed44681ff70d6a22f7e3/benchmark_test.go#L25) |
#### Pack
Tcpx has its well-designed pack. To focus on detail, you can refer to:
https://github.com/fwhezfwhez/tcpx/tree/master/examples/modules/pack-detail
```text
[4]byte -- length fixed_size,binary big endian encode
[4]byte -- messageID fixed_size,binary big endian encode
[4]byte -- headerLength fixed_size,binary big endian encode
[4]byte -- bodyLength fixed_size,binary big endian encode
[]byte -- header marshal by json
[]byte -- body marshal by marshaller
```
According to this pack rule, tcpx has 2 well-designed routing ways and their pack structure:
**messageID type pack**
```json
header:
{
"Router-Type": "MESSAGE_ID"
}
```
**urlPattern pack**
```json
header:
{
"Router-Type": "URL_PATTERN"
"Router-Pattern-Value": "/login/"
}
```
#### Chat
https://github.com/fwhezfwhez/tcpx/tree/master/examples/modules/chat
It examples a chat using tcpx.
#### Raw
https://github.com/fwhezfwhez/tcpx/tree/master/examples/modules/raw
It examples how to send stream without rule, nothing to do with `messageID/urlPattern system`. You can send all stream you want. Global middleware and anchor middleware are still working as the example said.
#### IM
Here is an example of IM system using tcpx.
https://github.com/q1n9-jair/tcpx-demo
#### Product practice
