gapi

Documentation

Overview

Package gapi defines the interface that graph API generators must meet.

Index

• type Data
• type GAPI
• type World

Types

type Data

type Data struct {
	Hostname string // uuid for the host, required for GAPI
	World    World
	Noop     bool
	NoWatch  bool
}

Data is the set of input values passed into the GAPI structs via Init.

type GAPI

type GAPI interface {
	Init(Data) error               // initializes the GAPI and passes in useful data
	Graph() (*pgraph.Graph, error) // returns the most recent pgraph
	Next() chan error              // returns a stream of switch events
	Close() error                  // shutdown the GAPI
}

GAPI is a Graph API that represents incoming graphs and change streams.

type World

type World interface {
	ResExport([]resources.Res) error
	// FIXME: should this method take a "filter" data struct instead of many args?
	ResCollect(hostnameFilter, kindFilter []string) ([]resources.Res, error)
}

World is an interface to the rest of the different graph state. It allows the GAPI to store state and exchange information throughout the cluster. It is the interface each machine uses to communicate with the rest of the world.