ready

Documentation

Overview

package implement a simple primitive to wait for readiness of concurrent modules

Index

• type Ready
  • func New(name string) *Ready
  • func (r *Ready) IsReady() bool
  • func (r *Ready) MustWait(timeout ...time.Duration)
  • func (r *Ready) SetReady()
  • func (r *Ready) Wait(timeout ...time.Duration) error

Types

type Ready

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

func New

func New(name string) *Ready

New creates new ready object in 'not ready state'

func (*Ready) IsReady

func (r *Ready) IsReady() bool

func (*Ready) MustWait

func (r *Ready) MustWait(timeout ...time.Duration)

func (*Ready) SetReady

func (r *Ready) SetReady()

SetReady sets the object ready

func (*Ready) Wait

func (r *Ready) Wait(timeout ...time.Duration) error

Wait waits for a timeout until set ready