gnet README

The project's README from github.com/panjf2000/gnet. As one markdown file: README.md.

gnet

panjf2000%2Fgnet | Trendshift

English | 中文

🎉🎉🎉 Feel free to join the channels about gnet on the Discord Server.

📖 Introduction

gnet is an event-driven networking framework that is ultra-fast and lightweight. It is built from scratch by exploiting epoll and kqueue and it can achieve much higher performance with lower memory consumption than Go net in many specific scenarios.

gnet and net don't share the same philosophy in network programming. Thus, building network applications with gnet can be significantly different from building them with net, and the philosophies can't be reconciled. There are other similar products written in other programming languages in the community, such as libuv, netty, twisted, tornado, etc. which work in a similar pattern as gnet under the hood.

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

gnet sells 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 upon gnet for building diversified network services. For instance, you get an HTTP Server if you implement HTTP protocol upon gnet while you have a Redis Server done with the implementation of Redis protocol upon gnet and so on.

gnet derives from the project: evio with much higher performance and more features.

🚀 Features

🦖 Milestones

🕊 Roadmap

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

🎬 Getting started

gnet is available as a Go module and we highly recommend that you use gnet via Go Modules, with Go 1.11 Modules enabled (Go 1.11+), you can just simply add import "github.com/panjf2000/gnet/v2" to the codebase and run go mod download/go mod tidy or go [build|run|test] to download the necessary dependencies automatically.

With v2

go get -u github.com/panjf2000/gnet/v2

With v1

go get -u github.com/panjf2000/gnet

🎡 Use cases

The following corporations/organizations use gnet as the underlying network service in production.

If you're also using gnet in 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 top 50 out of 486 frameworks that encompass various programming languages worldwide, in which gnet is ranked first.

This is the full framework ranking of Go and gnet tops all the other frameworks, which makes gnet the fastest networking framework in Go.

To see the full ranking list, visit TechEmpower Benchmark Round 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)

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

On MacOS (kqueue)

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

Combat with Rust

⚠️ License

The source code of gnet should be distributed under the Apache-2.0 license.

👏 Contributors

Please read the Contributing Guidelines before opening a PR and thank you to all the developers who already made contributions to gnet!

⚓ Relevant Articles

☕️ 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.

By me coffee Patreon OpenCollective

🔑 JetBrains OS licenses

gnet has been being developed with GoLand IDE under the free JetBrains Open Source license(s) granted by JetBrains s.r.o., hence I would like to express my thanks here.

JetBrains logo.

🔋 Sponsorship

DigitalOcean Referral Badge

gnet (panjf2000/gnet)

Searching Database…

11.2K ·GitHub
Gnet
Что это такое?gnet — это высокопроизводительный, легковесный, неблокирующий событийно-ориентированный фреймворк для работы с сетью, написанный на чистом Go. Он построен на epoll и kqueue и работает на транспортном уровне с TCP, UDP и Unix Domain Socket.
Это фреймворк или просто обёртка над пакетом net из Go?Это самостоятельный фреймворк со своей философией, а не замена пакета net из Go. Поверх ядра gnet для TCP, UDP и сокетов Unix вы строите собственный протокол прикладного уровня (HTTP, RPC, WebSocket, Redis и т. д.).
Как добавить это в проект на Go?Добавьте import 'github.com/panjf2000/gnet/v2' в свою кодовую базу, затем выполните go mod download/go mod tidy (или просто go build/run/test), чтобы загрузить его, так как gnet распространяется как модуль Go.
Нужна ли определённая версия Go?Нужен Go 1.11+ с включёнными Go Modules; никаких других внешних зависимостей для использования не требуется.
Есть ли подводные камни, которые стоит знать, прежде чем использовать это в продакшене?Сборка для Windows явно предназначена только для разработки и тестирования, но не для продакшена, а поддержка TLS пока в планах и сегодня недоступна.
На каких операционных системах это реально работает?Работает на Linux, macOS, Windows и нескольких вариантах BSD (Darwin, DragonFlyBSD, FreeBSD, NetBSD, OpenBSD), используя epoll в Linux и kqueue в BSD и macOS.
Зачем использовать gnet вместо стандартного пакета net в Go?gnet жертвует универсальностью net ради максимальной скорости и меньшего расхода памяти в сценариях, где производительность критична: он напрямую использует epoll и kqueue вместо API net, построенного в блокирующем стиле.
Какие протоколы я реально могу построить с помощью gnet?Любые протоколы прикладного уровня поверх TCP, UDP и сокетов Unix: в README есть примеры серверов HTTP, RPC, WebSocket и Redis, реализованных непосредственно на gnet.
Насколько gnet быстрее других фреймворков?gnet возглавил таблицу лидеров TechEmpower Benchmark Round 22 среди 486 фреймворков разных языков и описывается как самый быстрый сетевой фреймворк на Go.
Что делает встроенный пул горутин?gnet поставляется с пулом горутин на основе библиотеки ants и работает без блокировок на протяжении всего времени выполнения, что помогает избежать накладных расходов на создание горутины для каждого соединения.
What are similar projects?libuv, libevent, workerman, vert.x, muduo, swoole-src, tokio, zenc
Which topics is it in?asynchronous, udp, tcp, event-driven, network, unix, async, high-performance, golang, bsd, networking, performance
Creator
panjf2000
Size
44.4 MB
Stars
11.2K
Updated
CommitJul 03Releasev2.10.0Jul 03
Age
7y
Commits · 90 Days