Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fish-tennis/gnet
high performance net library for game server
https://github.com/fish-tennis/gnet
game go golang net protobuf server tcp websocket
Last synced: 12 days ago
JSON representation
high performance net library for game server
- Host: GitHub
- URL: https://github.com/fish-tennis/gnet
- Owner: fish-tennis
- License: mit
- Created: 2021-11-04T07:40:48.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-07T10:05:56.000Z (5 months ago)
- Last Synced: 2024-07-31T20:52:35.856Z (3 months ago)
- Topics: game, go, golang, net, protobuf, server, tcp, websocket
- Language: Go
- Homepage:
- Size: 239 KB
- Stars: 15
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - gnet - `gnet` is a high-performance networking framework,especially for game servers. (Networking / Transliteration)
README
# gnet
[](https://goreportcard.com/report/github.com/fish-tennis/gnet)
[](https://pkg.go.dev/github.com/fish-tennis/gnet)
[](https://codecov.io/gh/fish-tennis/gnet)
[](https://github.com/avelino/awesome-go#networking)
[中文说明](https://github.com/fish-tennis/gnet/blob/main/README_cn.md)
High performance network library,especially for game servers
## Features
- MultiThread, nonblocking
- Default support protobuf
- Optimize receiving and dispatching using lockless RingBuffer, which can improve performance by 5x for some cases
- Easy to implement custom encoding and decoding
- rpc
- Support Tcp,WebSocket(ws and wss)
## Usage
run a server
```go
codec := gnet.NewProtoCodec(nil)
handler := gnet.NewDefaultConnectionHandler(codec)
handler.Register(gnet.PacketCommand(pb.CmdTest_Cmd_TestMessage), onTestMessage, new(pb.TestMessage))
listenerConfig := &gnet.ListenerConfig{
AcceptConfig: gnet.DefaultConnectionConfig,
}
listenerConfig.AcceptConfig.Codec = codec
listenerConfig.AcceptConfig.Handler = handler
gnet.GetNetMgr().NewListener(ctx, "localhost:10001", listenerConfig)
```
run a client
```go
codec := gnet.NewProtoCodec(nil)
handler := gnet.NewDefaultConnectionHandler(codec)
handler.Register(gnet.PacketCommand(pb.CmdTest_Cmd_TestMessage), onTestMessage, new(pb.TestMessage))
connectionConfig := gnet.DefaultConnectionConfig
connectionConfig.Codec = clientCodec
connectionConfig.Handler = clientHandler
connector := gnet.GetNetMgr().NewConnector(ctx, "localhost:10001", &connectionConfig, nil)
connector.SendPacket(gnet.NewProtoPacket(gnet.PacketCommand(pb.CmdTest_Cmd_TestMessage),
&pb.TestMessage{
Name: "hello",
}))
```
## Encoding and decoding(https://github.com/fish-tennis/gnet/blob/main/codec.go)
gnet divide TCP stream based decoding into three layers
Layer1:subcontracting stream, format:|Length|Data|,after receiving full packet content, hand it over to the next layer for processing
Layer2:Decoding the data from Layer1,such as decryption,decompression,etc
Layer3:protobuf deserialize,generate proto.Message
## Use RingBuffer to increase performance
## rpc
Rpc send a request to target and block wait reply,similar to grpc-go,but gnet use command id instead of method name
```go
request := gnet.NewProtoPacket(cmd, &pb.HelloRequest{
Name: "hello",
})
reply := new(pb.HelloReply)
err := connection.Rpc(request, reply)
if err != nil {
return
}
logger.Info("reply:%v", reply)
```
## goroutine
## Examples
example/helloworld: a simple example use protobuf message
example/data_packet: a simple example use DataPacket
example/custom_packet: how to extend custom packet struct
example/tcp_connection_simple: use protobuf message without RingBuffer
example/packet_size: send big packet which size is bigger than RingBuffer's cap
example/websocket: a simple example use websocket
example/rpc: how to use rpc
example/simulate_game: a performance test with a game application scenario
## Client Connector Library
C#: [gnet_csharp](https://github.com/fish-tennis/gnet_csharp)
## Project
[game db&cache framework](https://github.com/fish-tennis/gentity)
[distributed game server framework](https://github.com/fish-tennis/gserver)
gnet is also used in our commercial online game projects