singular

package

v0.0.0-...-b0bff92 Latest Latest Go to latest Published: Dec 7, 2021 License: AGPL-3.0 Imports: 6 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/DavinZhang/juju

Documentation ¶

Index ¶

type API
- func NewAPI(apiCaller base.APICaller, claimant names.Tag, entity names.Tag) (*API, error)
- func (api *API) Claim(duration time.Duration) error
- func (api *API) Wait() error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type API ¶

type API struct {
	// contains filtered or unexported fields
}

API allows controller machines to claim responsibility for; or to wait for no other machine to have responsibility for; administration for some model.

func NewAPI ¶

func NewAPI(
	apiCaller base.APICaller,
	claimant names.Tag,
	entity names.Tag,
) (*API, error)

NewAPI returns a new API client for the Singular facade. It exposes methods for claiming and observing administration responsibility for the entity with the supplied tag, on behalf of the authenticated agent.

func (*API) Claim ¶

func (api *API) Claim(duration time.Duration) error

Claim attempts to claim responsibility for administration of the entity for the supplied duration. If the claim is denied, it will return lease.ErrClaimDenied.

func (*API) Wait ¶

func (api *API) Wait() error

Wait blocks until nobody has responsibility for administration of the entity. It should probably be doing something watchy rather than blocky, but it's following the lease manager implementation underlying the original leadership approach and it doesn't seem worth rewriting all that.

Source Files ¶

View all Source files

api.go

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