Repository: panjf2000/ants

Stars: 14394

README.md

<p align="center">
<img src="https://raw.githubusercontent.com/panjf2000/logos/master/ants/logo.png" />
<b>A goroutine pool for Go</b>
<br/><br/>
<a title="Build Status" target="_blank" href="https://github.com/panjf2000/ants/actions?query=workflow%3ATests"><img src="https://img.shields.io/github/actions/workflow/status/panjf2000/ants/test.yml?branch=master&style=flat-square&logo=github-actions" /></a>
<a title="Codecov" target="_blank" href="https://codecov.io/gh/panjf2000/ants"><img src="https://img.shields.io/codecov/c/github/panjf2000/ants?style=flat-square&logo=codecov" /></a>
<a title="Release" target="_blank" href="https://github.com/panjf2000/ants/releases"><img src="https://img.shields.io/github/v/release/panjf2000/ants.svg?color=161823&style=flat-square&logo=smartthings" /></a>
<a title="Tag" target="_blank" href="https://github.com/panjf2000/ants/tags"><img src="https://img.shields.io/github/v/tag/panjf2000/ants?color=%23ff8936&logo=fitbit&style=flat-square" /></a>
<br/>
<a title="Minimum Go Version" target="_blank" href="https://github.com/panjf2000/gnet"><img src="https://img.shields.io/badge/go-%3E%3D1.19-30dff3?style=flat-square&logo=go" /></a>
<a title="Go Report Card" target="_blank" href="https://goreportcard.com/report/github.com/panjf2000/ants"><img src="https://goreportcard.com/badge/github.com/panjf2000/ants?style=flat-square" /></a>
<a title="Doc for ants" target="_blank" href="https://pkg.go.dev/github.com/panjf2000/ants/v2?tab=doc"><img src="https://img.shields.io/badge/go.dev-doc-007d9c?style=flat-square&logo=read-the-docs" /></a>
<a title="Mentioned in Awesome Go" target="_blank" href="https://github.com/avelino/awesome-go#goroutines"><img src="https://awesome.re/mentioned-badge-flat.svg" /></a>
</p>

English | 中文

📖 Introduction

Library ants implements a goroutine pool with fixed capacity, managing and recycling a massive number of goroutines, allowing developers to limit the number of goroutines in your concurrent programs.

🚀 Features:

- Managing and recycling a massive number of goroutines automatically
- Purging overdue goroutines periodically
- Abundant APIs: submitting tasks, getting the number of running goroutines, tuning the capacity of the pool dynamically, releasing the pool, rebooting the pool, etc.
- Handle panic gracefully to prevent programs from crash
- Efficient in memory usage and it may even achieve higher performance than unlimited goroutines in Go
- Nonblocking mechanism
- Preallocated memory (ring buffer, optional)

💡 How `ants` works

Flow Diagram

Activity Diagrams

![](https://raw.githubusercontent.com/panjf2000/illustrations/master/go/ants-pool-1.png)

![](https://raw.githubusercontent.com/panjf2000/illustrations/master/go/ants-pool-2.png)

![](https://raw.githubusercontent.com/panjf2000/illustrations/master/go/ants-pool-3.png)

![](https://raw.githubusercontent.com/panjf2000/illustrations/master/go/ants-pool-4.png)

🧰 How to install

For `ants` v1

``powershell go get -u github.com/panjf2000/ants

text

For ants v2 (with GO111MODULE=on)

powershell
go get -u github.com/panjf2000/ants/v2
text
🛠 How to use 

Check out the examples for basic usage.
Functional options for pool 
ants.Optionscontains all optional configurations of the ants pool, which allows you to customize the goroutine pool by invoking option functions to set up each configuration in NewPool/NewPoolWithFunc/NewPoolWithFuncGeneric method.
Check out ants.Options and ants.Option for more details.
Customize pool capacity 
ants supports customizing the capacity of the pool. You can call the NewPool method to instantiate a Pool with a given capacity, as follows:
 go
p, _ := ants.NewPool(10000)
text
Submit tasks 

Tasks can be submitted by calling ants.Submit
go
ants.Submit(func(){})
text
Tune pool capacity at runtime 

You can tune the capacity of ants pool at runtime with ants.Tune:
 go
pool.Tune(1000) // Tune its capacity to 1000
pool.Tune(100000) // Tune its capacity to 100000
text
Don't worry about the contention problems in this case, the method here is thread-safe (or should be called goroutine-safe).
Pre-malloc goroutine queue in pool 
ants allows you to pre-allocate the memory of the goroutine queue in the pool, which may get a performance enhancement under some special certain circumstances such as the scenario that requires a pool with ultra-large capacity, meanwhile, each task in goroutine lasts for a long time, in this case, pre-mallocing will reduce a lot of memory allocation in goroutine queue.
go
// ants will pre-malloc the whole capacity of pool when calling ants.NewPool.
p, _ := ants.NewPool(100000, ants.WithPreAlloc(true))
text
Release pool 
go
pool.Release()
text
or
go
pool.ReleaseTimeout(time.Second * 3)
text
Reboot pool 
go
// A pool that has been released can be still used after calling the Reboot().
pool.Reboot()


⚙️ About sequence

All tasks submitted to ants pool will not be guaranteed to be addressed in order, because those tasks scatter among a series of concurrent workers, thus those tasks would be executed concurrently.

`👏 Contributors`

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

<a href="https://github.com/panjf2000/ants/graphs/contributors"> <img src="https://contrib.rocks/image?repo=panjf2000/ants" /> </a>

`📄 License`

The source code in ants is available under the MIT License.

`📚 Relevant Articles`

- Goroutine 并发调度模型深度解析之手撸一个高性能 goroutine 池 - Visually Understanding Worker Pool - The Case For A Go Worker Pool - Go Concurrency - GoRoutines, Worker Pools and Throttling Made Simple

`🖥 Use cases`

`business corporations & open-source organizations`

Trusted by the following corporations/organizations.

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

`open-source software`

The open-source projects below do concurrent programming with the help of ants.

- gnet: A high-performance, lightweight, non-blocking, event-driven networking framework written in pure Go. - milvus: An open-source vector database for scalable similarity search and AI applications. - nps: A lightweight, high-performance, powerful intranet penetration proxy server, with a powerful web management terminal. - TDengine: TDengine is an open source, high-performance, cloud native time-series database optimized for Internet of Things (IoT), Connected Cars, and Industrial IoT. - siyuan: SiYuan is a local-first personal knowledge management system that supports complete offline use, as well as end-to-end encrypted synchronization. - BillionMail: A future open-source Mail server, Email marketing platform designed to help businesses and individuals manage their email campaigns with ease. - WeKnora: An LLM-powered framework designed for deep document understanding and semantic retrieval, especially for handling complex, heterogeneous documents. - coze-loop: A developer-oriented, platform-level solution focused on the development and operation of AI agents. - osmedeus: A Workflow Engine for Offensive Security. - jitsu: An open-source Segment alternative. Fully-scriptable data ingestion engine for modern data teams. Set-up a real-time data pipeline in minutes, not days. - triangula: Generate high-quality triangulated and polygonal art from images. - teler: Real-time HTTP Intrusion Detection. - bsc: A Binance Smart Chain client based on the go-ethereum fork. - jaeles: The Swiss Army knife for automated Web Application Testing. - devlake: The open-source dev data platform & dashboard for your DevOps tools. - matrixone: MatrixOne is a future-oriented hyper-converged cloud and edge native DBMS that supports transactional, analytical, and streaming workloads with a simplified and distributed database engine, across multiple data centers, clouds, edges and other heterogeneous infrastructures. - bk-bcs: BlueKing Container Service (BCS, same below) is a container management and orchestration platform for the micro-services under the BlueKing ecosystem. - trueblocks-core: TrueBlocks improves access to blockchain data for any EVM-compatible chain (particularly Ethereum mainnet) while remaining entirely local. - openGemini: openGemini is an open-source,cloud-native time-series database(TSDB) that can be widely used in IoT, Internet of Vehicles(IoV), O&M monitoring, and industrial Internet scenarios. - AdGuardDNS: AdGuard DNS is an alternative solution for tracker blocking, privacy protection, and parental control. - WatchAD2.0: WatchAD2.0 是 360 信息安全中心开发的一款针对域安全的日志分析与监控系统，它可以收集所有域控上的事件日志、网络流量，通过特征匹配、协议分析、历史行为、敏感操作和蜜罐账户等方式来检测各种已知与未知威胁，功能覆盖了大部分目前的常见内网域渗透手法。 - vanus: Vanus is a Serverless, event streaming system with processing capabilities. It easily connects SaaS, Cloud Services, and Databases to help users build next-gen Event-driven Applications. - trpc-go: A pluggable, high-performance RPC framework written in Golang. - motan-go: Motan is a cross-language remote procedure call(RPC) framework for rapid development of high performance distributed services. motan-go is the golang implementation of Motan.

#### All use cases:

- Repositories that depend on ants/v2

- Repositories that depend on ants/v1

If you have ants integrated into projects, feel free to open a pull request refreshing this list of use cases.

`🔋 JetBrains OS licenses`

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

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

🔋 Sponsorship

![DigitalOcean Referral Badge](https://www.digitalocean.com/?refcode=5d8774f42124&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge)

ants

Repository: panjf2000/ants

Stars: 14394

README.md

📖 Introduction

🚀 Features:

💡 How `ants` works

Flow Diagram

Activity Diagrams

🧰 How to install

For `ants` v1

`For` ants `v2 (with GO111MODULE=on)`

🛠 How to use

Functional options for pool

`Customize pool capacity`

Submit tasks

Tune pool capacity at runtime

Pre-malloc goroutine queue in pool

Release pool

Reboot pool

⚙️ About sequence

`👏 Contributors`

`📄 License`

`📚 Relevant Articles`

`🖥 Use cases`

`business corporations & open-source organizations`

`open-source software`

`🔋 JetBrains OS licenses`

☕️ Buy me a coffee

🔋 Sponsorship

Repository: panjf2000/ants

Stars: 14394

README.md Copy Chapter

📖 Introduction Copy Chapter

🚀 Features: Copy Chapter

💡 How ants works ants works')" title="Copy chapter prompt for LLMs"> Copy Chapter

Flow Diagram Copy Section

Activity Diagrams Copy Section

🧰 How to install Copy Chapter

For ants v1 ants v1')" title="Copy section prompt for LLMs"> Copy Section

For ants v2 (with GO111MODULE=on) v2 (with GO111MODULE=on)')" title="Copy section prompt for LLMs"> Copy Section

🛠 How to use Copy Chapter

Functional options for pool Copy Section

Customize pool capacity Copy Section

Submit tasks Copy Section

Tune pool capacity at runtime Copy Section

Pre-malloc goroutine queue in pool Copy Section

Release pool Copy Section

Reboot pool Copy Section

⚙️ About sequence Copy Chapter

👏 Contributors Copy Chapter

📄 License Copy Chapter

📚 Relevant Articles Copy Chapter

🖥 Use cases Copy Chapter

business corporations & open-source organizations Copy Section

open-source software Copy Section

🔋 JetBrains OS licenses Copy Chapter

☕️ Buy me a coffee Copy Chapter

🔋 Sponsorship Copy Chapter

Explore Related Technologies & Topics

README.md

📖 Introduction

🚀 Features:

💡 How `ants` works

Flow Diagram

Activity Diagrams

🧰 How to install

For `ants` v1

`For` ants `v2 (with GO111MODULE=on)`

🛠 How to use

Functional options for pool

`Customize pool capacity`

Submit tasks

Tune pool capacity at runtime

Pre-malloc goroutine queue in pool

Release pool

Reboot pool

⚙️ About sequence

`👏 Contributors`

`📄 License`

`📚 Relevant Articles`

`🖥 Use cases`

`business corporations & open-source organizations`

`open-source software`

`🔋 JetBrains OS licenses`

☕️ Buy me a coffee

🔋 Sponsorship