programs

Documentation

Index

• Variables
• func Create(id string, serverType string, data map[string]interface{}) bool
• func Delete(id string) (err error)
• func GetPlugin(name string) (interface{}, error)
• func GetPluginReadme(name string) (string, error)
• func GetPlugins() map[string]interface{}
• func InitService()
• func Initialize()
• func LoadFromFolder()
• func Reload(id string) (err error)
• func Save(id string) (err error)
• func ShutdownService()
• func StartViaService(p Program)
• type DataObject
• type InstallSection
• type Program
  • func Get(id string) (program Program, err error)
  • func GetAll() []Program
  • func GetFromCache(id string) Program
  • func Load(id string) (program Program, err error)
  • func LoadFromData(id string, source []byte) (program Program, err error)
• type ProgramData
  • func CreateProgram() ProgramData
  • func (p *ProgramData) CopyFrom(s *ProgramData)
  • func (p *ProgramData) Create() (err error)
  • func (p ProgramData) DataToMap() map[string]interface{}
  • func (p *ProgramData) Destroy() (err error)
  • func (p *ProgramData) Edit(data map[string]interface{}) (err error)
  • func (p *ProgramData) Execute(command string) (err error)
  • func (p *ProgramData) GetData() map[string]DataObject
  • func (p *ProgramData) GetEnvironment() environments.Environment
  • func (p *ProgramData) GetNetwork() string
  • func (p *ProgramData) Id() string
  • func (p *ProgramData) Install() (err error)
  • func (p *ProgramData) IsAutoStart() (isAutoStart bool)
  • func (p *ProgramData) IsEnabled() (isEnabled bool)
  • func (p *ProgramData) IsRunning() (isRunning bool, err error)
  • func (p *ProgramData) Kill() (err error)
  • func (p *ProgramData) Save(file string) (err error)
  • func (p *ProgramData) SetAutoStart(isAutoStart bool) (err error)
  • func (p *ProgramData) SetEnabled(isEnabled bool) (err error)
  • func (p *ProgramData) SetEnvironment(environment environments.Environment) (err error)
  • func (p *ProgramData) Start() (err error)
  • func (p *ProgramData) Stop() (err error)
• type ProgramTemplate
  • func (pt ProgramTemplate) Create(environment map[string]interface{}) Program
• type ProgramTemplateData
• type RunObject
• type ServerJson

Variables

var (
	ServerFolder   string
	TemplateFolder string
)

Functions

func Create

func Create(id string, serverType string, data map[string]interface{}) bool

func Delete

func Delete(id string) (err error)

func GetPlugin

func GetPlugin(name string) (interface{}, error)

func GetPluginReadme

func GetPluginReadme(name string) (string, error)

func GetPlugins

func GetPlugins() map[string]interface{}

func InitService

func InitService()

func Initialize

func Initialize()

func LoadFromFolder

func LoadFromFolder()

func Reload

func Reload(id string) (err error)

func Save

func Save(id string) (err error)

func ShutdownService

func ShutdownService()

func StartViaService

func StartViaService(p Program)

Types

type DataObject

type DataObject struct {
	Description  string      `json:"desc,omitempty"`
	Display      string      `json:"display,omitempty"`
	Internal     bool        `json:"internal,omitempty"`
	Required     bool        `json:"required,omitempty"`
	Value        interface{} `json:"value,omitempty"`
	UserEditable bool        `json:"userEdit,omitempty"`
}

type InstallSection

type InstallSection struct {
	Operations []map[string]interface{} `json:"commands,,omitempty"`
}

type Program

type Program interface {
	//Starts the program.
	//This includes starting the environment if it is not running.
	Start() (err error)

	//Stops the program.
	//This will also stop the environment it is ran in.
	Stop() (err error)

	//Kills the program.
	//This will also stop the environment it is ran in.
	Kill() (err error)

	//Creates any files needed for the program.
	//This includes creating the environment.
	Create() (err error)

	//Destroys the server.
	//This will delete the server, environment, and any files related to it.
	Destroy() (err error)

	Install() (err error)

	//Determines if the server is running.
	IsRunning() (isRunning bool, err error)

	//Sends a command to the process
	//If the program supports input, this will send the arguments to that.
	Execute(command string) (err error)

	SetEnabled(isEnabled bool) (err error)

	IsEnabled() (isEnabled bool)

	SetAutoStart(isAutoStart bool) (err error)

	IsAutoStart() (isAutoStart bool)

	SetEnvironment(environment environments.Environment) (err error)

	Id() string

	GetEnvironment() environments.Environment

	Save(file string) (err error)

	Edit(data map[string]interface{}) (err error)

	GetData() map[string]DataObject

	GetNetwork() string
}

func Get

func Get(id string) (program Program, err error)

func GetAll

func GetAll() []Program

func GetFromCache

func GetFromCache(id string) Program

func Load

func Load(id string) (program Program, err error)

func LoadFromData

func LoadFromData(id string, source []byte) (program Program, err error)

type ProgramData

type ProgramData struct {
	Data            map[string]DataObject  `json:"data,omitempty"`
	Display         string                 `json:"display,omitempty"`
	EnvironmentData map[string]interface{} `json:"environment,omitempty"`
	InstallData     InstallSection         `json:"install,omitempty"`
	UninstallData   InstallSection         `json:"uninstall,omitempty"`
	Type            string                 `json:"type,omitempty"`
	Identifier      string                 `json:"id,omitempty"`
	RunData         RunObject              `json:"run,omitempty"`
	Template        string                 `json:"template,omitempty"`

	Environment  environments.Environment `json:"-"`
	CrashCounter int                      `json:"-"`
}

func CreateProgram

func CreateProgram() ProgramData

func (*ProgramData) CopyFrom

func (p *ProgramData) CopyFrom(s *ProgramData)

func (*ProgramData) Create

func (p *ProgramData) Create() (err error)

Creates any files needed for the program. This includes creating the environment.

func (ProgramData) DataToMap

func (p ProgramData) DataToMap() map[string]interface{}

func (*ProgramData) Destroy

func (p *ProgramData) Destroy() (err error)

Destroys the server. This will delete the server, environment, and any files related to it.

func (*ProgramData) Edit

func (p *ProgramData) Edit(data map[string]interface{}) (err error)

func (*ProgramData) Execute

func (p *ProgramData) Execute(command string) (err error)

Sends a command to the process If the program supports input, this will send the arguments to that.

func (*ProgramData) GetData

func (p *ProgramData) GetData() map[string]DataObject

func (*ProgramData) GetEnvironment

func (p *ProgramData) GetEnvironment() environments.Environment

func (*ProgramData) GetNetwork

func (p *ProgramData) GetNetwork() string

func (*ProgramData) Id

func (p *ProgramData) Id() string

func (*ProgramData) Install

func (p *ProgramData) Install() (err error)

func (*ProgramData) IsAutoStart

func (p *ProgramData) IsAutoStart() (isAutoStart bool)

func (*ProgramData) IsEnabled

func (p *ProgramData) IsEnabled() (isEnabled bool)

func (*ProgramData) IsRunning

func (p *ProgramData) IsRunning() (isRunning bool, err error)

Determines if the server is running.

func (*ProgramData) Kill

func (p *ProgramData) Kill() (err error)

Kills the program. This will also stop the environment it is ran in.

func (*ProgramData) Save

func (p *ProgramData) Save(file string) (err error)

func (*ProgramData) SetAutoStart

func (p *ProgramData) SetAutoStart(isAutoStart bool) (err error)

func (*ProgramData) SetEnabled

func (p *ProgramData) SetEnabled(isEnabled bool) (err error)

func (*ProgramData) SetEnvironment

func (p *ProgramData) SetEnvironment(environment environments.Environment) (err error)

func (*ProgramData) Start

func (p *ProgramData) Start() (err error)

Starts the program. This includes starting the environment if it is not running.

func (*ProgramData) Stop

func (p *ProgramData) Stop() (err error)

Stops the program. This will also stop the environment it is ran in.

type ProgramTemplate

type ProgramTemplate struct {
	Core ProgramTemplateData `json:"pufferd"`
}

func (ProgramTemplate) Create

func (pt ProgramTemplate) Create(environment map[string]interface{}) Program

type ProgramTemplateData

type ProgramTemplateData struct {
	ProgramData
	SupportedEnvironments map[string]interface{} `json:"supportedEnvironments"`
}

type RunObject

type RunObject struct {
	Arguments               []string                 `json:"arguments,omitempty"`
	Program                 string                   `json:"program,omitempty"`
	Stop                    string                   `json:"stop,omitempty"`
	Enabled                 bool                     `json:"enabled,omitempty"`
	AutoStart               bool                     `json:"autostart,omitempty"`
	AutoRestartFromCrash    bool                     `json:"autorecover,omitempty"`
	AutoRestartFromGraceful bool                     `json:"autorestart,omitempty"`
	Pre                     []map[string]interface{} `json:"pre,omitempty"`
	Post                    []map[string]interface{} `json:"post,omitempty"`
	StopCode                int                      `json:"stopCode,omitempty"`
	EnvironmentVariables    map[string]string        `json:"environmentVars,omitempty"`
}

type ServerJson

type ServerJson struct {
	ProgramData ProgramData `json:"pufferd"`
}