webui

Documentation

Index

• Constants
• func RemoteStop(host string, port string) error
• type Config
  • func Init() *Config
  • func (c *Config) Start() error
  • func (c *Config) Stop() error
  • func (c *Config) Wait()

Constants

const (

	// DefaultPort is the default port used to start the webui
	DefaultPort = 8080
)

Functions

func RemoteStop

func RemoteStop(host string, port string) error

RemoteStop remotely terminates a WebUI by sending a termination request

Types

type Config

type Config struct {
	Port int

	DatasetDir string
	Name       string

	Plugins plugins.Plugins
	// contains filtered or unexported fields
}

Config represents the configuration of a webUI

func Init

func Init() *Config

Init creates a configuration for the webui that can then be used to start/stop a webui

func (*Config) Start

func (c *Config) Start() error

Start instantiates a HTTP server and start the webUI. This is a non-blocking function, meaning the function returns after successfully initiating the WebUI. To wait for the termination of the webUI, please use Wait()

func (*Config) Stop

func (c *Config) Stop() error

Stop cleanly terminates a running webUI

func (*Config) Wait

func (c *Config) Wait()

Wait makes the current process wait for the termination of the webUI