github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-28 22:17:14 +00:00
Code Issues Projects Releases Wiki Activity

Make contextForChannel public

Browse Source
This commit is contained in:
Wojciech Tyczyński 2022-05-25 09:31:35 +02:00
parent eb37a5d9c1
commit 55130ae2ab
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
staging/src/k8s.io/apimachinery/pkg/util/wait/wait.go
View File

@ -288,13 +288,13 @@ func (b *Backoff) Step() time.Duration {
return duration return duration
} }
// contextForChannel derives a child context from a parent channel. // ContextForChannel derives a child context from a parent channel.
// //
// The derived context's Done channel is closed when the returned cancel function // The derived context's Done channel is closed when the returned cancel function
// is called or when the parent channel is closed, whichever happens first. // is called or when the parent channel is closed, whichever happens first.
// //
// Note the caller must *always* call the CancelFunc, otherwise resources may be leaked. // Note the caller must *always* call the CancelFunc, otherwise resources may be leaked.
func contextForChannel(parentCh <-chan struct{}) (context.Context, context.CancelFunc) { func ContextForChannel(parentCh <-chan struct{}) (context.Context, context.CancelFunc) {
ctx, cancel := context.WithCancel(context.Background()) ctx, cancel := context.WithCancel(context.Background())
go func() { go func() {
@ -464,7 +464,7 @@ func PollWithContext(ctx context.Context, interval, timeout time.Duration, condi
// PollUntil always waits interval before the first run of 'condition'. // PollUntil always waits interval before the first run of 'condition'.
// 'condition' will always be invoked at least once. // 'condition' will always be invoked at least once.
func PollUntil(interval time.Duration, condition ConditionFunc, stopCh <-chan struct{}) error { func PollUntil(interval time.Duration, condition ConditionFunc, stopCh <-chan struct{}) error {
ctx, cancel := contextForChannel(stopCh) ctx, cancel := ContextForChannel(stopCh)
defer cancel() defer cancel()
return PollUntilWithContext(ctx, interval, condition.WithContext()) return PollUntilWithContext(ctx, interval, condition.WithContext())
} }
@ -531,7 +531,7 @@ func PollImmediateWithContext(ctx context.Context, interval, timeout time.Durati
// PollImmediateUntil runs the 'condition' before waiting for the interval. // PollImmediateUntil runs the 'condition' before waiting for the interval.
// 'condition' will always be invoked at least once. // 'condition' will always be invoked at least once.
func PollImmediateUntil(interval time.Duration, condition ConditionFunc, stopCh <-chan struct{}) error { func PollImmediateUntil(interval time.Duration, condition ConditionFunc, stopCh <-chan struct{}) error {
ctx, cancel := contextForChannel(stopCh) ctx, cancel := ContextForChannel(stopCh)
defer cancel() defer cancel()
return PollImmediateUntilWithContext(ctx, interval, condition.WithContext()) return PollImmediateUntilWithContext(ctx, interval, condition.WithContext())
} }
@ -629,7 +629,7 @@ type WaitWithContextFunc func(ctx context.Context) <-chan struct{}
// "uniform pseudo-random", the `fn` might still run one or multiple time, // "uniform pseudo-random", the `fn` might still run one or multiple time,
// though eventually `WaitFor` will return. // though eventually `WaitFor` will return.
func WaitFor(wait WaitFunc, fn ConditionFunc, done <-chan struct{}) error { func WaitFor(wait WaitFunc, fn ConditionFunc, done <-chan struct{}) error {
ctx, cancel := contextForChannel(done) ctx, cancel := ContextForChannel(done)
defer cancel() defer cancel()
return WaitForWithContext(ctx, wait.WithContext(), fn.WithContext()) return WaitForWithContext(ctx, wait.WithContext(), fn.WithContext())
} }

2
staging/src/k8s.io/apimachinery/pkg/util/wait/wait_test.go
View File

@ -692,7 +692,7 @@ func TestContextForChannel(t *testing.T) {
wg.Add(1) wg.Add(1)
go func() { go func() {
defer wg.Done() defer wg.Done()
ctx, cancel := contextForChannel(parentCh) ctx, cancel := ContextForChannel(parentCh)
defer cancel() defer cancel()
<-ctx.Done() <-ctx.Done()
}() }()