← Back to branch summary

~nskaggs/+junk/xenial-test

« back to all changes in this revision

Viewing changes to src/launchpad.net/tomb/tomb.go

  • Committer: Nicholas Skaggs
  • Date: 2016-10-24 20:56:05 UTC
  • Revision ID: nicholas.skaggs@canonical.com-20161024205605-z8lta0uvuhtxwzwl
Initi with beta15

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/launchpad.net/tomb/tomb.go
 
1
// Copyright (c) 2011 - Gustavo Niemeyer <gustavo@niemeyer.net>
 
2
// 
 
3
// All rights reserved.
 
4
// 
 
5
// Redistribution and use in source and binary forms, with or without
 
6
// modification, are permitted provided that the following conditions are met:
 
7
// 
 
8
//     * Redistributions of source code must retain the above copyright notice,
 
9
//       this list of conditions and the following disclaimer.
 
10
//     * Redistributions in binary form must reproduce the above copyright notice,
 
11
//       this list of conditions and the following disclaimer in the documentation
 
12
//       and/or other materials provided with the distribution.
 
13
//     * Neither the name of the copyright holder nor the names of its
 
14
//       contributors may be used to endorse or promote products derived from
 
15
//       this software without specific prior written permission.
 
16
// 
 
17
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 
18
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 
19
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 
20
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 
21
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 
22
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 
23
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 
24
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 
25
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 
26
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 
27
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
28
 
 
29
// PROJECT MOVED: https://gopkg.in/tomb.v1
 
30
package tomb
 
31
 
 
32
import (
 
33
        "errors"
 
34
        "fmt"
 
35
        "sync"
 
36
)
 
37
 
 
38
// A Tomb tracks the lifecycle of a goroutine as alive, dying or dead,
 
39
// and the reason for its death.
 
40
//
 
41
// The zero value of a Tomb assumes that a goroutine is about to be
 
42
// created or already alive. Once Kill or Killf is called with an
 
43
// argument that informs the reason for death, the goroutine is in
 
44
// a dying state and is expected to terminate soon. Right before the
 
45
// goroutine function or method returns, Done must be called to inform
 
46
// that the goroutine is indeed dead and about to stop running.
 
47
//
 
48
// A Tomb exposes Dying and Dead channels. These channels are closed
 
49
// when the Tomb state changes in the respective way. They enable
 
50
// explicit blocking until the state changes, and also to selectively
 
51
// unblock select statements accordingly.
 
52
//
 
53
// When the tomb state changes to dying and there's still logic going
 
54
// on within the goroutine, nested functions and methods may choose to
 
55
// return ErrDying as their error value, as this error won't alter the
 
56
// tomb state if provied to the Kill method. This is a convenient way to
 
57
// follow standard Go practices in the context of a dying tomb.
 
58
//
 
59
// For background and a detailed example, see the following blog post:
 
60
//
 
61
//   http://blog.labix.org/2011/10/09/death-of-goroutines-under-control
 
62
//
 
63
// For a more complex code snippet demonstrating the use of multiple
 
64
// goroutines with a single Tomb, see:
 
65
//
 
66
//   http://play.golang.org/p/Xh7qWsDPZP
 
67
//
 
68
type Tomb struct {
 
69
        m      sync.Mutex
 
70
        dying  chan struct{}
 
71
        dead   chan struct{}
 
72
        reason error
 
73
}
 
74
 
 
75
var (
 
76
        ErrStillAlive = errors.New("tomb: still alive")
 
77
        ErrDying = errors.New("tomb: dying")
 
78
)
 
79
 
 
80
func (t *Tomb) init() {
 
81
        t.m.Lock()
 
82
        if t.dead == nil {
 
83
                t.dead = make(chan struct{})
 
84
                t.dying = make(chan struct{})
 
85
                t.reason = ErrStillAlive
 
86
        }
 
87
        t.m.Unlock()
 
88
}
 
89
 
 
90
// Dead returns the channel that can be used to wait
 
91
// until t.Done has been called.
 
92
func (t *Tomb) Dead() <-chan struct{} {
 
93
        t.init()
 
94
        return t.dead
 
95
}
 
96
 
 
97
// Dying returns the channel that can be used to wait
 
98
// until t.Kill or t.Done has been called.
 
99
func (t *Tomb) Dying() <-chan struct{} {
 
100
        t.init()
 
101
        return t.dying
 
102
}
 
103
 
 
104
// Wait blocks until the goroutine is in a dead state and returns the
 
105
// reason for its death.
 
106
func (t *Tomb) Wait() error {
 
107
        t.init()
 
108
        <-t.dead
 
109
        t.m.Lock()
 
110
        reason := t.reason
 
111
        t.m.Unlock()
 
112
        return reason
 
113
}
 
114
 
 
115
// Done flags the goroutine as dead, and should be called a single time
 
116
// right before the goroutine function or method returns.
 
117
// If the goroutine was not already in a dying state before Done is
 
118
// called, it will be flagged as dying and dead at once with no
 
119
// error.
 
120
func (t *Tomb) Done() {
 
121
        t.Kill(nil)
 
122
        close(t.dead)
 
123
}
 
124
 
 
125
// Kill flags the goroutine as dying for the given reason.
 
126
// Kill may be called multiple times, but only the first
 
127
// non-nil error is recorded as the reason for termination.
 
128
//
 
129
// If reason is ErrDying, the previous reason isn't replaced
 
130
// even if it is nil. It's a runtime error to call Kill with
 
131
// ErrDying if t is not in a dying state.
 
132
func (t *Tomb) Kill(reason error) {
 
133
        t.init()
 
134
        t.m.Lock()
 
135
        defer t.m.Unlock()
 
136
        if reason == ErrDying {
 
137
                if t.reason == ErrStillAlive {
 
138
                        panic("tomb: Kill with ErrDying while still alive")
 
139
                }
 
140
                return
 
141
        }
 
142
        if t.reason == nil || t.reason == ErrStillAlive {
 
143
                t.reason = reason
 
144
        }
 
145
        // If the receive on t.dying succeeds, then
 
146
        // it can only be because we have already closed it.
 
147
        // If it blocks, then we know that it needs to be closed.
 
148
        select {
 
149
        case <-t.dying:
 
150
        default:
 
151
                close(t.dying)
 
152
        }
 
153
}
 
154
 
 
155
// Killf works like Kill, but builds the reason providing the received
 
156
// arguments to fmt.Errorf. The generated error is also returned.
 
157
func (t *Tomb) Killf(f string, a ...interface{}) error {
 
158
        err := fmt.Errorf(f, a...)
 
159
        t.Kill(err)
 
160
        return err
 
161
}
 
162
 
 
163
// Err returns the reason for the goroutine death provided via Kill
 
164
// or Killf, or ErrStillAlive when the goroutine is still alive.
 
165
func (t *Tomb) Err() (reason error) {
 
166
        t.init()
 
167
        t.m.Lock()
 
168
        reason = t.reason
 
169
        t.m.Unlock()
 
170
        return
 
171
}