boxutil

package

v0.3.1 Latest Latest Go to latest Published: Oct 9, 2019 License: Apache-2.0 Imports: 2 Imported by: 6

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

Package boxutil provides some helpful utilities for consuming Machine Box services.

This section is empty.

This section is empty.

func IsReady(status string) bool

IsReady gets whether the box info status is ready or not.

func StatusChan(ctx context.Context, i Box) <-chan string

StatusChan gets a channel that periodically gets the box info and sends a message whenever the status changes.

func WaitForReady(ctx context.Context, i Box) error

WaitForReady blocks until the Box is ready.

type Box interface {
	Info() (*Info, error)
}

Box represents a box client capable of returning Info.

type Info struct {
	Name    string
	Version int
	Build   string
	Status  string
}

Info describes box information.