controlapi

package

v0.2.5 Latest Latest Go to latest Published: Nov 1, 2026 License: MIT Imports: 14 Imported by: 0

Details

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

Repository

github.com/flexdinesh/diffx

Links

Open Source Insights

Documentation ¶

Overview ¶

Package controlapi implements the private, authenticated CLI-to-local-server API.

Index ¶

Constants
func New(token string, status func() (Status, error), shutdown func()) http.Handler
type Client
- func NewClient(endpoint, token string) *Client
- func (client *Client) Shutdown(ctx context.Context) error
- func (client *Client) Status(ctx context.Context) (Status, error)
type Problem
- func (problem *Problem) Error() string
type Settings
type Status

Constants ¶

View Source

const ProtocolVersion = 5

Variables ¶

This section is empty.

Functions ¶

func New ¶

func New(token string, status func() (Status, error), shutdown func()) http.Handler

Types ¶

type Client ¶

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

func NewClient ¶

func NewClient(endpoint, token string) *Client

func (*Client) Shutdown ¶

func (client *Client) Shutdown(ctx context.Context) error

func (*Client) Status ¶

func (client *Client) Status(ctx context.Context) (Status, error)

type Problem ¶

type Problem struct {
	Type   string `json:"type"`
	Title  string `json:"title"`
	Status int    `json:"status"`
	Code   string `json:"code,omitempty"`
	Detail string `json:"detail"`
}

Problem is a local server rejection, distinct from an interrupted transport.

func (*Problem) Error ¶

func (problem *Problem) Error() string

type Settings ¶

type Settings = config.ServerSettings

type Status ¶

type Status struct {
	State           string   `json:"state"`
	InstanceID      string   `json:"instanceId"`
	StateID         string   `json:"stateId"`
	PID             int      `json:"pid"`
	Version         string   `json:"version"`
	ProtocolVersion int      `json:"protocolVersion"`
	URL             string   `json:"url"`
	BrowserURL      string   `json:"browserUrl"`
	Settings        Settings `json:"settings"`
	Observations    int      `json:"observations"`
}

Source Files ¶

View all Source files

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