api

Documentation

Index

• func ConnectToRunner(killChannel chan bool, debug bool) (runner.Runner, error)
• func RunInBackground(apiPort string, specDirs []string)
• func Start(specsDir []string) *conn.GaugeConnectionHandler
• type StartChannels
  • func StartAPI(debug bool) *StartChannels

Functions

func ConnectToRunner

func ConnectToRunner(killChannel chan bool, debug bool) (runner.Runner, error)

func RunInBackground

func RunInBackground(apiPort string, specDirs []string)

RunInBackground runs Gauge in daemonized mode on the given apiPort

func Start

func Start(specsDir []string) *conn.GaugeConnectionHandler

Types

type StartChannels

type StartChannels struct {
	// this will hold the runner
	RunnerChan chan runner.Runner
	// this will hold the error while creating runner
	ErrorChan chan error
	// this holds a flag based on which the runner is terminated
	KillChan chan bool
}

func StartAPI

func StartAPI(debug bool) *StartChannels

StartAPI calls StartAPIService and returns the channels