ipc

package

v0.2.5 Latest Latest Go to latest Published: Oct 3, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

Details

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

Repository

github.com/candacelabs/csf

Links

Open Source Insights

Documentation ¶

Overview ¶

Package ipc is the umbrella for every boundary crossing a CSF process makes. Each crossing is a capability granted through a constructor and lives in a subpackage: ipc/net for sockets, ipc/model for inference providers, and the rest as the placement rules name them. This package holds only what every subpackage shares: the Tier that classifies how far a crossing reaches.

Index ¶

Variables
type Tier
- func Widest(left Tier, right Tier) Tier
- func (tier Tier) String() string
- func (tier Tier) Valid() bool

Constants ¶

This section is empty.

Variables ¶

View Source

var Tiers = []Tier{TierInProcess, TierHost, TierNetwork}

Tiers lists every tier, narrowest first, so a caller can initialize one series per tier and a test can assert completeness.

Functions ¶

This section is empty.

Types ¶

type Tier ¶

type Tier int

Tier is how far a message or call travels from the code that sends it. Tiers are ordered: a crossing that touches two tiers reaches the wider one.

const (
	// TierInProcess stays inside one runtime: a direct call or a channel,
	// with no capability. Copilot sessions multiplexed on the bridge of a
	// Copilot service mounted in the same runtime are in this tier.
	TierInProcess Tier = iota + 1
	// TierHost reaches another process on the same machine through an ipc
	// capability: a unix socket, or loopback through ipc/net.
	TierHost
	// TierNetwork reaches another machine through ipc/net.
	TierNetwork
)

func Widest ¶

func Widest(left Tier, right Tier) Tier

Widest is the tier a crossing between two endpoints reaches: an in-process sender talking to a host-tier receiver crosses the host tier.

func (Tier) String ¶

func (tier Tier) String() string

String is the tier's ontology name.

func (Tier) Valid ¶

func (tier Tier) Valid() bool

Valid reports whether tier is one of Tiers.

Source Files ¶

View all Source files

tier.go

Directories ¶

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

Path	Synopsis
clock Package clock is the clock capability: the kernel I/O tier's time source.	Package clock is the clock capability: the kernel I/O tier's time source.
mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
db
csfpg Package csfpg is CSF's PostgreSQL backend: the one owner of database connection pools in a CSF process, CSF's schema and its migrations, and the queries sqlc generates against that schema.	Package csfpg is CSF's PostgreSQL backend: the one owner of database connection pools in a CSF process, CSF's schema and its migrations, and the queries sqlc generates against that schema.
csfpg/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
docker Package docker is the container capability: the Docker Engine reached over its API socket, granted to the code that runs containers.	Package docker is the container capability: the Docker Engine reached over its API socket, granted to the code that runs containers.
fs Package fs is the file capability: the kernel I/O tier's file boundary.	Package fs is the file capability: the kernel I/O tier's file boundary.
model Package model is CSF's contract with a brain: an agent loop over a large model behind an inference provider or API.	Package model is CSF's contract with a brain: an agent loop over a large model behind an inference provider or API.
claudecode Package claudecode is the Claude Code provider: a Claude Code session is an agent loop in its own process on the operator's machine.	Package claudecode is the Claude Code provider: a Claude Code session is an agent loop in its own process on the operator's machine.
copilot Package copilot is the first inference provider behind CSF's brain contract: the GitHub Copilot agent loop, reached through the existing Copilot adapter's generated Workbench client (services/copilot-adapter/gen/api).	Package copilot is the first inference provider behind CSF's brain contract: the GitHub Copilot agent loop, reached through the existing Copilot adapter's generated Workbench client (services/copilot-adapter/gen/api).
stub Package stub is the brain that needs no model: it answers every decision with the same canned proposal, so the harness runs and its specs pass with no inference provider, network or credential at all.	Package stub is the brain that needs no model: it answers every decision with the same canned proposal, so the harness runs and its specs pass with no inference provider, network or credential at all.
net Package net is the socket capability: the kernel I/O tier's network boundary.	Package net is the socket capability: the kernel I/O tier's network boundary.
grpc Package grpc is the gRPC client-connection capability.	Package grpc is the gRPC client-connection capability.
http Package http is the HTTP capability: one server bound to one address, mounted into the process runtime as a service, and the outbound client (NewHTTPClient) whose every connection is dialed through a granted socket capability.	Package http is the HTTP capability: one server bound to one address, mounted into the process runtime as a service, and the outbound client (NewHTTPClient) whose every connection is dialed through a granted socket capability.
proc Package proc is the process boundary: the one subprocess gateway in CSF.	Package proc is the process boundary: the one subprocess gateway in CSF.
ros Package ros is CSF's boundary to the low-level spine controller.	Package ros is CSF's boundary to the low-level spine controller.