yeray/gobyexample
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #271 from mmcgrana/clarify-timeout-chan

Browse Source 
Clarify use of buffered channel in the timeouts example.
This commit is contained in:
Mark McGranaghan 2019-09-06 07:38:59 -07:00 committed by GitHub
commit 16859f8db1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 13 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
examples/timeouts/timeouts.go
View File

@ -12,7 +12,10 @@ func main() {
// For our example, suppose we're executing an external
// call that returns its result on a channel `c1`
// after 2s.
// after 2s. Note that the channel is buffered, so the
// send in the goroutine is nonblocking. This is a
// common pattern to prevent goroutine leaks in case the
// channel is never read.
c1 := make(chan string, 1)
go func() {
time.Sleep(2 * time.Second)

4
examples/timeouts/timeouts.hash
View File

@ -1,2 +1,2 @@
93343e1aacb14f818c87732914c29ba57afab245
MgcfA-xpJO9
b1e8d0efbabd0c52271a85fad5ad58dcd1c7c476
gyY_qDsRVUe

6
examples/timeouts/timeouts.sh
View File

@ -3,9 +3,3 @@
$ go run timeouts.go
timeout 1
result 2
# Using this `select` timeout pattern requires
# communicating results over channels. This is a good
# idea in general because other important Go features are
# based on channels and `select`. We'll look at two
# examples of this next: timers and tickers.

26
public/timeouts generated
View File

@ -44,7 +44,7 @@ elegant thanks to channels and <code>select</code>.</p>
</td>
<td class="code leading">
<a href="http://play.golang.org/p/MgcfA-xpJO9"><img title="Run code" src="play.png" class="run" /></a><img title="Copy code" src="clipboard.png" class="copy" />
<a href="http://play.golang.org/p/gyY_qDsRVUe"><img title="Run code" src="play.png" class="run" /></a><img title="Copy code" src="clipboard.png" class="copy" />
<div class="highlight"><pre><span class="kn">package</span> <span class="nx">main</span>
</pre></div>
@ -80,7 +80,10 @@ elegant thanks to channels and <code>select</code>.</p>
<td class="docs">
<p>For our example, suppose we&rsquo;re executing an external
call that returns its result on a channel <code>c1</code>
after 2s.</p>
after 2s. Note that the channel is buffered, so the
send in the goroutine is nonblocking. This is a
common pattern to prevent goroutine leaks in case the
channel is never read.</p>
</td>
<td class="code leading">
@ -153,7 +156,7 @@ from <code>c2</code> will succeed and we&rsquo;ll print the result.</p>
out and the second succeeding.</p>
</td>
<td class="code leading">
<td class="code">
<div class="highlight"><pre><span class="gp">$</span> go run timeouts.go
<span class="go">timeout 1</span>
@ -163,21 +166,6 @@ out and the second succeeding.</p>
</td>
</tr>
<tr>
<td class="docs">
<p>Using this <code>select</code> timeout pattern requires
communicating results over channels. This is a good
idea in general because other important Go features are
based on channels and <code>select</code>. We&rsquo;ll look at two
examples of this next: timers and tickers.</p>
</td>
<td class="code empty">
</td>
</tr>
</table>
@ -191,7 +179,7 @@ examples of this next: timers and tickers.</p>
</div>
<script>
var codeLines = [];
codeLines.push('');codeLines.push('package main\u000A');codeLines.push('import \"time\"\u000Aimport \"fmt\"\u000A');codeLines.push('func main() {\u000A');codeLines.push(' c1 := make(chan string, 1)\u000A go func() {\u000A time.Sleep(2 * time.Second)\u000A c1 \x3C- \"result 1\"\u000A }()\u000A');codeLines.push(' select {\u000A case res := \x3C-c1:\u000A fmt.Println(res)\u000A case \x3C-time.After(1 * time.Second):\u000A fmt.Println(\"timeout 1\")\u000A }\u000A');codeLines.push(' c2 := make(chan string, 1)\u000A go func() {\u000A time.Sleep(2 * time.Second)\u000A c2 \x3C- \"result 2\"\u000A }()\u000A select {\u000A case res := \x3C-c2:\u000A fmt.Println(res)\u000A case \x3C-time.After(3 * time.Second):\u000A fmt.Println(\"timeout 2\")\u000A }\u000A}\u000A');codeLines.push('');codeLines.push('');
codeLines.push('');codeLines.push('package main\u000A');codeLines.push('import \"time\"\u000Aimport \"fmt\"\u000A');codeLines.push('func main() {\u000A');codeLines.push(' c1 := make(chan string, 1)\u000A go func() {\u000A time.Sleep(2 * time.Second)\u000A c1 \x3C- \"result 1\"\u000A }()\u000A');codeLines.push(' select {\u000A case res := \x3C-c1:\u000A fmt.Println(res)\u000A case \x3C-time.After(1 * time.Second):\u000A fmt.Println(\"timeout 1\")\u000A }\u000A');codeLines.push(' c2 := make(chan string, 1)\u000A go func() {\u000A time.Sleep(2 * time.Second)\u000A c2 \x3C- \"result 2\"\u000A }()\u000A select {\u000A case res := \x3C-c2:\u000A fmt.Println(res)\u000A case \x3C-time.After(3 * time.Second):\u000A fmt.Println(\"timeout 2\")\u000A }\u000A}\u000A');codeLines.push('');
</script>
<script src="site.js" async></script>
</body>