tenet

Documentation

Index

• Variables
• type Options
• type Tenet
  • func New(ctx *cli.Context, b *driver.Base) (Tenet, error)
• type TenetService

Variables

var KillAllTenetsErr = errors.New("kill all tenets")

Types

type Options

type Options map[string]interface{}

type Tenet

type Tenet interface {
	// Pull uses the tenet's driver to pull its image from its repository.
	Pull(bool) error

	// Service initiates the backing mirco-service and returns an object
	// to interact with it. Note the service needs to be explicitly
	// started and stopped.
	OpenService() (TenetService, error)
}

func New

func New(ctx *cli.Context, b *driver.Base) (Tenet, error)

NewTenet takes a base tenet and builds and returns a Tenet with a backing driver and service.

type TenetService

type TenetService interface {

	// Close stops the micro-service. This closes the connection to the service. If
	// it is a locally running micro-service, the locally running process will
	// be killed.
	Close() error

	// Review reads from filesc and writes to issuesc. It is the
	// responsibility of the caller to close filesc. The stream to the service
	// will stay open until filesc is closed.
	Review(filesc <-chan *api.File, issuesc chan<- *api.Issue, t *tomb.Tomb) error

	// Info returns all metadata about this tenet.
	Info() (*api.Info, error)
	// contains filtered or unexported methods
}