Files
tasks/common/goro/goro.go
Alex ShtinandGitHub 8e8f1b0f7c Remove license header from every file (#7689)
## What changed?
<!-- Describe what has changed in this PR -->
Remove license header from every file. Because it is really hard to
follow in this PR here is the summary:
1. License header is removed from all `.go` and `.proto` files
:fireworks::fireworks:🎆.
2. `LICENSE` file in the root directory has only Temporal and Uber
copyrights.
3. 5 other `LICENSE` files added to the packages which have copyrights
different from Temporal and Uber: Datadog, Xargin, "Mat Ryer, Tyler
Bunnell and contributors".
4. `license_file` flag is removed from all code generation tools.
5. `copyright_file` flag is removed from `go:generate mockgen`
directive.
6. All copyright related targets are removed from `Makefile`.
7. Updated Temporal copyright year to 2025 everywhere.

## Why?
<!-- Tell your future self why have you made these changes -->
I double checked with legal department that it is not needed to have
license header in every file. One file per repo is enough. I put all
copyrights to the root `LICENSE` file and removed header from all other
files. Also updated tools and `Makefile`.
2025-05-01 18:50:21 -07:00

72 lines
2.0 KiB
Go

package goro
import (
"context"
"sync/atomic"
)
type (
// Handle is a threadsafe and multi-stop safe handle to a single running
// goroutine.
Handle struct {
context context.Context
cancel context.CancelFunc
done chan struct{}
err atomic.Value
}
)
// NewHandle creates a *Handle that serves as a handle to a goroutine. The
// caller should call Go exactly once on the returned value. NewHandle and Go
// are separate function so that the *Handle can be stored into a field before
// the goroutine starts, which makes it possible for the goroutine to call
// Done() on itself (maybe indirectly) without a race condition.
func NewHandle(ctx context.Context) *Handle {
ctx, cancel := context.WithCancel(ctx)
return &Handle{
context: ctx,
cancel: cancel,
done: make(chan struct{}),
}
}
// Go launches the supplied function in its own goroutine. Go should be called
// exactly once on each *Handle.
func (h *Handle) Go(f func(context.Context) error) *Handle {
go func() {
// use defer here so that the channel is closed even if the func calls
// runtime.Goexit()
defer close(h.done)
if err := f(h.context); err != nil {
h.err.Store(err)
}
}()
return h
}
// Done exposes a channel that allows outside goroutines to block on this
// goroutine's completion. Whatever time passes between a call to Cancel() and
// the Done() channel closing is the time taken by the goroutine to shut itself
// down.
func (h *Handle) Done() <-chan struct{} {
return h.done
}
// Cancel requests that this goroutine stop by cancelling the associated context
// object. This function is threadsafe and idempotent. Note that this function
// _requests_ termination, it does not forcefully kill the goroutine.
func (h *Handle) Cancel() {
h.cancel()
}
// Error observes the error returned by the func passed to Go (if any). There is
// never any error (i.e. this function returns nil) while the goroutine is
// running.
func (h *Handle) Err() error {
v := h.err.Load()
if v == nil {
return nil
}
return v.(error)
}