cancel.go RawHistoryFolder

1// SPDX-License-Identifier: MIT
2
3package executor
4
5import "sync"
6
7// CancelReason says why a job is stopped.
8type CancelReason int
9
10// Cancel reasons.
11const (
12	// CancelUser is a cancellation by the owner or by fail-fast: the job ends
13	// cancelled.
14	CancelUser CancelReason = iota + 1
15	// CancelTimeout is the job timeout: the job ends timed_out.
16	CancelTimeout
17	// CancelShutdown is the runner stopping: the job ends cancelled with
18	// RunnerShutdown set, and the steps that did not start are skipped.
19	CancelShutdown
20)
21
22// Canceller stops a job. The first Cancel wins; later calls are ignored (the
23// server only sends the first reason too).
24type Canceller struct {
25	once   sync.Once
26	ch     chan struct{}
27	mu     sync.Mutex
28	reason CancelReason
29}
30
31// NewCanceller returns a Canceller that has not fired.
32func NewCanceller() *Canceller { return &Canceller{ch: make(chan struct{})} }
33
34// Cancel stops the job for reason.
35func (c *Canceller) Cancel(reason CancelReason) {
36	c.once.Do(func() {
37		c.mu.Lock()
38		c.reason = reason
39		c.mu.Unlock()
40		close(c.ch)
41	})
42}
43
44// Done is closed when the job is cancelled.
45func (c *Canceller) Done() <-chan struct{} { return c.ch }
46
47// Reason returns why the job was cancelled; zero before Done is closed.
48func (c *Canceller) Reason() CancelReason {
49	c.mu.Lock()
50	defer c.mu.Unlock()
51	return c.reason
52}