lifetime

Documentation

Overview

package lifetime provides common component lifetime control logic.

Index

• type IsHealthy
• type Lifetime
  • func NewLifetime[T any](initState T) Lifetime[T]

Types

type IsHealthy

type IsHealthy[T any] func(T) bool

IsHealthy function type for lifetime healthy check.

type Lifetime

type Lifetime[T any] interface {
	// SetState is the method to change lifetime state.
	SetState(state T)
	// GetState returns current state.
	GetState() T
	// Add records a task is running, returns false if the lifetime is not healthy.
	Add(isHealthy IsHealthy[T]) bool
	// Done records a task is done.
	Done()
	// Wait waits until all tasks are done.
	Wait()
}

Lifetime interface for lifetime control.

func NewLifetime

func NewLifetime[T any](initState T) Lifetime[T]

NewLifetime returns a new instance of Lifetime with init state and isHealthy logic.