packagebridgesdk

package

v4.0.0 Latest Latest Go to latest Published: Jul 20, 2026 License: MIT Imports: 14 Imported by: 0

Details

Package packagebridgesdk is the narrow client surface available to a package-host executable. It communicates only over its inherited bridge FD.

View Source

const BridgeFDEnvironment = "ANIX_CONTROL_PACKAGE_BRIDGE_FD"

View Source

var (
	ErrBridgeUnavailable  = errors.New("package bridge unavailable")
	ErrCapabilityRejected = errors.New("package bridge capability rejected")
)

This section is empty.

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

func DialFile(_ context.Context, file *os.File) (*Client, error)

DialFile consumes a duplicate of file and leaves no filesystem-addressable bridge endpoint for a package to discover or replace.

func DialFromEnvironment(ctx context.Context) (*Client, error)

func (c *Client) Close() error

func (c *Client) Invoke(ctx context.Context, capability []byte, operation string, payload []byte) (Response, error)

func (c *Client) OpenWebSocket(ctx context.Context, capability []byte, operation string) (WebSocketStream, error)

type Header struct {
	Name  string
	Value string
}

type Response struct {
	StatusCode uint32
	Body       []byte
	Headers    []Header
}

type WebSocketClose struct {
	Code   uint32
	Reason string
}

type WebSocketFrame struct {
	Data  []byte
	Close *WebSocketClose
}

WebSocketFrame is exchanged after the private bridge opening frame. A nil Close denotes a data frame, including an empty payload.

type WebSocketStream interface {
	Recv() (WebSocketFrame, error)
	Send(WebSocketFrame) error
	CloseSend() error
}