README.md

Go library for structured concurrency

This repository is archived. See https://github.com/dottedmag/parallel for the current version.

Structured concurrency helps reasoning about the behaviour of parallel programs. parallel implements structured concurrency for Go.

func subtask(ctx context.Context) error {
    // to be run in parallel
}

type subtaskWithData struct { /* ... * / }

func (swd *subtaskWithData) Run(ctx context.Context) error {
    // to be run in parallel
}

err := parallel.Run(ctx, func(ctx context.Context, spawn parallel.SpawnFn) error {
    swd := &subtaskWithData{}

    // do some synchronous initialization here

    spawn("subtask", parallel.Fail, subtask)
    spawn("subtaskWithData", parallel.Fail, swd.Run)
    return nil
})

Runs initializaiton within parallel.Run(), and then waits until context is canceled, or one of spawned tasks finishes. Panics in goroutines are captured.

See the documentation for additional features:

• subprocess groups without inversion of control
• tasks that may exit and keep the group running
• tasks that may exit and cause the group to stop gracefully

Legal

Copyright Tectonic Labs Ltd.

Licensed under Apache 2.0 license.

Authors:

• Alexey Feldgendler
• Misha Gusarov
• Wojciech Małota-Wójcik