agent_client

package

v0.24.1 Latest Latest Go to latest Published: May 21, 2026 License: Apache-2.0 Imports: 42 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/paularlott/knot

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func NewAgentClientLogger(client *AgentClient, service string) logger.Logger
func NewAgentServer(address, spaceId string, agentClient *AgentClient) *agentServer
func ProxyTcp(stream net.Conn, port string)
func ProxyTcpTls(stream net.Conn, port, serverName string, skipTLSVerify bool)
func ReadFrame(r io.Reader) (byte, []byte, error)
func SetAgentClient(client *AgentClient)
func WriteFrame(w io.Writer, frameType byte, payload []byte) error
type AgentClient
- func NewAgentClient(defaultServerAddress, spaceId string) *AgentClient
type AgentClientLogger

Constants ¶

View Source

const (
	FrameStdio   byte = 0x00
	FrameControl byte = 0x01
)

Variables ¶

This section is empty.

Functions ¶

func NewAgentClientLogger ¶ added in v0.23.0

func NewAgentClientLogger(client *AgentClient, service string) logger.Logger

NewAgentClientLogger creates a new logger that writes to the agent client log stream

func NewAgentServer ¶ added in v0.18.0

func NewAgentServer(address, spaceId string, agentClient *AgentClient) *agentServer

func ProxyTcp ¶ added in v0.12.2

func ProxyTcp(stream net.Conn, port string)

func ProxyTcpTls ¶ added in v0.12.2

func ProxyTcpTls(stream net.Conn, port, serverName string, skipTLSVerify bool)

func ReadFrame ¶ added in v0.23.0

func ReadFrame(r io.Reader) (byte, []byte, error)

func SetAgentClient ¶ added in v0.23.0

func SetAgentClient(client *AgentClient)

func WriteFrame ¶ added in v0.23.0

func WriteFrame(w io.Writer, frameType byte, payload []byte) error

Types ¶

type AgentClient ¶ added in v0.18.0

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

func NewAgentClient ¶ added in v0.18.0

func NewAgentClient(defaultServerAddress, spaceId string) *AgentClient

func (*AgentClient) AddPortForward ¶ added in v0.24.0

func (c *AgentClient) AddPortForward(entry model.PortForwardEntry) error

func (*AgentClient) ConnectAndServe ¶ added in v0.18.0

func (c *AgentClient) ConnectAndServe()

func (*AgentClient) GetAgentToken ¶ added in v0.23.0

func (c *AgentClient) GetAgentToken() string

func (*AgentClient) GetServerURL ¶ added in v0.23.0

func (c *AgentClient) GetServerURL() string

func (*AgentClient) GetSpaceId ¶ added in v0.22.0

func (c *AgentClient) GetSpaceId() string

func (*AgentClient) RemovePortForward ¶ added in v0.24.0

func (c *AgentClient) RemovePortForward(localPort uint16) error

func (*AgentClient) RunHealthChecks ¶ added in v0.24.0

func (c *AgentClient) RunHealthChecks()

RunHealthChecks starts the health check loop for the agent. It runs once per agent process (not per server connection).

func (*AgentClient) SendLogMessage ¶ added in v0.18.0

func (c *AgentClient) SendLogMessage(service string, level msg.LogLevel, message string) error

func (*AgentClient) SendSpaceGetVar ¶ added in v0.21.0

func (c *AgentClient) SendSpaceGetVar(name string) (string, error)

func (*AgentClient) SendSpaceNote ¶ added in v0.18.0

func (c *AgentClient) SendSpaceNote(note string) error

func (*AgentClient) SendSpaceRestart ¶ added in v0.18.0

func (c *AgentClient) SendSpaceRestart() error

func (*AgentClient) SendSpaceStop ¶ added in v0.18.0

func (c *AgentClient) SendSpaceStop() error

func (*AgentClient) SendSpaceVar ¶ added in v0.21.0

func (c *AgentClient) SendSpaceVar(name, value string) error

func (*AgentClient) Shutdown ¶ added in v0.18.0

func (c *AgentClient) Shutdown()

type AgentClientLogger ¶ added in v0.23.0

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

AgentClientLogger is a logger.Logger implementation that writes to the agent client log stream

func (*AgentClientLogger) Debug ¶ added in v0.23.0

func (l *AgentClientLogger) Debug(message string, keysAndValues ...any)

Debug logs a debug message

func (*AgentClientLogger) Error ¶ added in v0.23.0

func (l *AgentClientLogger) Error(message string, keysAndValues ...any)

Error logs an error message

func (*AgentClientLogger) Fatal ¶ added in v0.23.0

func (l *AgentClientLogger) Fatal(message string, keysAndValues ...any)

Fatal logs a fatal message and exits

func (*AgentClientLogger) Info ¶ added in v0.23.0

func (l *AgentClientLogger) Info(message string, keysAndValues ...any)

Info logs an info message

func (*AgentClientLogger) Trace ¶ added in v0.23.0

func (l *AgentClientLogger) Trace(message string, keysAndValues ...any)

Trace logs a trace message

func (*AgentClientLogger) Warn ¶ added in v0.23.0

func (l *AgentClientLogger) Warn(message string, keysAndValues ...any)

Warn logs a warning message

func (*AgentClientLogger) With ¶ added in v0.23.0

func (l *AgentClientLogger) With(key string, value any) logger.Logger

With adds a key-value pair to the logger

func (*AgentClientLogger) WithError ¶ added in v0.23.0

func (l *AgentClientLogger) WithError(err error) logger.Logger

WithError adds an error to the logger

func (*AgentClientLogger) WithGroup ¶ added in v0.23.0

func (l *AgentClientLogger) WithGroup(group string) logger.Logger

WithGroup adds a group to the logger

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL