executorprotocol

package
v0.2.0 Latest Latest
Warning

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

Go to latest
Published: Jul 14, 2026 License: MIT, MIT Imports: 10 Imported by: 0

Documentation

Overview

Package executorprotocol defines the bounded frontend-to-helper wire protocol.

Index

Constants

View Source
const (
	Version      = 1
	MaxFrameSize = 2 << 20
)
View Source
const (
	TypePing    = "ping"
	TypeExecute = "execute"
)
View Source
const (
	StatusReady     = "ready"
	StatusCompleted = "completed"
	StatusRejected  = "rejected"
	StatusAmbiguous = "ambiguous"
)

Variables

This section is empty.

Functions

func WriteRequest

func WriteRequest(writer io.Writer, request Request) error

func WriteResponse

func WriteResponse(writer io.Writer, response Response) error

Types

type Outcome

type Outcome struct {
	Started   bool          `json:"started"`
	ExitCode  int           `json:"exit_code,omitempty"`
	Signal    string        `json:"signal,omitempty"`
	TimedOut  bool          `json:"timed_out,omitempty"`
	Truncated bool          `json:"truncated,omitempty"`
	Duration  time.Duration `json:"duration_ns,omitempty"`
	Stdout    []byte        `json:"stdout,omitempty"`
	Stderr    []byte        `json:"stderr,omitempty"`
}

type Request

type Request struct {
	Version       int             `json:"version"`
	Type          string          `json:"type"`
	ExecutionID   string          `json:"execution_id,omitempty"`
	Plan          json.RawMessage `json:"plan,omitempty"`
	PlanDigest    string          `json:"plan_digest,omitempty"`
	GrantID       string          `json:"grant_id,omitempty"`
	ReservationID string          `json:"reservation_id,omitempty"`
	ExpiresAt     time.Time       `json:"expires_at,omitempty"`
}

func Ping

func Ping() Request

func ReadRequest

func ReadRequest(reader io.Reader) (Request, error)

type Response

type Response struct {
	Version     int      `json:"version"`
	Status      string   `json:"status"`
	ExecutionID string   `json:"execution_id,omitempty"`
	Outcome     *Outcome `json:"outcome,omitempty"`
	ErrorCode   string   `json:"error_code,omitempty"`
}

func NewAmbiguous

func NewAmbiguous(executionID string, code string) Response

func NewCompleted

func NewCompleted(executionID string, outcome Outcome) Response

func NewRejected

func NewRejected(code string) Response

func ReadResponse

func ReadResponse(reader io.Reader) (Response, error)

Jump to

Keyboard shortcuts

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