README
¶
Buffer
buffer 提供了缓冲区相关的实用程序。
包括创建、读取和写入缓冲区的函数。
这个包还提供了一个无界缓冲区的实现，可以在不使用额外 goroutine 的情况下实现无界缓冲区。
无界缓冲区的所有方法都是线程安全的，除了用于同步的互斥锁外，不会阻塞任何东西。
目录导航
列出了该 package 下所有的函数及类型定义，可通过目录导航进行快捷跳转 ❤️
展开 / 折叠目录导航
包级函数定义
| 函数名称 | 描述 |
|---|---|
| NewRing | 创建一个并发不安全的环形缓冲区 |
| NewRingUnbounded | 创建一个并发安全的基于环形缓冲区实现的无界缓冲区 |
| NewUnbounded | 创建一个无界缓冲区 |
类型定义
| 类型 | 名称 | 描述 |
|---|---|---|
STRUCT |
Ring | 环形缓冲区 |
STRUCT |
RingUnbounded | 基于环形缓冲区实现的无界缓冲区 |
STRUCT |
Unbounded | 是无界缓冲区的实现 |
详情信息
func NewRing[T any](initSize ...int) *Ring[T]
创建一个并发不安全的环形缓冲区
- initSize: 初始容量
当初始容量小于 2 或未设置时，将会使用默认容量 2
查看 / 收起单元测试
func TestNewRing(t *testing.T) {
ring := buffer.NewRing[int]()
for i := 0; i < 100; i++ {
ring.Write(i)
t.Log(ring.Read())
}
}
func NewRingUnbounded[T any](bufferSize int) *RingUnbounded[T]
创建一个并发安全的基于环形缓冲区实现的无界缓冲区
func NewUnbounded[V any]() *Unbounded[V]
创建一个无界缓冲区
- generateNil: 生成空值的函数，该函数仅需始终返回 nil 即可
该缓冲区来源于 gRPC 的实现，用于在不使用额外 goroutine 的情况下实现无界缓冲区
- 该缓冲区的所有方法都是线程安全的，除了用于同步的互斥锁外，不会阻塞任何东西
Ring STRUCT
环形缓冲区
type Ring[T any] struct {
buf []T
initSize int
size int
r int
w int
}
func (*Ring) Read() ( T, error)
读取数据
查看 / 收起基准测试
func BenchmarkRing_Read(b *testing.B) {
ring := buffer.NewRing[int](1024)
for i := 0; i < b.N; i++ {
ring.Write(i)
}
b.ResetTimer()
for i := 0; i < b.N; i++ {
_, _ = ring.Read()
}
}
func (*Ring) ReadAll() []T
读取所有数据
func (*Ring) Peek() (t T, err error)
查看数据
func (*Ring) Write(v T)
写入数据
查看 / 收起基准测试
func BenchmarkRing_Write(b *testing.B) {
ring := buffer.NewRing[int](1024)
b.ResetTimer()
for i := 0; i < b.N; i++ {
ring.Write(i)
}
}
func (*Ring) IsEmpty() bool
是否为空
func (*Ring) Cap() int
返回缓冲区容量
func (*Ring) Len() int
返回缓冲区长度
func (*Ring) Reset()
重置缓冲区
RingUnbounded STRUCT
基于环形缓冲区实现的无界缓冲区
type RingUnbounded[T any] struct {
ring *Ring[T]
rrm sync.Mutex
cond *sync.Cond
rc chan T
closed bool
closedMutex sync.RWMutex
closedSignal chan struct{}
}
func (*RingUnbounded) Write(v T)
写入数据
查看 / 收起基准测试
func BenchmarkRingUnbounded_Write(b *testing.B) {
ring := buffer.NewRingUnbounded[int](1024 * 16)
b.ResetTimer()
for i := 0; i < b.N; i++ {
ring.Write(i)
}
}
func (*RingUnbounded) Read() chan T
读取数据
查看 / 收起基准测试
func BenchmarkRingUnbounded_Read(b *testing.B) {
ring := buffer.NewRingUnbounded[int](1024 * 16)
for i := 0; i < b.N; i++ {
ring.Write(i)
}
b.ResetTimer()
for i := 0; i < b.N; i++ {
<-ring.Read()
}
}
func (*RingUnbounded) Closed() bool
判断缓冲区是否已关闭
func (*RingUnbounded) Close() chan struct {}
关闭缓冲区，关闭后将不再接收新数据，但是已有数据仍然可以读取
查看 / 收起单元测试
func TestRingUnbounded_Close(t *testing.T) {
ring := buffer.NewRingUnbounded[int](1024 * 16)
for i := 0; i < 100; i++ {
ring.Write(i)
}
t.Log("write done")
ring.Close()
t.Log("close done")
for v := range ring.Read() {
ring.Write(v)
t.Log(v)
}
t.Log("read done")
}
Unbounded STRUCT
是无界缓冲区的实现
type Unbounded[V any] struct {
c chan V
closed bool
mu sync.Mutex
backlog []V
}
func (*Unbounded) Put(t V)
将数据放入缓冲区
func (*Unbounded) Load()
将缓冲区中的数据发送到读取通道中，如果缓冲区中没有数据，则不会发送
- 在每次 Get 后都应该执行该函数
func (*Unbounded) Get() chan V
获取读取通道
查看 / 收起单元测试
func TestUnbounded_Get(t *testing.T) {
ub := buffer.NewUnbounded[int]()
for i := 0; i < 100; i++ {
ub.Put(i + 1)
fmt.Println(<-ub.Get())
ub.Load()
}
}
func (*Unbounded) Close()
关闭
func (*Unbounded) IsClosed() bool
是否已关闭
Documentation
¶
Overview ¶
Package buffer 提供了缓冲区相关的实用程序。
包括创建、读取和写入缓冲区的函数。
这个包还提供了一个无界缓冲区的实现，可以在不使用额外 goroutine 的情况下实现无界缓冲区。
无界缓冲区的所有方法都是线程安全的，除了用于同步的互斥锁外，不会阻塞任何东西。
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var (
ErrBufferIsEmpty = errors.New("buffer is empty")
)
Functions ¶
This section is empty.
Types ¶
type Ring ¶
type Ring[T any] struct { // contains filtered or unexported fields }
Ring 环形缓冲区
type RingUnbounded ¶ added in v0.5.0
type RingUnbounded[T any] struct { // contains filtered or unexported fields }
RingUnbounded 基于环形缓冲区实现的无界缓冲区
func NewRingUnbounded ¶ added in v0.5.0
func NewRingUnbounded[T any](bufferSize int) *RingUnbounded[T]
NewRingUnbounded 创建一个并发安全的基于环形缓冲区实现的无界缓冲区
func (*RingUnbounded[T]) Close ¶ added in v0.5.0
func (b *RingUnbounded[T]) Close() <-chan struct{}
Close 关闭缓冲区，关闭后将不再接收新数据，但是已有数据仍然可以读取
func (*RingUnbounded[T]) Closed ¶ added in v0.5.0
func (b *RingUnbounded[T]) Closed() bool
Closed 判断缓冲区是否已关闭
func (*RingUnbounded[T]) Read ¶ added in v0.5.0
func (b *RingUnbounded[T]) Read() <-chan T
Read 读取数据
type Unbounded ¶
type Unbounded[V any] struct { // contains filtered or unexported fields }
Unbounded 是无界缓冲区的实现
func NewUnbounded ¶
NewUnbounded 创建一个无界缓冲区
- generateNil: 生成空值的函数，该函数仅需始终返回 nil 即可
该缓冲区来源于 gRPC 的实现，用于在不使用额外 goroutine 的情况下实现无界缓冲区
- 该缓冲区的所有方法都是线程安全的，除了用于同步的互斥锁外，不会阻塞任何东西
Source Files
Click to show internal directories.
Click to hide internal directories.