protocol

package
v0.1.1 Latest Latest
Warning

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

 Go to latest Published: Jun 16, 2026 License: MIT Imports: 0 Imported by: 0

Documentation

Overview

Package protocol defines the wire types for the agentenv daemon's newline-delimited JSON API. Server (internal/api) and client (internal/cli's ctl) BOTH import this — having a single typed shape on both sides means the client can `json.NewDecoder(conn).Decode(&Response)` directly into a struct, instead of unmarshalling into map[string]any and doing fragile type assertions on every field.

Protocol shape:

  • 1 line of JSON in = 1 Request from the client.
  • For all ops except "exec": exactly 1 line of JSON out = 1 Response.
  • For "exec": multiple Response frames stream back — output frames carry Stdout/Stderr only; the terminal frame carries OK=true (and Exit/Node/ Head) or Error="...". Clients keep reading frames until OK or Error.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Change 

type Change struct {
	Kind string `json:"kind"`
	Path string `json:"path"`
}

Change is one entry in a diff/show response.

type Node 

type Node struct {
	ID      string `json:"id"`
	Parent  string `json:"parent,omitempty"`
	Message string `json:"message"`
	Head    bool   `json:"head,omitempty"`
	Leaf    bool   `json:"leaf,omitempty"`
}

Node is one DAG node summary (log/branches output).

type Proc 

type Proc struct {
	PID  int    `json:"pid"`
	Args string `json:"args"`
	Log  string `json:"log"`
}

Proc is one tracked background process (ps output).

type Request 

type Request struct {
	Op         string                `json:"op"`
	Cmd        string                `json:"cmd,omitempty"`
	Node       string                `json:"node,omitempty"`
	Message    string                `json:"message,omitempty"`
	A          string                `json:"a,omitempty"`
	B          string                `json:"b,omitempty"`
	Pid        int                   `json:"pid,omitempty"`
	Keep       int                   `json:"keep,omitempty"`
	Name       string                `json:"name,omitempty"`       // tag: name to set/get
	Ref        string                `json:"ref,omitempty"`        // tag: target ref
	Base       string                `json:"base,omitempty"`       // tournament: base ref
	Test       string                `json:"test,omitempty"`       // tournament: test command
	Candidates []TournamentCandidate `json:"candidates,omitempty"` // tournament: candidates
}

Request is one operation the client wants to perform.

type Response 

type Response struct {
	OK         bool               `json:"ok,omitempty"`
	Error      string             `json:"error,omitempty"`
	Tags       map[string]string  `json:"tags,omitempty"`
	Branches   []TournamentBranch `json:"branches,omitempty"`
	Winner     string             `json:"winner,omitempty"`
	WinnerNode string             `json:"winner_node,omitempty"`
	Exit       *int               `json:"exit,omitempty"`
	Stdout     string             `json:"stdout,omitempty"`
	Stderr     string             `json:"stderr,omitempty"`
	Node       string             `json:"node,omitempty"`
	Head       string             `json:"head,omitempty"`
	Parent     string             `json:"parent,omitempty"`
	Pid        int                `json:"pid,omitempty"`
	Log        string             `json:"log,omitempty"`
	Nodes      []Node             `json:"nodes,omitempty"`
	Changes    []Change           `json:"changes,omitempty"`
	Procs      []Proc             `json:"procs,omitempty"`
	Removed    []string           `json:"removed,omitempty"`
	Dropped    []string           `json:"dropped,omitempty"`
}

Response is one frame the server emits. For non-exec ops it's the only frame. For exec it can be either a streaming output frame (only Stdout/Stderr set) or the terminal frame (OK or Error set; for OK, Exit/Node/Head also).

func (*Response) Streaming 

func (r *Response) Streaming() bool

Streaming returns true if this exec frame is a streaming output frame (i.e. the server is still sending — the client should keep reading until Terminal).

func (*Response) Terminal 

func (r *Response) Terminal() bool

Terminal returns true if this frame ends the exec stream (OK or Error).

type TournamentBranch 

type TournamentBranch struct {
	Name     string `json:"name"`
	Cmd      string `json:"cmd"`
	Node     string `json:"node"`
	TestExit int    `json:"test_exit"`
}

TournamentBranch is one tournament result entry.

type TournamentCandidate 

type TournamentCandidate struct {
	Name string `json:"name"`
	Cmd  string `json:"cmd"`
}

TournamentCandidate is one branch to try in a tournament.

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.