package poller

Import Path
	golang.org/x/pkgsite/internal/poller (on go.dev)

Dependency Relation
	imports 3 packages, and imported by 2 packages

Involved Source Files

	   d➜ poller.go
		Package poller supports periodic polling to load a value.
Package-Level Type Names (total 2, both are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Getter (func)
		A Getter returns a value.

		As Inputs Of (at least one exported)
			func New(initial interface{}, getter Getter, onError func(error)) *Poller

	 type Poller (struct)
		A Poller maintains a current value, and refreshes it by periodically
		polling for a new value.

		Fields (total 4, none are exported)
			/* 4 unexporteds ... *//* 4 unexporteds: */
			current interface{}
			getter Getter
			mu sync.Mutex
			onError func(error)
		Methods (total 3, all are exported)
			(*T) Current() interface{}
				Current returns the current value. Initially, this is the value passed to New.
				After each successful poll, the value is updated.
				If a poll fails, the value remains unchanged.

			(*T) Poll(ctx context.Context)
				Poll calls p's getter immediately and synchronously.

			(*T) Start(ctx context.Context, period time.Duration)
				Start begins polling in a separate goroutine, at the given period. To stop
				the goroutine, cancel the context passed to Start.

		As Outputs Of (at least one exported)
			func New(initial interface{}, getter Getter, onError func(error)) *Poller


Package-Level Functions (only one, which is exported)

	 func New(initial interface{}, getter Getter, onError func(error)) *Poller
		New creates a new poller with an initial value. The getter is invoked
		to obtain updated values. Errors returned from the getter are passed
		to onError.

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.