buffer

Documentation

Index

• Variables
• type Buffer
  • func NewBuffer(size uint32) (Buffer, error)
• type Pool
  • func NewPool(bufferCap uint32, maxBufferNumber uint32) (Pool, error)

Variables

var ErrClosedBuffer = errors.New("closed buffer")

ErrClosedBuffer 是表示缓冲器已关闭的错误的变量。

var ErrClosedBufferPool = errors.New("closed buffer pool")

ErrClosedBufferPool 是表示缓冲池已关闭的错误的变量。

Types

type Buffer

type Buffer interface {
	// Cap 用于获取本缓冲器的容量。
	Cap() uint32
	// Len 用于获取本缓冲器中的数据数量。
	Len() uint32
	// Put 用于向缓冲器放入数据。
	// 注意！本方法应该是非阻塞的。
	// 若缓冲器已关闭则会直接返回非nil的错误值。
	Put(datum interface{}) (bool, error)
	// Get 用于从缓冲器获取器。
	// 注意！本方法应该是非阻塞的。
	// 若缓冲器已关闭则会直接返回非nil的错误值。
	Get() (interface{}, error)
	// Close 用于关闭缓冲器。
	// 若缓冲器之前已关闭则返回false，否则返回true。
	Close() bool
	// Closed 用于判断缓冲器是否已关闭。
	Closed() bool
}

Buffer 代表FIFO的缓冲器的接口类型。

func NewBuffer

func NewBuffer(size uint32) (Buffer, error)

NewBuffer 用于创建一个缓冲器。 参数size代表缓冲器的容量。

type Pool

type Pool interface {
	// BufferCap 用于获取池中缓冲器的统一容量。
	BufferCap() uint32
	// MaxBufferNumber 用于获取池中缓冲器的最大数量。
	MaxBufferNumber() uint32
	// BufferNumber 用于获取池中缓冲器的数量。
	BufferNumber() uint32
	// Total 用于获取缓冲池中数据的总数。
	Total() uint64
	// Put 用于向缓冲池放入数据。
	// 注意！本方法应该是阻塞的。
	// 若缓冲池已关闭则会直接返回非nil的错误值。
	Put(datum interface{}) error
	// Get 用于从缓冲池获取数据。
	// 注意！本方法应该是阻塞的。
	// 若缓冲池已关闭则会直接返回非nil的错误值。
	Get() (datum interface{}, err error)
	// Close 用于关闭缓冲池。
	// 若缓冲池之前已关闭则返回false，否则返回true。
	Close() bool
	// Closed 用于判断缓冲池是否已关闭。
	Closed() bool
}

Pool 代表数据缓冲池的接口类型。

func NewPool

func NewPool(
	bufferCap uint32,
	maxBufferNumber uint32) (Pool, error)

NewPool 用于创建一个数据缓冲池。 参数bufferCap代表池内缓冲器的统一容量。 参数maxBufferNumber代表池中最多包含的缓冲器的数量。