heartbeat

Documentation

Index

• Variables
• func Heartbeat(ctx context.Context, backend kvstore.BackendOperations)

Variables

var Cell = cell.Module(
	"kvstore-heartbeat-updater",
	"KVStore Heartbeat Updater",

	cell.Invoke(func(lc cell.Lifecycle, backendPromise promise.Promise[kvstore.BackendOperations]) {
		ctx, cancel := context.WithCancel(context.Background())
		var wg sync.WaitGroup

		lc.Append(cell.Hook{
			OnStart: func(cell.HookContext) error {
				wg.Add(1)
				go func() {
					defer wg.Done()

					backend, err := backendPromise.Await(ctx)
					if err != nil {

						return
					}

					Heartbeat(ctx, backend)
				}()
				return nil
			},

			OnStop: func(ctx cell.HookContext) error {
				cancel()
				wg.Wait()
				return nil
			},
		})
	}),
)

Cell creates a cell responsible for periodically updating the heartbeat key in the kvstore.

Functions

func Heartbeat

func Heartbeat(ctx context.Context, backend kvstore.BackendOperations)

Heartbeat periodically updates the heatbeat path through the given client, blocking until the context is canceled.