core

Documentation

Index

• Variables
• func GetCommands() (cmdSet []*exec.Cmd, err error)
• func GetPackBinary(name string) (binaryName string, err error)
• func GetPackNames() (packNames []string, err error)
• func NewClient(cmd *exec.Cmd) *hcplugin.Client
• func SetupCloseHandler()
• func UserHomeDir() string
• type ServicePackError
• type ServicePackErrors
  • func (e *ServicePackErrors) Error() string

Variables

var AllPacks *bool

AllPacks is a CLI option to target all installed packs, instead of just those specified in config.yml

var BinariesPath *string

BinariesPath represents the path where service pack binaries are installed Must be a pointer to accept the flag when it is set

var Verbose *bool

Verbose is a CLI option to increase output detail

Functions

func GetCommands

func GetCommands() (cmdSet []*exec.Cmd, err error)

GetCommands ...

func GetPackBinary

func GetPackBinary(name string) (binaryName string, err error)

GetPackBinary finds provided service pack in installation folder and return binary name

func GetPackNames

func GetPackNames() (packNames []string, err error)

GetPackNames returns all service packs declared in config file

func NewClient

func NewClient(cmd *exec.Cmd) *hcplugin.Client

NewClient client handles the lifecycle of a plugin application Plugin hosts should use one Client for each plugin executable (this is different from the client that manages gRPC)

func SetupCloseHandler

func SetupCloseHandler()

SetupCloseHandler creates a 'listener' on a new goroutine which will notify the program if it receives an interrupt from the OS. We then handle this by calling our clean up procedure and exiting the program. Ref: https://golangcode.com/handle-ctrl-c-exit-in-terminal/

func UserHomeDir

func UserHomeDir() string

UserHomeDir provides the OS-aware user home directory TODO: move this to SDK

Types

type ServicePackError

type ServicePackError struct {
	ServicePack string
	Err         error
}

ServicePackError ...

type ServicePackErrors

type ServicePackErrors struct {
	SPErrs []ServicePackError
}

ServicePackErrors ...

func (*ServicePackErrors) Error

func (e *ServicePackErrors) Error() string