client

package
v1.110.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 1, 2026 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type LogClient added in v0.50.0 

type LogClient struct {
	Format string

	PrintProcessName bool
	// contains filtered or unexported fields
}

func NewLogClient added in v0.50.0 

func NewLogClient(address, socketPath string) *LogClient

func (*LogClient) CloseChannel added in v0.50.0 

func (l *LogClient) CloseChannel() error

CloseChannel Cleanly close the connection by sending a close message and then waiting (with timeout) for the server to close the connection.

func (*LogClient) ReadProcessLogs added in v0.50.0 

func (l *LogClient) ReadProcessLogs(name string, offset int, follow bool, fn func(api.LogMessage)) (done chan struct{}, err error)

type PcClient added in v0.50.0 

type PcClient struct {
	// contains filtered or unexported fields
}

func NewTcpClient added in v1.2.0 

func NewTcpClient(host string, port, logLength int) *PcClient

func NewUdsClient added in v1.2.0 

func NewUdsClient(sockPath string, logLength int) *PcClient

func (*PcClient) ErrorForSecs added in v0.50.0 

func (p *PcClient) ErrorForSecs() int

func (*PcClient) GetDependencyGraph added in v1.87.0 

func (p *PcClient) GetDependencyGraph() (*types.DependencyGraph, error)

func (*PcClient) GetFullProcessEnvironment added in v1.87.0 

func (p *PcClient) GetFullProcessEnvironment(proc *types.ProcessConfig) []string

func (*PcClient) GetLexicographicProcessNames added in v0.50.0 

func (p *PcClient) GetLexicographicProcessNames() ([]string, error)

func (*PcClient) GetLogLength added in v0.50.0 

func (p *PcClient) GetLogLength() int

func (*PcClient) GetLogsAndSubscribe added in v0.50.0 

func (p *PcClient) GetLogsAndSubscribe(name string, observer pclog.LogObserver) error

func (*PcClient) GetNamespaces added in v1.90.0 

func (p *PcClient) GetNamespaces() ([]string, error)

func (*PcClient) GetProcessInfo added in v0.50.0 

func (p *PcClient) GetProcessInfo(name string) (*types.ProcessConfig, error)

func (*PcClient) GetProcessLog added in v0.50.0 

func (p *PcClient) GetProcessLog(name string, offsetFromEnd, limit int) ([]string, error)

func (*PcClient) GetProcessPorts added in v0.55.0 

func (p *PcClient) GetProcessPorts(name string) (*types.ProcessPorts, error)

func (*PcClient) GetProcessPty added in v1.85.0 

func (p *PcClient) GetProcessPty(name string) *os.File

func (*PcClient) GetProcessState added in v0.50.0 

func (p *PcClient) GetProcessState(name string) (*types.ProcessState, error)

func (*PcClient) GetProcessesName added in v1.2.0 

func (p *PcClient) GetProcessesName() ([]string, error)

func (*PcClient) GetProcessesState added in v0.50.0 

func (p *PcClient) GetProcessesState() (*types.ProcessesState, error)

func (*PcClient) GetProjectName added in v1.73.0 

func (p *PcClient) GetProjectName() (string, error)

func (*PcClient) GetProjectState added in v0.75.0 

func (p *PcClient) GetProjectState(withMemory bool) (*types.ProjectState, error)

func (*PcClient) GetRemoteProcessesState added in v1.5.0 

func (p *PcClient) GetRemoteProcessesState() (*types.ProcessesState, error)

func (*PcClient) IsAlive added in v0.50.0 

func (p *PcClient) IsAlive() error

func (*PcClient) IsRemote added in v0.50.0 

func (p *PcClient) IsRemote() bool

func (*PcClient) RegisterStateObserver added in v1.110.0 

func (p *PcClient) RegisterStateObserver(_ types.StateObserver)

RegisterStateObserver is a no-op for the remote client. The state-stream WebSocket endpoint can be consumed via the dedicated SubscribeProcessStates helper (see state_stream.go); the IProject hooks are reserved for in-process use.

func (*PcClient) ReloadProject added in v1.34.0 

func (p *PcClient) ReloadProject() (map[string]string, error)

func (*PcClient) RestartNamespace added in v1.90.0 

func (p *PcClient) RestartNamespace(name string) error

func (*PcClient) RestartProcess added in v0.50.0 

func (p *PcClient) RestartProcess(name string) error

func (*PcClient) ScaleProcess added in v0.55.0 

func (p *PcClient) ScaleProcess(name string, scale int) error

func (*PcClient) SendSignal added in v1.100.0 

func (p *PcClient) SendSignal(name string, sig int) error

func (*PcClient) SetProcessPassword added in v1.9.0 

func (p *PcClient) SetProcessPassword(_, _ string) error

func (*PcClient) ShutDownProject added in v0.50.0 

func (p *PcClient) ShutDownProject() error

func (*PcClient) StartNamespace added in v1.90.0 

func (p *PcClient) StartNamespace(name string) error

func (*PcClient) StartProcess added in v0.50.0 

func (p *PcClient) StartProcess(name string) error

func (*PcClient) StopNamespace added in v1.90.0 

func (p *PcClient) StopNamespace(name string) error

func (*PcClient) StopProcess added in v0.50.0 

func (p *PcClient) StopProcess(name string) error

func (*PcClient) StopProcesses added in v0.60.0 

func (p *PcClient) StopProcesses(names []string) (map[string]string, error)

func (*PcClient) SubscribeProcessStates added in v1.110.0 

func (p *PcClient) SubscribeProcessStates(ctx context.Context, names ...string) (<-chan types.ProcessStateEvent, error)

SubscribeProcessStates opens a WebSocket connection to the server's state stream and returns a channel of ProcessStateEvent values. The channel is closed when ctx is cancelled, when the server closes the connection, or on a read error.

If names is non-empty, the server filters the stream to only those processes (snapshot frames included). Unknown names are accepted silently by the server and produce no events; the server logs a warning.

The first events delivered after connect are an initial snapshot (ev.Snapshot == true) for the matching processes, followed by live transitions.

func (*PcClient) TruncateProcessLogs added in v1.63.0 

func (p *PcClient) TruncateProcessLogs(name string) error

func (*PcClient) UnSubscribeLogger added in v0.50.0 

func (p *PcClient) UnSubscribeLogger(name string, observer pclog.LogObserver) error

func (*PcClient) UnregisterStateObserver added in v1.110.0 

func (p *PcClient) UnregisterStateObserver(_ types.StateObserver)

func (*PcClient) UpdateProcess added in v1.34.0 

func (p *PcClient) UpdateProcess(updated *types.ProcessConfig) error

func (*PcClient) UpdateProject added in v1.27.0 

func (p *PcClient) UpdateProject(project *types.Project) (map[string]string, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.