The highest tagged major version is v4.

wait

package

v3.31.1 Latest Latest Go to latest Published: Mar 4, 2024 License: MIT Imports: 1 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/algolia/algoliasearch-client-go

Links

Open Source Insights

Documentation ¶

Index ¶

func Wait(waitables ...Waitable) error
type Group
- func NewGroup() *Group
- func (a *Group) Collect(waitables ...Waitable)
- func (a *Group) Wait() error
type Waitable

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Wait ¶

func Wait(waitables ...Waitable) error

Wait blocks until all the given `algolia.Waitable` objects have completed. If one of the objects returned an error upon `Wait` invocation, this error is returned. Otherwise, nil is returned.

Types ¶

type Group ¶

type Group struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewGroup ¶

func NewGroup() *Group

NewGroup returns a newly instantiated `Group` object. This instance can collect objects implementing the `algolia.Waitable` interface, including most of the Algolia response objects, and wait for their completion in a concurrent fashion.

func (*Group) Collect ¶

func (a *Group) Collect(waitables ...Waitable)

Collect holds references to the given `algolia.Waitable` objects in order to wait for their completion once the `Wait` method will be invoked. Calling `Collect` from multiple goroutines is safe.

func (*Group) Wait ¶

func (a *Group) Wait() error

Wait blocks until all the collected `algolia.Waitable` objects have completed. If one of the objects returned an error upon `Wait` invocation, this error is returned. Otherwise, nil is returned. Calling `Wait` from multiple goroutines is safe.

Upon successful completion, the `Group` object can be reused directly to collect other `algolia.Waitable` objects.

type Waitable ¶

type Waitable interface {
	Wait(opts ...interface{}) error
}

Waitable represents any asynchronous and potentially long-blocking operation which may eventually fail. Most of Algolia response objects are implementing the `algolia.Waitable` interface in order to wait for their completion using `algolia.NewGroup()` or `algolia.Wait()` provided helpers.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL