wait

Documentation

Index

• Variables
• func ForAll(ctx context.Context, waiters []Fn) error
• type Fn
• type SyncedCommon
  • func NewSyncedCommon() SyncedCommon
  • func (sc *SyncedCommon) Stop()
  • func (sc *SyncedCommon) Wait(ctx context.Context, chs ...<-chan struct{}) error
• type TimeoutConfig
  • func (def TimeoutConfig) Flags(flags *pflag.FlagSet)

Variables

var (
	// TimeoutConfigDefault is the default timeout configuration.
	TimeoutConfigDefault = TimeoutConfig{
		ClusterMeshSyncTimeout: 1 * time.Minute,
	}

	// ErrRemoteClusterDisconnected is the error returned by wait for sync
	// operations if the remote cluster is disconnected while still waiting.
	ErrRemoteClusterDisconnected = errors.New("remote cluster disconnected")
)

Functions

func ForAll

func ForAll(ctx context.Context, waiters []Fn) error

ForAll returns after the all of the provided waiters have been executed.

Types

type Fn

type Fn func(ctx context.Context) error

Fn is the type of a function to wait for the initial synchronization of a given resource type from all remote clusters.

type SyncedCommon

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

SyncedCommon contains common fields and methods used for tracking the synchronization status of a remote cluster.

func NewSyncedCommon

func NewSyncedCommon() SyncedCommon

NewSyncedCommon returns a new SyncedCommon instance.

func (*SyncedCommon) Stop

func (sc *SyncedCommon) Stop()

func (*SyncedCommon) Wait

func (sc *SyncedCommon) Wait(ctx context.Context, chs ...<-chan struct{}) error

Wait returns after all of the given channels have been closed, the remote cluster has been disconnected, or the given context has been cancelled.

type TimeoutConfig

type TimeoutConfig struct {
	// ClusterMeshSyncTimeout is the timeout when waiting for the initial
	// synchronization from all remote clusters, before triggering the
	// circuit breaker and possibly disrupting cross-cluster connections.
	ClusterMeshSyncTimeout time.Duration
}

func (TimeoutConfig) Flags

func (def TimeoutConfig) Flags(flags *pflag.FlagSet)