README

<b>A goroutine pool for Go</b>

</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

🧰 How to install

For `ants` v1

powershell

go get -u github.com/panjf2000/ants

For `ants` v2 (with GO111MODULE=on)

powershell

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

🛠 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:

p, _ := ants.NewPool(10000)

Submit tasks

Tasks can be submitted by calling ants.Submit

ants.Submit(func(){})

Tune pool capacity at runtime

You can tune the capacity of ants pool at runtime with ants.Tune:

pool.Tune(1000) // Tune its capacity to 1000
pool.Tune(100000) // Tune its capacity to 100000

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.

// ants will pre-malloc the whole capacity of pool when calling ants.NewPool.
p, _ := ants.NewPool(100000, ants.WithPreAlloc(true))

Release pool

pool.Release()

pool.ReleaseTimeout(time.Second * 3)

Reboot pool

// 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!

📄 License

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

📚 Relevant Articles

🖥 Use cases

business corporations & open-source organizations

Trusted by the following corporations/organizations.

    </a>
  </td>
  <td align="center" valign="middle">
    <a href="https://www.bytedance.com/" target="_blank">
      
    </a>
  </td>
  <td align="center" valign="middle">
    <a href="https://tieba.baidu.com/" target="_blank">
      
    </a>
  </td>
  <td align="center" valign="middle">
    <a href="https://weibo.com/" target="_blank">
      
    </a>
  </td>
</tr>
<tr>
  <td align="center" valign="middle">
    <a href="https://www.tencentmusic.com/en-us/" target="_blank">
      
    </a>
  </td>
  <td align="center" valign="middle">
    <a href="https://www.futuhk.com/en/" target="_blank">
      
    </a>
  </td>
  <td align="center" valign="middle">
    <a href="https://www.shopify.com/" target="_blank">
      
    </a>
  </td>
  <td align="center" valign="middle">
    <a href="https://www.wechat.com/en/" target="_blank">
      
    </a>
  </td>
</tr>
<tr>
  <td align="center" valign="middle">
    <a href="https://www.baidu.com/" target="_blank">
      
    </a>
  </td>
  <td align="center" valign="middle">
    <a href="https://www.360.com/" target="_blank">
      
    </a>
  </td>
  <td align="center" valign="middle">
    <a href="https://www.huaweicloud.com/intl/en-us/" target="_blank">
      
    </a>
  </td>
  <td align="center" valign="middle">
    <a href="https://www.matrixorigin.io/" target="_blank">
      
    </a>
  </td>
</tr>
<tr>
  <td align="center" valign="middle">
    <a href="https://adguard-dns.io/" target="_blank">
      
    </a>
  </td>
  <td align="center" valign="middle">
    <a href="https://bk.tencent.com/" target="_blank">
      
    </a>
  </td>
  <td align="center" valign="middle">
    <a href="https://www.alibabacloud.com/" target="_blank">
      
    </a>
  </td>
  <td align="center" valign="middle">
    <a href="https://www.zuoyebang.com/" target="_blank">
      
    </a>
  </td>
</tr>
<tr>
  <td align="center" valign="middle">
    <a href="https://www.antgroup.com/en/" target="_blank">
      
    </a>
  </td>
  <td align="center" valign="middle">
    <a href="https://zilliz.com/" target="_blank">
      
    </a>
  </td>
  </td>
  <td align="center" valign="middle">
    <a href="https://amap.com/" target="_blank">
      
    </a>
  </td>
  <td align="center" valign="middle">
    <a href="https://www.apache.org/" target="_blank">
      
    </a>
  </td>
</tr>
<tr>
  <td align="center" valign="middle">
    <a href="https://www.coze.com/" target="_blank">
      
    </a>
  </td>
</tr>

</tbody> </table>

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:

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.

    </a>
  </td>
  <td align="center" valign="middle">
    <a target="_blank" href="https://www.patreon.com/panjf2000">
      
    </a>
  </td>
  <td align="center" valign="middle">
    <a target="_blank" href="https://opencollective.com/panjf2000">
      
    </a>
  </td>
</tr>