README
¶
concurrentloop
concurrentloop provides a function to call a function concurrently powered by generics, channels, and goroutines.
Install
$ go get github.com/thalesfsp/concurrentloop
Specific version
Example: $ go get github.com/thalesfsp/concurrentloop@v1.2.0
Usage
See example_test.go, and concurrentloop_test.go file.
Documentation
Run $ make doc or check out online.
Development
Check out CONTRIBUTION.
Release
- Update CHANGELOG accordingly.
- Once changes from MR are merged.
- Tag and release.
Roadmap
Check out CHANGELOG.
Documentation
¶
Overview ¶
Package concurrentloop provides a function to call a function concurrently powered by generics, channels, and goroutines.
Index ¶
- Constants
- func ExecuteCh[T any](ctx context.Context, fns []ExecuteFunc[T]) chan ResultCh[T]
- func Flatten2D[T any](data [][]T) []T
- func RemoveZeroValues[T any](removeZeroValues bool, results []T) []T
- type Errors
- func Execute[T any](ctx context.Context, fns []ExecuteFunc[T]) ([]T, Errors)
- func Map[T any, Result any](ctx context.Context, items []T, f MapFunc[T, Result], opts ...Func) ([]Result, Errors)
- func MapM[T any, Result any](ctx context.Context, itemsMap map[string]T, f MapMFunc[T, Result], ...) ([]Result, Errors)
- type ExecuteFunc
- type Func
- type MapFunc
- type MapMFunc
- type Option
- type ResultCh
Constants ¶
const Name = "concurrentloop"
Name of the package.
Variables ¶
This section is empty.
Functions ¶
func ExecuteCh ¶ added in v1.1.1
func ExecuteCh[T any](ctx context.Context, fns []ExecuteFunc[T]) chan ResultCh[T]
ExecuteCh calls the `fns` concurrently.
NOTE: It's the caller's responsibility to close the channel.
func Flatten2D ¶ added in v1.2.5
func Flatten2D[T any](data [][]T) []T
Flatten2D takes a 2D slice and returns a 1D slice containing all the elements.
func RemoveZeroValues ¶ added in v1.1.9
RemoveZeroValues removes zero values from the results.
Types ¶
type Errors ¶ added in v1.1.0
type Errors []error
Errors is a slice of errors.
func Execute ¶ added in v1.1.1
func Execute[T any](ctx context.Context, fns []ExecuteFunc[T]) ([]T, Errors)
Execute calls the `fns` concurrently, and returns the results and any errors that occurred. The function blocks until all executions have completed.
NOTE: Order is may preserved.
func Map ¶ added in v1.1.1
func Map[T any, Result any]( ctx context.Context, items []T, f MapFunc[T, Result], opts ...Func, ) ([]Result, Errors)
Map concurrently applies a function `f` to each element in the slice `items` and returns the resulting slice and any errors that occurred. `f` should be of type MapFunc.
The function takes an optional number of `Func` options that allow you to customize the behavior of the function.
If an error occurs during execution of `f`, it is stored and returned along with the results. The order of the results matches the order of the input slice.
If any of the operations are cancelled by the context, the function will panic.
Usage example:
type MyStruct struct { ... }
func process(ctx context.Context, s MyStruct) (ResultType, error) { ... }
items := []MyStruct{...}
ctx := context.Background()
results, errs := Map(ctx, items, process)
if errs != nil {
// handle errors
}
// process results
Note: Because the function executes concurrently, the functions you provide must be safe for concurrent use.
func MapM ¶ added in v1.1.14
func MapM[T any, Result any]( ctx context.Context, itemsMap map[string]T, f MapMFunc[T, Result], opts ...Func, ) ([]Result, Errors)
MapM concurrently applies a function `f` to each element in the map `itemMaps` and returns the resulting slice and any errors that occurred. `f` should be of type MapMFunc.
type ExecuteFunc ¶ added in v1.1.1
ExecuteFunc is the type of the function that will be executed concurrently for each element in a slice of type `T`. The function takes a `context.Context` and a value of type `T`, and returns a value of type `Result` and an error value.
type Func ¶ added in v1.0.1
Func allows to specify message's options.
func WithBatchSize ¶ added in v1.2.0
WithBatchSize sets the size of the batch.
func WithLimit ¶ added in v1.1.12
WithLimit sets the max amount of results to collect before stopping the loop.
func WithRandomDelayTime ¶ added in v1.2.1
WithRandomDelayTime sets the random delay time between each iteration.
func WithRemoveZeroValues ¶ added in v1.1.11
WithRemoveZeroValues if set to true removes zero values from the results.
type MapFunc ¶ added in v1.1.1
MapFunc is the type of the function that will be executed concurrently for each element in a slice of type `T`. The function takes a `context.Context` and a value of type `T`, and returns a value of type `Result` and an error value.
type MapMFunc ¶ added in v1.1.14
MapMFunc is the type of the function that will be executed concurrently for each element in the map.
type Option ¶ added in v1.1.7
type Option struct {
// BatchSize is the size of the batch.
BatchSize int
// The max amount of results to collect before
Limit int
// RandomDelayTimeDuration is the unit of the duration (Second, Millisecond, etc.)
RandomDelayTimeDuration time.Duration
// RandomDelayTimeMax is the upper limit.
RandomDelayTimeMax int
// RandomDelayTimeMin is the lower limit.
RandomDelayTimeMin int
// RemoveZeroValues indicates whether to remove zero values from the results.
RemoveZeroValues bool
}
Option for the concurrent loop.
Source Files