diff options
Diffstat (limited to 'vendor/github.com/oklog')
-rw-r--r-- | vendor/github.com/oklog/run/.gitignore | 14 | ||||
-rw-r--r-- | vendor/github.com/oklog/run/.travis.yml | 12 | ||||
-rw-r--r-- | vendor/github.com/oklog/run/LICENSE | 201 | ||||
-rw-r--r-- | vendor/github.com/oklog/run/README.md | 73 | ||||
-rw-r--r-- | vendor/github.com/oklog/run/group.go | 62 |
5 files changed, 362 insertions, 0 deletions
diff --git a/vendor/github.com/oklog/run/.gitignore b/vendor/github.com/oklog/run/.gitignore new file mode 100644 index 0000000..a1338d6 --- /dev/null +++ b/vendor/github.com/oklog/run/.gitignore | |||
@@ -0,0 +1,14 @@ | |||
1 | # Binaries for programs and plugins | ||
2 | *.exe | ||
3 | *.dll | ||
4 | *.so | ||
5 | *.dylib | ||
6 | |||
7 | # Test binary, build with `go test -c` | ||
8 | *.test | ||
9 | |||
10 | # Output of the go coverage tool, specifically when used with LiteIDE | ||
11 | *.out | ||
12 | |||
13 | # Project-local glide cache, RE: https://github.com/Masterminds/glide/issues/736 | ||
14 | .glide/ | ||
diff --git a/vendor/github.com/oklog/run/.travis.yml b/vendor/github.com/oklog/run/.travis.yml new file mode 100644 index 0000000..362bdd4 --- /dev/null +++ b/vendor/github.com/oklog/run/.travis.yml | |||
@@ -0,0 +1,12 @@ | |||
1 | language: go | ||
2 | sudo: false | ||
3 | go: | ||
4 | - 1.x | ||
5 | - tip | ||
6 | install: | ||
7 | - go get -v github.com/golang/lint/golint | ||
8 | - go build ./... | ||
9 | script: | ||
10 | - go vet ./... | ||
11 | - $HOME/gopath/bin/golint . | ||
12 | - go test -v -race ./... | ||
diff --git a/vendor/github.com/oklog/run/LICENSE b/vendor/github.com/oklog/run/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/vendor/github.com/oklog/run/LICENSE | |||
@@ -0,0 +1,201 @@ | |||
1 | Apache License | ||
2 | Version 2.0, January 2004 | ||
3 | http://www.apache.org/licenses/ | ||
4 | |||
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
6 | |||
7 | 1. Definitions. | ||
8 | |||
9 | "License" shall mean the terms and conditions for use, reproduction, | ||
10 | and distribution as defined by Sections 1 through 9 of this document. | ||
11 | |||
12 | "Licensor" shall mean the copyright owner or entity authorized by | ||
13 | the copyright owner that is granting the License. | ||
14 | |||
15 | "Legal Entity" shall mean the union of the acting entity and all | ||
16 | other entities that control, are controlled by, or are under common | ||
17 | control with that entity. For the purposes of this definition, | ||
18 | "control" means (i) the power, direct or indirect, to cause the | ||
19 | direction or management of such entity, whether by contract or | ||
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
21 | outstanding shares, or (iii) beneficial ownership of such entity. | ||
22 | |||
23 | "You" (or "Your") shall mean an individual or Legal Entity | ||
24 | exercising permissions granted by this License. | ||
25 | |||
26 | "Source" form shall mean the preferred form for making modifications, | ||
27 | including but not limited to software source code, documentation | ||
28 | source, and configuration files. | ||
29 | |||
30 | "Object" form shall mean any form resulting from mechanical | ||
31 | transformation or translation of a Source form, including but | ||
32 | not limited to compiled object code, generated documentation, | ||
33 | and conversions to other media types. | ||
34 | |||
35 | "Work" shall mean the work of authorship, whether in Source or | ||
36 | Object form, made available under the License, as indicated by a | ||
37 | copyright notice that is included in or attached to the work | ||
38 | (an example is provided in the Appendix below). | ||
39 | |||
40 | "Derivative Works" shall mean any work, whether in Source or Object | ||
41 | form, that is based on (or derived from) the Work and for which the | ||
42 | editorial revisions, annotations, elaborations, or other modifications | ||
43 | represent, as a whole, an original work of authorship. For the purposes | ||
44 | of this License, Derivative Works shall not include works that remain | ||
45 | separable from, or merely link (or bind by name) to the interfaces of, | ||
46 | the Work and Derivative Works thereof. | ||
47 | |||
48 | "Contribution" shall mean any work of authorship, including | ||
49 | the original version of the Work and any modifications or additions | ||
50 | to that Work or Derivative Works thereof, that is intentionally | ||
51 | submitted to Licensor for inclusion in the Work by the copyright owner | ||
52 | or by an individual or Legal Entity authorized to submit on behalf of | ||
53 | the copyright owner. For the purposes of this definition, "submitted" | ||
54 | means any form of electronic, verbal, or written communication sent | ||
55 | to the Licensor or its representatives, including but not limited to | ||
56 | communication on electronic mailing lists, source code control systems, | ||
57 | and issue tracking systems that are managed by, or on behalf of, the | ||
58 | Licensor for the purpose of discussing and improving the Work, but | ||
59 | excluding communication that is conspicuously marked or otherwise | ||
60 | designated in writing by the copyright owner as "Not a Contribution." | ||
61 | |||
62 | "Contributor" shall mean Licensor and any individual or Legal Entity | ||
63 | on behalf of whom a Contribution has been received by Licensor and | ||
64 | subsequently incorporated within the Work. | ||
65 | |||
66 | 2. Grant of Copyright License. Subject to the terms and conditions of | ||
67 | this License, each Contributor hereby grants to You a perpetual, | ||
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
69 | copyright license to reproduce, prepare Derivative Works of, | ||
70 | publicly display, publicly perform, sublicense, and distribute the | ||
71 | Work and such Derivative Works in Source or Object form. | ||
72 | |||
73 | 3. Grant of Patent License. Subject to the terms and conditions of | ||
74 | this License, each Contributor hereby grants to You a perpetual, | ||
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
76 | (except as stated in this section) patent license to make, have made, | ||
77 | use, offer to sell, sell, import, and otherwise transfer the Work, | ||
78 | where such license applies only to those patent claims licensable | ||
79 | by such Contributor that are necessarily infringed by their | ||
80 | Contribution(s) alone or by combination of their Contribution(s) | ||
81 | with the Work to which such Contribution(s) was submitted. If You | ||
82 | institute patent litigation against any entity (including a | ||
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
84 | or a Contribution incorporated within the Work constitutes direct | ||
85 | or contributory patent infringement, then any patent licenses | ||
86 | granted to You under this License for that Work shall terminate | ||
87 | as of the date such litigation is filed. | ||
88 | |||
89 | 4. Redistribution. You may reproduce and distribute copies of the | ||
90 | Work or Derivative Works thereof in any medium, with or without | ||
91 | modifications, and in Source or Object form, provided that You | ||
92 | meet the following conditions: | ||
93 | |||
94 | (a) You must give any other recipients of the Work or | ||
95 | Derivative Works a copy of this License; and | ||
96 | |||
97 | (b) You must cause any modified files to carry prominent notices | ||
98 | stating that You changed the files; and | ||
99 | |||
100 | (c) You must retain, in the Source form of any Derivative Works | ||
101 | that You distribute, all copyright, patent, trademark, and | ||
102 | attribution notices from the Source form of the Work, | ||
103 | excluding those notices that do not pertain to any part of | ||
104 | the Derivative Works; and | ||
105 | |||
106 | (d) If the Work includes a "NOTICE" text file as part of its | ||
107 | distribution, then any Derivative Works that You distribute must | ||
108 | include a readable copy of the attribution notices contained | ||
109 | within such NOTICE file, excluding those notices that do not | ||
110 | pertain to any part of the Derivative Works, in at least one | ||
111 | of the following places: within a NOTICE text file distributed | ||
112 | as part of the Derivative Works; within the Source form or | ||
113 | documentation, if provided along with the Derivative Works; or, | ||
114 | within a display generated by the Derivative Works, if and | ||
115 | wherever such third-party notices normally appear. The contents | ||
116 | of the NOTICE file are for informational purposes only and | ||
117 | do not modify the License. You may add Your own attribution | ||
118 | notices within Derivative Works that You distribute, alongside | ||
119 | or as an addendum to the NOTICE text from the Work, provided | ||
120 | that such additional attribution notices cannot be construed | ||
121 | as modifying the License. | ||
122 | |||
123 | You may add Your own copyright statement to Your modifications and | ||
124 | may provide additional or different license terms and conditions | ||
125 | for use, reproduction, or distribution of Your modifications, or | ||
126 | for any such Derivative Works as a whole, provided Your use, | ||
127 | reproduction, and distribution of the Work otherwise complies with | ||
128 | the conditions stated in this License. | ||
129 | |||
130 | 5. Submission of Contributions. Unless You explicitly state otherwise, | ||
131 | any Contribution intentionally submitted for inclusion in the Work | ||
132 | by You to the Licensor shall be under the terms and conditions of | ||
133 | this License, without any additional terms or conditions. | ||
134 | Notwithstanding the above, nothing herein shall supersede or modify | ||
135 | the terms of any separate license agreement you may have executed | ||
136 | with Licensor regarding such Contributions. | ||
137 | |||
138 | 6. Trademarks. This License does not grant permission to use the trade | ||
139 | names, trademarks, service marks, or product names of the Licensor, | ||
140 | except as required for reasonable and customary use in describing the | ||
141 | origin of the Work and reproducing the content of the NOTICE file. | ||
142 | |||
143 | 7. Disclaimer of Warranty. Unless required by applicable law or | ||
144 | agreed to in writing, Licensor provides the Work (and each | ||
145 | Contributor provides its Contributions) on an "AS IS" BASIS, | ||
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
147 | implied, including, without limitation, any warranties or conditions | ||
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
149 | PARTICULAR PURPOSE. You are solely responsible for determining the | ||
150 | appropriateness of using or redistributing the Work and assume any | ||
151 | risks associated with Your exercise of permissions under this License. | ||
152 | |||
153 | 8. Limitation of Liability. In no event and under no legal theory, | ||
154 | whether in tort (including negligence), contract, or otherwise, | ||
155 | unless required by applicable law (such as deliberate and grossly | ||
156 | negligent acts) or agreed to in writing, shall any Contributor be | ||
157 | liable to You for damages, including any direct, indirect, special, | ||
158 | incidental, or consequential damages of any character arising as a | ||
159 | result of this License or out of the use or inability to use the | ||
160 | Work (including but not limited to damages for loss of goodwill, | ||
161 | work stoppage, computer failure or malfunction, or any and all | ||
162 | other commercial damages or losses), even if such Contributor | ||
163 | has been advised of the possibility of such damages. | ||
164 | |||
165 | 9. Accepting Warranty or Additional Liability. While redistributing | ||
166 | the Work or Derivative Works thereof, You may choose to offer, | ||
167 | and charge a fee for, acceptance of support, warranty, indemnity, | ||
168 | or other liability obligations and/or rights consistent with this | ||
169 | License. However, in accepting such obligations, You may act only | ||
170 | on Your own behalf and on Your sole responsibility, not on behalf | ||
171 | of any other Contributor, and only if You agree to indemnify, | ||
172 | defend, and hold each Contributor harmless for any liability | ||
173 | incurred by, or claims asserted against, such Contributor by reason | ||
174 | of your accepting any such warranty or additional liability. | ||
175 | |||
176 | END OF TERMS AND CONDITIONS | ||
177 | |||
178 | APPENDIX: How to apply the Apache License to your work. | ||
179 | |||
180 | To apply the Apache License to your work, attach the following | ||
181 | boilerplate notice, with the fields enclosed by brackets "[]" | ||
182 | replaced with your own identifying information. (Don't include | ||
183 | the brackets!) The text should be enclosed in the appropriate | ||
184 | comment syntax for the file format. We also recommend that a | ||
185 | file or class name and description of purpose be included on the | ||
186 | same "printed page" as the copyright notice for easier | ||
187 | identification within third-party archives. | ||
188 | |||
189 | Copyright [yyyy] [name of copyright owner] | ||
190 | |||
191 | Licensed under the Apache License, Version 2.0 (the "License"); | ||
192 | you may not use this file except in compliance with the License. | ||
193 | You may obtain a copy of the License at | ||
194 | |||
195 | http://www.apache.org/licenses/LICENSE-2.0 | ||
196 | |||
197 | Unless required by applicable law or agreed to in writing, software | ||
198 | distributed under the License is distributed on an "AS IS" BASIS, | ||
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
200 | See the License for the specific language governing permissions and | ||
201 | limitations under the License. | ||
diff --git a/vendor/github.com/oklog/run/README.md b/vendor/github.com/oklog/run/README.md new file mode 100644 index 0000000..a7228cd --- /dev/null +++ b/vendor/github.com/oklog/run/README.md | |||
@@ -0,0 +1,73 @@ | |||
1 | # run | ||
2 | |||
3 | [![GoDoc](https://godoc.org/github.com/oklog/run?status.svg)](https://godoc.org/github.com/oklog/run) | ||
4 | [![Build Status](https://travis-ci.org/oklog/run.svg?branch=master)](https://travis-ci.org/oklog/run) | ||
5 | [![Go Report Card](https://goreportcard.com/badge/github.com/oklog/run)](https://goreportcard.com/report/github.com/oklog/run) | ||
6 | [![Apache 2 licensed](https://img.shields.io/badge/license-Apache2-blue.svg)](https://raw.githubusercontent.com/oklog/run/master/LICENSE) | ||
7 | |||
8 | run.Group is a universal mechanism to manage goroutine lifecycles. | ||
9 | |||
10 | Create a zero-value run.Group, and then add actors to it. Actors are defined as | ||
11 | a pair of functions: an **execute** function, which should run synchronously; | ||
12 | and an **interrupt** function, which, when invoked, should cause the execute | ||
13 | function to return. Finally, invoke Run, which blocks until the first actor | ||
14 | returns. This general-purpose API allows callers to model pretty much any | ||
15 | runnable task, and achieve well-defined lifecycle semantics for the group. | ||
16 | |||
17 | run.Group was written to manage component lifecycles in func main for | ||
18 | [OK Log](https://github.com/oklog/oklog). | ||
19 | But it's useful in any circumstance where you need to orchestrate multiple | ||
20 | goroutines as a unit whole. | ||
21 | [Click here](https://www.youtube.com/watch?v=LHe1Cb_Ud_M&t=15m45s) to see a | ||
22 | video of a talk where run.Group is described. | ||
23 | |||
24 | ## Examples | ||
25 | |||
26 | ### context.Context | ||
27 | |||
28 | ```go | ||
29 | ctx, cancel := context.WithCancel(context.Background()) | ||
30 | g.Add(func() error { | ||
31 | return myProcess(ctx, ...) | ||
32 | }, func(error) { | ||
33 | cancel() | ||
34 | }) | ||
35 | ``` | ||
36 | |||
37 | ### net.Listener | ||
38 | |||
39 | ```go | ||
40 | ln, _ := net.Listen("tcp", ":8080") | ||
41 | g.Add(func() error { | ||
42 | return http.Serve(ln, nil) | ||
43 | }, func(error) { | ||
44 | ln.Close() | ||
45 | }) | ||
46 | ``` | ||
47 | |||
48 | ### io.ReadCloser | ||
49 | |||
50 | ```go | ||
51 | var conn io.ReadCloser = ... | ||
52 | g.Add(func() error { | ||
53 | s := bufio.NewScanner(conn) | ||
54 | for s.Scan() { | ||
55 | println(s.Text()) | ||
56 | } | ||
57 | return s.Err() | ||
58 | }, func(error) { | ||
59 | conn.Close() | ||
60 | }) | ||
61 | ``` | ||
62 | |||
63 | ## Comparisons | ||
64 | |||
65 | Package run is somewhat similar to package | ||
66 | [errgroup](https://godoc.org/golang.org/x/sync/errgroup), | ||
67 | except it doesn't require actor goroutines to understand context semantics. | ||
68 | |||
69 | It's somewhat similar to package | ||
70 | [tomb.v1](https://godoc.org/gopkg.in/tomb.v1) or | ||
71 | [tomb.v2](https://godoc.org/gopkg.in/tomb.v2), | ||
72 | except it has a much smaller API surface, delegating e.g. staged shutdown of | ||
73 | goroutines to the caller. | ||
diff --git a/vendor/github.com/oklog/run/group.go b/vendor/github.com/oklog/run/group.go new file mode 100644 index 0000000..832d47d --- /dev/null +++ b/vendor/github.com/oklog/run/group.go | |||
@@ -0,0 +1,62 @@ | |||
1 | // Package run implements an actor-runner with deterministic teardown. It is | ||
2 | // somewhat similar to package errgroup, except it does not require actor | ||
3 | // goroutines to understand context semantics. This makes it suitable for use in | ||
4 | // more circumstances; for example, goroutines which are handling connections | ||
5 | // from net.Listeners, or scanning input from a closable io.Reader. | ||
6 | package run | ||
7 | |||
8 | // Group collects actors (functions) and runs them concurrently. | ||
9 | // When one actor (function) returns, all actors are interrupted. | ||
10 | // The zero value of a Group is useful. | ||
11 | type Group struct { | ||
12 | actors []actor | ||
13 | } | ||
14 | |||
15 | // Add an actor (function) to the group. Each actor must be pre-emptable by an | ||
16 | // interrupt function. That is, if interrupt is invoked, execute should return. | ||
17 | // Also, it must be safe to call interrupt even after execute has returned. | ||
18 | // | ||
19 | // The first actor (function) to return interrupts all running actors. | ||
20 | // The error is passed to the interrupt functions, and is returned by Run. | ||
21 | func (g *Group) Add(execute func() error, interrupt func(error)) { | ||
22 | g.actors = append(g.actors, actor{execute, interrupt}) | ||
23 | } | ||
24 | |||
25 | // Run all actors (functions) concurrently. | ||
26 | // When the first actor returns, all others are interrupted. | ||
27 | // Run only returns when all actors have exited. | ||
28 | // Run returns the error returned by the first exiting actor. | ||
29 | func (g *Group) Run() error { | ||
30 | if len(g.actors) == 0 { | ||
31 | return nil | ||
32 | } | ||
33 | |||
34 | // Run each actor. | ||
35 | errors := make(chan error, len(g.actors)) | ||
36 | for _, a := range g.actors { | ||
37 | go func(a actor) { | ||
38 | errors <- a.execute() | ||
39 | }(a) | ||
40 | } | ||
41 | |||
42 | // Wait for the first actor to stop. | ||
43 | err := <-errors | ||
44 | |||
45 | // Signal all actors to stop. | ||
46 | for _, a := range g.actors { | ||
47 | a.interrupt(err) | ||
48 | } | ||
49 | |||
50 | // Wait for all actors to stop. | ||
51 | for i := 1; i < cap(errors); i++ { | ||
52 | <-errors | ||
53 | } | ||
54 | |||
55 | // Return the original error. | ||
56 | return err | ||
57 | } | ||
58 | |||
59 | type actor struct { | ||
60 | execute func() error | ||
61 | interrupt func(error) | ||
62 | } | ||