# chanx

**Repository Path**: fufuok/chanx

## Basic Information

- **Project Name**: chanx
- **Description**: 🪐 永不阻塞, 无限缓存的 channel. unbounded chan. forked from smallnest/chanx
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-05-14
- **Last Updated**: 2025-12-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Channel

## README

# 永不阻塞, 无限缓存的 Channel

*A never-blocking, infinitely buffered channel. forked from smallnest/chanx*

Ref: 实现无限缓存的channel | 鸟窝 https://colobu.com/2021/05/11/unbounded-channel-in-go/

## 变动

- 增加初始化可选参数 `maxBufferSize` 
  - 用于限定 RingBuffer 容量上限, 将无限缓存变为永不阻塞的有限缓存队列, 超过限制丢弃数据
    - 不受 `initBufCapacity` 参数影响, RingBuffer 初始化容量最小为 `2`
    - 不包含 `initInCapacity` 和 `initOutCapacity` 的容量
    - 默认为 `0` 表示无限缓冲
- 增加数据丢弃时回调方法: `c.SetOnDiscards(func(T))`
  - 触发 `maxBufferSize` 限制并丢弃数据时, 将数据传给回调方法处理(无限缓存无效)
- 增加动态调整 RingBuffer 容量上限方法: `c.SetMaxBufferSize(0)`
  - 值 <= 0 时恢复为无限缓冲, 返回最终设定的值: 0 或有效上限值
- 增加一些计数方法: `c.BufCapacity()` `c.MaxBufferSize()` `c.Discards()`

## 使用

- Go 1.17.x or below: [v1.2.2](https://github.com/fufuok/chanx/releases/tag/v1.2.2)
- Go generic: latest version

### 安装

```go
go get github.com/fufuok/chanx
```

### 永不阻塞, 无限缓存的 Channel

*Never Block, Infinitely Cached Channel*

```go
package main

import (
	"context"
	"fmt"

	"github.com/fufuok/chanx"
)

func main() {
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()

	ch := chanx.NewUnboundedChan[int](ctx, 10)
	// or
	// ch := chanx.NewUnboundedChanSize[int](ctx, 10, 200, 1000)

	go func() {
		for i := 0; i < 100; i++ {
			ch.In <- i // send values
		}
		close(ch.In) // close In channel
	}()

	for v := range ch.Out { // read values
		fmt.Println(v + 1)
	}
}
```

### 永不阻塞, 带缓存上限的 Channel

*Never block, Channel with buffer size limit*

```go
package main

import (
	"context"
	"fmt"

	"github.com/fufuok/chanx"
)

func main() {
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()

	// 可选参数, 缓冲上限
	const maxBufCapacity = 10
	ch := chanx.NewUnboundedChan[int](ctx, 10, maxBufCapacity)
	// or
	// ch := chanx.NewUnboundedChanSize[int](ctx, 10, 10, 10, maxBufCapacity)

	// 有缓冲上限时, 可选设置数据丢弃时回调
	ch.SetOnDiscards(func(v int) {
		fmt.Println("discard: ", v)
	})

	go func() {
		for i := 0; i < 100; i++ {
			ch.In <- i // send values
		}
		close(ch.In) // close In channel
	}()

	for v := range ch.Out { // read values
		fmt.Println(v + 1)
	}
}
```



# chanx

Unbounded chan with ringbuffer.

[![License](https://img.shields.io/:license-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![GoDoc](https://godoc.org/github.com/smallnest/chanx?status.png)](http://godoc.org/github.com/smallnest/chanx)  [![travis](https://travis-ci.org/smallnest/chanx.svg?branch=main)](https://travis-ci.org/smallnest/chanx) [![Go Report Card](https://goreportcard.com/badge/github.com/smallnest/chanx)](https://goreportcard.com/report/github.com/smallnest/chanx) [![coveralls](https://coveralls.io/repos/smallnest/chanx/badge.svg?branch=main&service=github)](https://coveralls.io/github/smallnest/chanx?branch=main) 

Refer to the below articles and issues:
1. https://github.com/golang/go/issues/20352
2. https://stackoverflow.com/questions/41906146/why-go-channels-limit-the-buffer-size
3. https://medium.com/capital-one-tech/building-an-unbounded-channel-in-go-789e175cd2cd
4. https://erikwinter.nl/articles/2020/channel-with-infinite-buffer-in-golang/