Buffer

package
v0.2.27 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 21, 2024 License: MIT Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Buffer

type Buffer[T any] struct {
	// contains filtered or unexported fields
}

Buffer is a thread-safe, generic data structure that allows multiple goroutines to produce and consume elements in a synchronized manner. It is implemented as a queue and uses channels to synchronize the goroutines. The Buffer should be initialized with the Init method before use.

func (*Buffer[T]) CleanBuffer

func (b *Buffer[T]) CleanBuffer()

CleanBuffer removes all elements from the Buffer, effectively resetting it to an empty state. Precalculated elements are kept as they are no longer in the buffer but in the channel. It locks the firstMutex to ensure thread-safety during the operation.

This method is safe for concurrent use by multiple goroutines.

func (*Buffer[T]) GetReceiveChannel

func (b *Buffer[T]) GetReceiveChannel() <-chan T

GetReceiveChannel returns the receive-only channel of the Buffer.

This method is safe for concurrent use by multiple goroutines.

Returns:

  • <-chan T: The receive-only channel of the Buffer.

func (*Buffer[T]) GetSendChannel

func (b *Buffer[T]) GetSendChannel() chan<- T

GetSendChannel returns the send-only channel of the Buffer.

This method is safe for concurrent use by multiple goroutines.

Returns:

  • chan<- T: The send-only channel of the Buffer.

func (*Buffer[T]) Init

func (b *Buffer[T]) Init(bufferSize int) error

Init initializes a Buffer instance. It ensures the initialization is done only once, even if called multiple times. It creates two channels and a condition variable, and starts two goroutines:

  • one that listens for incoming messages on the send channel and adds them to the Buffer.
  • another that sends messages from the Buffer to the receive channel.

This method should be called before using the Buffer.

Parameters:

  • bufferSize: The size of the buffer for the send and receive channels. Must be a non-negative integer. If a negative integer is provided, the method will panic with an *ers.InvalidParameterError.

Returns:

  • error: An error of type *ers.InvalidParameterError if the buffer size is negative.

Information: To close the buffer, just close the send-only channel. Once that is done, a cascade of events will happen:

  • The goroutine that listens for incoming messages will stop listening and exit.
  • The goroutine that sends messages from the Buffer to the receive channel will stop sending messages once the Buffer is empty, and then exit.
  • The Buffer will be cleaned up.

func (*Buffer[T]) Wait

func (b *Buffer[T]) Wait()

Wait is a method of the Buffer type that waits for all goroutines launched by the Buffer to finish executing.

This method is thread-safe and can be called from multiple goroutines.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL