poll

Documentation

Overview

Copyright (c) 2022 Dell Inc, or its subsidiaries.

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.

Index

• Variables
• func ImmediateWithContext(ctx context.Context, interval, timeout time.Duration, ...) error
• func WaitForWithContext(ctx context.Context, wait WaitWithContextFunc, fn ConditionWithContextFunc) error
• type ConditionWithContextFunc
• type WaitWithContextFunc

Variables

var ErrWaitTimeout = errors.New("timed out waiting for the condition")

Functions

func ImmediateWithContext

func ImmediateWithContext(ctx context.Context, interval, timeout time.Duration, condition ConditionWithContextFunc) error

func WaitForWithContext

func WaitForWithContext(ctx context.Context, wait WaitWithContextFunc, fn ConditionWithContextFunc) error

Types

type ConditionWithContextFunc

type ConditionWithContextFunc func(context.Context) (done bool, err error)

type WaitWithContextFunc

type WaitWithContextFunc func(ctx context.Context) <-chan struct{}