Documentation
¶
Index ¶
- Constants
- func HumanDuration(d time.Duration) string
- type ExitError
- type IProject
- type ProcOpts
- type Process
- type ProjectOpts
- func (p *ProjectOpts) WithDotEnvDisabled(disabled bool)
- func (p *ProjectOpts) WithIsTuiOn(isTuiOn bool) *ProjectOpts
- func (p *ProjectOpts) WithMainProcess(mainProcess string) *ProjectOpts
- func (p *ProjectOpts) WithMainProcessArgs(mainProcessArgs []string) *ProjectOpts
- func (p *ProjectOpts) WithNoDeps(noDeps bool) *ProjectOpts
- func (p *ProjectOpts) WithOrderedShutDown(isOrderedShutDown bool) *ProjectOpts
- func (p *ProjectOpts) WithProcessesToRun(processesToRun []string) *ProjectOpts
- func (p *ProjectOpts) WithProject(project *types.Project) *ProjectOpts
- type ProjectRunner
- func (p *ProjectRunner) ErrorForSecs() int
- func (p *ProjectRunner) GetDependenciesOrderNames() ([]string, error)
- func (p *ProjectRunner) GetHostName() (string, error)
- func (p *ProjectRunner) GetLexicographicProcessNames() ([]string, error)
- func (p *ProjectRunner) GetLogLength() int
- func (p *ProjectRunner) GetLogsAndSubscribe(name string, observer pclog.LogObserver) error
- func (p *ProjectRunner) GetProcessInfo(name string) (*types.ProcessConfig, error)
- func (p *ProjectRunner) GetProcessLog(name string, offsetFromEnd, limit int) ([]string, error)
- func (p *ProjectRunner) GetProcessLogLength(name string) int
- func (p *ProjectRunner) GetProcessPorts(name string) (*types.ProcessPorts, error)
- func (p *ProjectRunner) GetProcessState(name string) (*types.ProcessState, error)
- func (p *ProjectRunner) GetProcessesState() (*types.ProcessesState, error)
- func (p *ProjectRunner) GetProjectState(checkMem bool) (*types.ProjectState, error)
- func (p *ProjectRunner) IsRemote() bool
- func (p *ProjectRunner) ReloadProject() (map[string]string, error)
- func (p *ProjectRunner) RestartProcess(name string) error
- func (p *ProjectRunner) Run() error
- func (p *ProjectRunner) ScaleProcess(name string, scale int) error
- func (p *ProjectRunner) SetProcessPassword(name, pass string) error
- func (p *ProjectRunner) ShutDownProject() error
- func (p *ProjectRunner) StartProcess(name string) error
- func (p *ProjectRunner) StopProcess(name string) error
- func (p *ProjectRunner) StopProcesses(names []string) (map[string]string, error)
- func (p *ProjectRunner) UnSubscribeLogger(name string, observer pclog.LogObserver) error
- func (p *ProjectRunner) UpdateProcess(updated *types.ProcessConfig) error
- func (p *ProjectRunner) UpdateProject(project *types.Project) (map[string]string, error)
- func (p *ProjectRunner) WaitForProjectShutdown()
Constants ¶
View Source
const ( UndefinedShutdownTimeoutSec = 0 DefaultShutdownTimeoutSec = 10 EnvReplicaNum = "PC_REPLICA_NUM" LogReplicaNum = "{" + EnvReplicaNum + "}" )
Variables ¶
This section is empty.
Functions ¶
func HumanDuration ¶ added in v1.46.0
HumanDuration returns a succinct representation of the provided duration with limited precision for consumption by humans. It provides ~2-3 significant figures of duration.
Types ¶
type IProject ¶ added in v0.50.0
type IProject interface { ShutDownProject() error IsRemote() bool ErrorForSecs() int GetHostName() (string, error) GetProjectState(checkMem bool) (*types.ProjectState, error) GetLogLength() int GetLogsAndSubscribe(name string, observer pclog.LogObserver) error UnSubscribeLogger(name string, observer pclog.LogObserver) error GetProcessLog(name string, offsetFromEnd, limit int) ([]string, error) GetLexicographicProcessNames() ([]string, error) GetProcessInfo(name string) (*types.ProcessConfig, error) GetProcessState(name string) (*types.ProcessState, error) GetProcessesState() (*types.ProcessesState, error) StopProcess(name string) error StopProcesses(names []string) (map[string]string, error) StartProcess(name string) error RestartProcess(name string) error ScaleProcess(name string, scale int) error GetProcessPorts(name string) (*types.ProcessPorts, error) SetProcessPassword(name string, password string) error UpdateProject(project *types.Project) (map[string]string, error) UpdateProcess(updated *types.ProcessConfig) error ReloadProject() (map[string]string, error) }
IProject holds all the functions from the project struct that are being consumed by the tui package
type Process ¶
func NewProcess ¶
type ProjectOpts ¶ added in v0.77.4
type ProjectOpts struct {
// contains filtered or unexported fields
}
func (*ProjectOpts) WithDotEnvDisabled ¶ added in v1.34.0
func (p *ProjectOpts) WithDotEnvDisabled(disabled bool)
func (*ProjectOpts) WithIsTuiOn ¶ added in v0.77.4
func (p *ProjectOpts) WithIsTuiOn(isTuiOn bool) *ProjectOpts
func (*ProjectOpts) WithMainProcess ¶ added in v0.77.4
func (p *ProjectOpts) WithMainProcess(mainProcess string) *ProjectOpts
func (*ProjectOpts) WithMainProcessArgs ¶ added in v0.77.4
func (p *ProjectOpts) WithMainProcessArgs(mainProcessArgs []string) *ProjectOpts
func (*ProjectOpts) WithNoDeps ¶ added in v0.77.4
func (p *ProjectOpts) WithNoDeps(noDeps bool) *ProjectOpts
func (*ProjectOpts) WithOrderedShutDown ¶ added in v1.0.0
func (p *ProjectOpts) WithOrderedShutDown(isOrderedShutDown bool) *ProjectOpts
func (*ProjectOpts) WithProcessesToRun ¶ added in v0.77.4
func (p *ProjectOpts) WithProcessesToRun(processesToRun []string) *ProjectOpts
func (*ProjectOpts) WithProject ¶ added in v0.77.4
func (p *ProjectOpts) WithProject(project *types.Project) *ProjectOpts
type ProjectRunner ¶ added in v0.40.0
type ProjectRunner struct {
// contains filtered or unexported fields
}
func NewProjectRunner ¶ added in v0.40.0
func NewProjectRunner(opts *ProjectOpts) (*ProjectRunner, error)
func (*ProjectRunner) ErrorForSecs ¶ added in v0.50.0
func (p *ProjectRunner) ErrorForSecs() int
func (*ProjectRunner) GetDependenciesOrderNames ¶ added in v0.40.0
func (p *ProjectRunner) GetDependenciesOrderNames() ([]string, error)
GetDependenciesOrderNames used for testing
func (*ProjectRunner) GetHostName ¶ added in v0.50.0
func (p *ProjectRunner) GetHostName() (string, error)
func (*ProjectRunner) GetLexicographicProcessNames ¶ added in v0.50.0
func (p *ProjectRunner) GetLexicographicProcessNames() ([]string, error)
func (*ProjectRunner) GetLogLength ¶ added in v0.40.0
func (p *ProjectRunner) GetLogLength() int
func (*ProjectRunner) GetLogsAndSubscribe ¶ added in v0.40.0
func (p *ProjectRunner) GetLogsAndSubscribe(name string, observer pclog.LogObserver) error
func (*ProjectRunner) GetProcessInfo ¶ added in v0.40.0
func (p *ProjectRunner) GetProcessInfo(name string) (*types.ProcessConfig, error)
func (*ProjectRunner) GetProcessLog ¶ added in v0.40.0
func (p *ProjectRunner) GetProcessLog(name string, offsetFromEnd, limit int) ([]string, error)
func (*ProjectRunner) GetProcessLogLength ¶ added in v0.40.0
func (p *ProjectRunner) GetProcessLogLength(name string) int
func (*ProjectRunner) GetProcessPorts ¶ added in v0.55.0
func (p *ProjectRunner) GetProcessPorts(name string) (*types.ProcessPorts, error)
func (*ProjectRunner) GetProcessState ¶ added in v0.40.0
func (p *ProjectRunner) GetProcessState(name string) (*types.ProcessState, error)
func (*ProjectRunner) GetProcessesState ¶ added in v0.50.0
func (p *ProjectRunner) GetProcessesState() (*types.ProcessesState, error)
func (*ProjectRunner) GetProjectState ¶ added in v0.75.0
func (p *ProjectRunner) GetProjectState(checkMem bool) (*types.ProjectState, error)
func (*ProjectRunner) IsRemote ¶ added in v0.50.0
func (p *ProjectRunner) IsRemote() bool
func (*ProjectRunner) ReloadProject ¶ added in v1.34.0
func (p *ProjectRunner) ReloadProject() (map[string]string, error)
func (*ProjectRunner) RestartProcess ¶ added in v0.40.0
func (p *ProjectRunner) RestartProcess(name string) error
func (*ProjectRunner) Run ¶ added in v0.40.0
func (p *ProjectRunner) Run() error
func (*ProjectRunner) ScaleProcess ¶ added in v0.55.0
func (p *ProjectRunner) ScaleProcess(name string, scale int) error
func (*ProjectRunner) SetProcessPassword ¶ added in v1.9.0
func (p *ProjectRunner) SetProcessPassword(name, pass string) error
func (*ProjectRunner) ShutDownProject ¶ added in v0.40.0
func (p *ProjectRunner) ShutDownProject() error
func (*ProjectRunner) StartProcess ¶ added in v0.40.0
func (p *ProjectRunner) StartProcess(name string) error
func (*ProjectRunner) StopProcess ¶ added in v0.40.0
func (p *ProjectRunner) StopProcess(name string) error
func (*ProjectRunner) StopProcesses ¶ added in v0.60.0
func (p *ProjectRunner) StopProcesses(names []string) (map[string]string, error)
func (*ProjectRunner) UnSubscribeLogger ¶ added in v0.40.0
func (p *ProjectRunner) UnSubscribeLogger(name string, observer pclog.LogObserver) error
func (*ProjectRunner) UpdateProcess ¶ added in v1.34.0
func (p *ProjectRunner) UpdateProcess(updated *types.ProcessConfig) error
func (*ProjectRunner) UpdateProject ¶ added in v1.27.0
func (*ProjectRunner) WaitForProjectShutdown ¶ added in v1.18.0
func (p *ProjectRunner) WaitForProjectShutdown()
Click to show internal directories.
Click to hide internal directories.