poll

Documentation

Overview

Package poll is an opinionated library for polling in the Signadot CLI.

Index

• type Poll
  • func NewPoll() *Poll
  • func (p *Poll) Until(fn func() bool) error
  • func (p *Poll) UntilWithError(fn func() (bool, error)) error
  • func (p *Poll) WithDelay(delay time.Duration) *Poll
  • func (p *Poll) WithResetOnLoop(resetOnLoop bool) *Poll
  • func (p *Poll) WithTimeout(timeout time.Duration) *Poll

Types

type Poll

type Poll struct {
	// contains filtered or unexported fields
}

func NewPoll

func NewPoll() *Poll

func (*Poll) Until

func (p *Poll) Until(fn func() bool) error

Until polls until the given function returns true, or the timeout expires.

func (*Poll) UntilWithError

func (p *Poll) UntilWithError(fn func() (bool, error)) error

UntilWithError polls until the given function returns true, or the timeout expires. But also can return error so can be pass down to handle proper errors

func (*Poll) WithDelay

func (p *Poll) WithDelay(delay time.Duration) *Poll

func (*Poll) WithResetOnLoop

func (p *Poll) WithResetOnLoop(resetOnLoop bool) *Poll

func (*Poll) WithTimeout

func (p *Poll) WithTimeout(timeout time.Duration) *Poll