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

Update Atomic Counters example to use atomic.Uint64

Browse Source 
This commit updates the Atomic Counters example to follow atomic's
recommendation of using atomic.Uint64 instead of uint64 (same for other
types) and then calling methods on it, instead of calling
atomic.AddUint64().

It also updates the comments and empty lines a bit to look better on the
website.
This commit is contained in:
Erazem Kokot 2023-09-28 18:49:19 +02:00
parent 15d8fe75b8
commit 8e17cca56d
No known key found for this signature in database
GPG Key ID: C70635965D7AC47F
3 changed files with 31 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
examples/atomic-counters/atomic-counters.go
View File

@ -15,9 +15,9 @@ import (
func main() { func main() {
// We'll use an unsigned integer to represent our // We'll use an atomic integer type to represent our
// (always-positive) counter. // (always-positive) counter.
var ops uint64 var ops atomic.Uint64
// A WaitGroup will help us wait for all goroutines // A WaitGroup will help us wait for all goroutines
// to finish their work. // to finish their work.
@ -30,12 +30,13 @@ func main() {
go func() { go func() {
for c := 0; c < 1000; c++ { for c := 0; c < 1000; c++ {
// To atomically increment the counter we
// use `AddUint64`, giving it the memory // To atomically increment the counter we use `Add`,
// address of our `ops` counter with the // giving it the memory address of our `ops` counter
// `&` syntax. // with the `&` syntax.
atomic.AddUint64(&ops, 1) ops.Add(1)
} }
wg.Done() wg.Done()
}() }()
} }
@ -48,5 +49,5 @@ func main() {
// atomics safely while they are being updated is // atomics safely while they are being updated is
// also possible, using functions like // also possible, using functions like
// `atomic.LoadUint64`. // `atomic.LoadUint64`.
fmt.Println("ops:", ops) fmt.Println("ops:", ops.Load())
} }

4
examples/atomic-counters/atomic-counters.hash
View File

@ -1,2 +1,2 @@
7b491b40d56a77b01d8e2bd08366de081a4e8d99 8c87658e3694b98a456c73438c453286fe018c28
j-14agntvEO 5vAUgPMebQw

32
public/atomic-counters generated
View File

@ -46,7 +46,7 @@ counters</em> accessed by multiple goroutines.</p>
</td> </td>
<td class="code leading"> <td class="code leading">
<a href="https://go.dev/play/p/j-14agntvEO"><img title="Run code" src="play.png" class="run" /></a><img title="Copy code" src="clipboard.png" class="copy" /> <a href="https://go.dev/play/p/C8TGF0qyop5"><img title="Run code" src="play.png" class="run" /></a><img title="Copy code" src="clipboard.png" class="copy" />
<pre class="chroma"><code><span class="line"><span class="cl"><span class="kn">package</span> <span class="nx">main</span></span></span></code></pre> <pre class="chroma"><code><span class="line"><span class="cl"><span class="kn">package</span> <span class="nx">main</span></span></span></code></pre>
</td> </td>
</tr> </tr>
@ -77,13 +77,13 @@ counters</em> accessed by multiple goroutines.</p>
<tr> <tr>
<td class="docs"> <td class="docs">
<p>We&rsquo;ll use an unsigned integer to represent our <p>We&rsquo;ll use an atomic integer type to represent our
(always-positive) counter.</p> (always-positive) counter.</p>
</td> </td>
<td class="code leading"> <td class="code leading">
<pre class="chroma"><code><span class="line"><span class="cl"> <span class="kd">var</span> <span class="nx">ops</span> <span class="kt">uint64</span></span></span></code></pre> <pre class="chroma"><code><span class="line"><span class="cl"> <span class="kd">var</span> <span class="nx">ops</span> <span class="nx">atomic</span><span class="p">.</span><span class="nx">Uint64</span></span></span></code></pre>
</td> </td>
</tr> </tr>
@ -114,10 +114,9 @@ counter exactly 1000 times.</p>
<tr> <tr>
<td class="docs"> <td class="docs">
<p>To atomically increment the counter we <p>To atomically increment the counter we use <code>Add</code>,
use <code>AddUint64</code>, giving it the memory giving it the memory address of our <code>ops</code> counter
address of our <code>ops</code> counter with the with the <code>&amp;</code> syntax.</p>
<code>&amp;</code> syntax.</p>
</td> </td>
<td class="code leading"> <td class="code leading">
@ -133,9 +132,18 @@ address of our <code>ops</code> counter with the
</td> </td>
<td class="code leading"> <td class="code leading">
<pre class="chroma"><code><span class="line"><span class="cl"> <span class="nx">atomic</span><span class="p">.</span><span class="nf">AddUint64</span><span class="p">(</span><span class="o">&amp;</span><span class="nx">ops</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> <pre class="chroma"><code><span class="line"><span class="cl"> <span class="nx">ops</span><span class="p">.</span><span class="nf">Add</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span> </span></span><span class="line"><span class="cl"> <span class="p">}</span></span></span></code></pre>
</span></span><span class="line"><span class="cl"> <span class="nx">wg</span><span class="p">.</span><span class="nf">Done</span><span class="p">()</span> </td>
</tr>
<tr>
<td class="docs">
</td>
<td class="code leading">
<pre class="chroma"><code><span class="line"><span class="cl"> <span class="nx">wg</span><span class="p">.</span><span class="nf">Done</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"> <span class="p">}()</span> </span></span><span class="line"><span class="cl"> <span class="p">}()</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span></span></span></code></pre> </span></span><span class="line"><span class="cl"> <span class="p">}</span></span></span></code></pre>
</td> </td>
@ -163,7 +171,7 @@ also possible, using functions like
</td> </td>
<td class="code"> <td class="code">
<pre class="chroma"><code><span class="line"><span class="cl"> <span class="nx">fmt</span><span class="p">.</span><span class="nf">Println</span><span class="p">(</span><span class="s">&#34;ops:&#34;</span><span class="p">,</span> <span class="nx">ops</span><span class="p">)</span> <pre class="chroma"><code><span class="line"><span class="cl"> <span class="nx">fmt</span><span class="p">.</span><span class="nf">Println</span><span class="p">(</span><span class="s">&#34;ops:&#34;</span><span class="p">,</span> <span class="nx">ops</span><span class="p">.</span><span class="nf">Load</span><span class="p">())</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre> </span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre>
</td> </td>
</tr> </tr>
@ -216,7 +224,7 @@ state.</p>
</div> </div>
<script> <script>
var codeLines = []; var codeLines = [];
codeLines.push('');codeLines.push('package main\u000A');codeLines.push('import (\u000A \"fmt\"\u000A \"sync\"\u000A \"sync/atomic\"\u000A)\u000A');codeLines.push('func main() {\u000A');codeLines.push(' var ops uint64\u000A');codeLines.push(' var wg sync.WaitGroup\u000A');codeLines.push(' for i :\u003D 0; i \u003C 50; i++ {\u000A wg.Add(1)\u000A');codeLines.push(' go func() {\u000A for c :\u003D 0; c \u003C 1000; c++ {\u000A');codeLines.push(' atomic.AddUint64(\u0026ops, 1)\u000A }\u000A wg.Done()\u000A }()\u000A }\u000A');codeLines.push(' wg.Wait()\u000A');codeLines.push(' fmt.Println(\"ops:\", ops)\u000A}\u000A');codeLines.push('');codeLines.push(''); codeLines.push('');codeLines.push('package main\u000A');codeLines.push('import (\u000A \"fmt\"\u000A \"sync\"\u000A \"sync/atomic\"\u000A)\u000A');codeLines.push('func main() {\u000A');codeLines.push(' var ops atomic.Uint64\u000A');codeLines.push(' var wg sync.WaitGroup\u000A');codeLines.push(' for i :\u003D 0; i \u003C 50; i++ {\u000A wg.Add(1)\u000A');codeLines.push(' go func() {\u000A for c :\u003D 0; c \u003C 1000; c++ {\u000A');codeLines.push(' ops.Add(1)\u000A }\u000A');codeLines.push(' wg.Done()\u000A }()\u000A }\u000A');codeLines.push(' wg.Wait()\u000A');codeLines.push(' fmt.Println(\"ops:\", ops.Load())\u000A}\u000A');codeLines.push('');codeLines.push('');
</script> </script>
<script src="site.js" async></script> <script src="site.js" async></script>
</body> </body>