tasks/internal/goro/package.go

// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
//
// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

// Package goro provides utilities for spawning and subsequently managing the
// liftime(s) of one or more goroutines. This package relies heavily on the
// context package to provide consistent cancellation semantics for long-lived
// goroutines. The goal of this package is to provide a unified way to cancel
// and wait on running goroutines as is often seen in "service" or "daemon"
// types with Start()/Stop() lifecycle functions and to unify the multiplicity
// of approaches that have been adopted over time.
//
//  Note: If you're looking for a short-lived (e.g.  request-scoped) group of
//  transient goroutines, you probably want `errgroup.Group` from
//  https://golang.org/x/sync/errgroup.
package goro