meterstatus

Documentation

Overview

Package meterstatus contains an implementation of the api facade to watch the meter status of a unit for changes and return the current meter status.

Index

• type Client
  • func (c *Client) MeterStatus() (statusCode, statusInfo string, rErr error)
  • func (c *Client) WatchMeterStatus() (watcher.NotifyWatcher, error)
• type MeterStatusClient
  • func NewClient(caller base.APICaller, tag names.UnitTag) MeterStatusClient

Types

type Client

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

Client provides access to the meter status API.

func (*Client) MeterStatus

func (c *Client) MeterStatus() (statusCode, statusInfo string, rErr error)

MeterStatus is part of the MeterStatusClient interface.

func (*Client) WatchMeterStatus

func (c *Client) WatchMeterStatus() (watcher.NotifyWatcher, error)

WatchMeterStatus is part of the MeterStatusClient interface.

type MeterStatusClient

type MeterStatusClient interface {
	// MeterStatus returns the meter status and additional information for the
	// API client.
	MeterStatus() (string, string, error)
	// WatchMeterStatus returns a watcher for observing changes to the unit's meter
	// status.
	WatchMeterStatus() (watcher.NotifyWatcher, error)
}

MeterStatusClient defines the methods on the MeterStatus API end point.

func NewClient

func NewClient(caller base.APICaller, tag names.UnitTag) MeterStatusClient

NewClient creates a new client for accessing the MeterStatus API.