api

Documentation

Overview

Package api exists because we can't generate mocks in the main namespace.

Index

• type AllWatcher
• type WatchAllAPI

Types

type AllWatcher

type AllWatcher interface {

	// Next returns a new set of deltas from a watcher previously created
	// by the WatchAll or WatchAllModels API calls. It will block until
	// there are deltas to return.
	Next() ([]params.Delta, error)

	// Stop shutdowns down a watcher previously created by the WatchAll or
	// WatchAllModels API calls
	Stop() error
}

AllWatcher represents methods used on the AllWatcher Primarily to facilitate mock tests.

type WatchAllAPI

type WatchAllAPI interface {
	// WatchAll returns an AllWatcher, from which you can request the Next
	// collection of Deltas.
	WatchAll() (AllWatcher, error)
}

WatchAllAPI defines the API methods that allow the watching of a given item.