English |Tiếng Trung

🎉🎉🎉 Feel free to jointhe channels aboutgneton the Discord Server.

📖 Introduction

gnetis an event-driven networking framework that is ultra-fast and lightweight. It is built from scratch by exploitingepollandkqueueand it can achieve much higher performance with lower memory consumption than Gonetin many specific scenarios.

gnetandnetdon't share the same philosophy about network programming. Thus, building network applications withgnetcan be significantly different from building them withnet,and the philosophies can't be reconciled. There are other similar products written in other programming languages in the community, such aslibevent,libuv,netty,twisted,tornado,etc. which work in a similar pattern asgnetunder the hood.

gnetis not designed to displace the Gonet,but to create an alternative in the Go ecosystem for building performance-critical network services. As a result of which,gnetis not as comprehensive as Gonet,it provides only the core functionalities (in a concise API set) required by a network application and it doesn't plan on being a coverall networking framework, as I think Gonethas done a good enough job in that area.

gnetsells itself as a high-performance, lightweight, non-blocking, event-driven networking framework written in pure Go which works on the transport layer with TCP/UDP protocols and Unix Domain Socket. It enables developers to implement their own protocols(HTTP, RPC, WebSocket, Redis, etc.) of application layer upongnetfor building diversified network services. For instance, you get an HTTP Server if you implement HTTP protocol upongnetwhile you have a Redis Server done with the implementation of Redis protocol upongnetand so on.

gnetderives from the project:eviowith much higher performance and more features.

🚀 Features

🦖 Milestone

• High-performanceevent-driven looping based on a networking model of multiple threads/goroutines
• Built-in goroutine pool powered by the libraryants
• Lock-free during the entire runtime
• Concise and easy-to-use APIs
• Efficient, reusable, and elastic memory buffer: (Elastic-)Ring-Buffer, Linked-List-Buffer and Elastic-Mixed-Buffer
• Multiple protocols/IPC mechanisms:TCP,UDP,andUnix Domain Socket
• Multiple load-balancing algorithms:Round-Robin,Source-Addr-Hash,andLeast-Connections
• Flexible ticker event
• gnetclient
• Running onLinux,macOS,Windows,and *BSD:Darwin/DragonFlyBSD/FreeBSD/NetBSD/OpenBSD
• Edge-triggeredI/O support
• Multiple network addresses binding

🕊 Roadmap

• TLSsupport
• io_uringsupport
• KCPsupport

Windows version ofgnetshould only be used in development for developing and testing, it shouldn't be used in production.

🎬 Getting started

gnetis available as a Go module and we highly recommend that you usegnetviaGo Modules,with Go 1.11 Modules enabled (Go 1.11+), you can just simply addimport "github /panjf2000/gnet/v2"to the codebase and rungo mod download/go mod tidyorgo [build|run|test]to download the necessary dependencies automatically.

With v2

go get -u github /panjf2000/gnet/v2

With v1

go get -u github /panjf2000/gnet

🎡 Use cases

The following corporations/organizations usegnetas the underlying network service in production.

If you're also usinggnetin production, please help us enrich this list by opening a pull request.

📊 Performance

Benchmarks on TechEmpower

#Hardware Environment
*28 HT Cores Intel(R) Xeon(R) Gold 5120 CPU @ 3.20GHz
*32GB RAM
*Dedicated Cisco 10-gigabit Ethernet switch
*Debian 12"bookworm"
*Go1.19.x linux/amd64

This is a leaderboard of the top50out of486frameworks that encompass various programming languages worldwide, in whichgnetis rankedfirst.

This is the full framework ranking of Go andgnettops all the other frameworks, which makesgnetthefastestnetworking framework in Go.

To see the full ranking list, visitTechEmpower BenchmarkRound 22.

Note that the HTTP implementation of gnet on TechEmpower is half-baked and fine-tuned for benchmark purposes only and far from production-ready.

Contrasts to the similar networking libraries

On Linux (epoll)

Test Environment

#Machine information
OS:Ubuntu 20.04/x86_64
CPU:8 CPU cores, AMD EPYC 7K62 48-Core Processor
Memory:16.0 GiB

#Go version and settings
Go Version:go1.17.2 linux/amd64
GOMAXPROCS:8

#Benchmark parameters
TCP connections:1000/2000/5000/10000
Packet size:512/1024/2048/4096/8192/16384/32768/65536 bytes
Test duration:15s

Echo benchmark

On MacOS (kqueue)

Test Environment

#Machine information
OS:MacOS Big Sur/x86_64
CPU:6 CPU cores, Intel(R) Core(TM) i7-9750H CPU @ 2.60GHz
Memory:16.0 GiB

#Go version and settings
Go Version:go1.16.5 darwin/amd64
GOMAXPROCS:12

#Benchmark parameters
TCP connections:300/400/500/600/700
Packet size:512/1024/2048/4096/8192 bytes
Test duration:15s

Echo benchmark

⚠️License

The source code ofgnetshould be distributed under the Apache-2.0 license.

👏 Contributors

Please read theContributing Guidelinesbefore opening a PR and thank you to all the developers who already made contributions tognet!

⚓ Relevant Articles

• A Million WebSockets and Go
• Going Infinite, handling 1M websockets connections in Go
• Go netpoller nguyên sinh internet mô hình chi nguyên mã toàn diện bật mí
• gnet: Một cái nhẹ lượng cấp thả cao tính năng Golang internet kho
• Nhanh nhất Go internet dàn giáo gnet tới rồi!

💰 Backers

Support us with a monthly donation and help us continue our activities.

💎 Sponsors

Become a bronze sponsor with a monthly donation of $10 and get your logo on our README on GitHub.

☕️ Buy me a coffee

Please be sure to leave your name, GitHub account, or other social media accounts when you donate by the following means so that I can add it to the list of donors as a token of my appreciation.

💴 Patrons

🔑 JetBrains OS licenses

gnethad been being developed withGoLandIDE under thefree JetBrains Open Source license(s)granted by JetBrains s.r.o., hence I would like to express my thanks here.

🔋 Sponsorship

This project is supported by: