Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

singleflight: Add an example #73

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions singleflight/example_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
/*
Copyright 2018 The Go Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package singleflight_test

import (
"fmt"
"log"
"strconv"
"time"

"github.com/golang/groupcache/singleflight"
)

var counter int32
var group singleflight.Group

func Example() {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be a testing case, like TestSingleFlightExample, and use testing.T for checking?

// No matter how many goroutines call Do, only one call per key will be in
// progress at any time. Callers that share a key will get the same results
// as an in-flight call with that key.
n := int32(41)
v, err := group.Do(strconv.FormatInt(int64(n), 10), func() (interface{}, error) {
time.Sleep(time.Millisecond) // simulate time-consuming action
return n + 1, nil
})
if err != nil {
log.Fatal(err)
}
fmt.Println(v.(int32))
// Output: 42
}