common

Documentation

Index

• Variables
• func Life(caller base.FacadeCaller, tag names.Tag) (params.Life, error)
• func Watch(facade base.FacadeCaller, tag names.Tag) (watcher.NotifyWatcher, error)
• type APIAddresser
  • func NewAPIAddresser(facade base.FacadeCaller) *APIAddresser
  • func (a *APIAddresser) APIAddresses() ([]string, error)
  • func (a *APIAddresser) APIHostPorts() ([][]network.HostPort, error)
  • func (a *APIAddresser) CACert() (string, error)
  • func (a *APIAddresser) EnvironUUID() (string, error)
  • func (a *APIAddresser) WatchAPIHostPorts() (watcher.NotifyWatcher, error)
• type EnvironWatcher
  • func NewEnvironWatcher(facade base.FacadeCaller) *EnvironWatcher
  • func (e *EnvironWatcher) EnvironConfig() (*config.Config, error)
  • func (e *EnvironWatcher) WatchForEnvironConfigChanges() (watcher.NotifyWatcher, error)

Variables

var (
	ErrPartialResults = errors.New("API call only returned partial results")
)

Functions

func Life

func Life(caller base.FacadeCaller, tag names.Tag) (params.Life, error)

Life requests the life cycle of the given entity from the given server-side API facade via the given caller.

func Watch

func Watch(facade base.FacadeCaller, tag names.Tag) (watcher.NotifyWatcher, error)

Watch starts a NotifyWatcher for the entity with the specified tag.

Types

type APIAddresser

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

APIAddresser provides common client-side API functions to call into apiserver.common.APIAddresser

func NewAPIAddresser

func NewAPIAddresser(facade base.FacadeCaller) *APIAddresser

NewAPIAddresser returns a new APIAddresser that makes API calls using caller and the specified facade name.

func (*APIAddresser) APIAddresses

func (a *APIAddresser) APIAddresses() ([]string, error)

APIAddresses returns the list of addresses used to connect to the API.

func (*APIAddresser) APIHostPorts

func (a *APIAddresser) APIHostPorts() ([][]network.HostPort, error)

APIHostPorts returns the host/port addresses of the API servers.

func (*APIAddresser) CACert

func (a *APIAddresser) CACert() (string, error)

CACert returns the certificate used to validate the API and state connections.

func (*APIAddresser) EnvironUUID

func (a *APIAddresser) EnvironUUID() (string, error)

EnvironUUID returns the environment UUID to connect to the environment that the current connection is for.

func (*APIAddresser) WatchAPIHostPorts

func (a *APIAddresser) WatchAPIHostPorts() (watcher.NotifyWatcher, error)

WatchAPIHostPorts watches the host/port addresses of the API servers.

type EnvironWatcher

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

EnvironWatcher provides common client-side API functions to call into apiserver.common.EnvironWatcher.

func NewEnvironWatcher

func NewEnvironWatcher(facade base.FacadeCaller) *EnvironWatcher

NewEnvironWatcher creates a EnvironWatcher on the specified facade, and uses this name when calling through the caller.

func (*EnvironWatcher) EnvironConfig

func (e *EnvironWatcher) EnvironConfig() (*config.Config, error)

EnvironConfig returns the current environment configuration.

func (*EnvironWatcher) WatchForEnvironConfigChanges

func (e *EnvironWatcher) WatchForEnvironConfigChanges() (watcher.NotifyWatcher, error)

WatchForEnvironConfigChanges return a NotifyWatcher waiting for the environment configuration to change.