docs
Go API
Go API
ProtocolError
type ProtocolError struct
ProtocolError is raised when an inline control frame is malformed.
DataChunk
type DataChunk struct
DataChunk is decoded terminal data from the inline stream.
ControlChunk
type ControlChunk struct
ControlChunk is a decoded control payload from the inline stream.
DecoderOptions
type DecoderOptions struct
DecoderOptions configure a Decoder. Zero values select the defaults.
Decoder
type Decoder struct
Decoder incrementally decodes the inline DLE/STX control-frame stream.
Screen
type Screen struct
DECSCNM is active).
Go API
ProtocolError
type ProtocolError struct
ProtocolError is raised when an inline control frame is malformed.
DataChunk
type DataChunk struct
DataChunk is decoded terminal data from the inline stream.
ControlChunk
type ControlChunk struct
ControlChunk is a decoded control payload from the inline stream.
DecoderOptions
type DecoderOptions struct
DecoderOptions configure a Decoder. Zero values select the defaults.
Decoder
type Decoder struct
Decoder incrementally decodes the inline DLE/STX control-frame stream.
Screen
type Screen struct
DECSCNM is active).
BufferView
type BufferView struct
BufferView provides read access to the sparse cell matrix.
Char
type Char struct
but is never set by SGR handling because pyte has no dim attribute.
Cursor
type Cursor struct
newly drawn characters, and visibility (DECTCEM).
Margins
type Margins struct
inclusive top and bottom line indices.
Stream
type Stream struct
text-based stream).
PTYTransport
type PTYTransport struct
mechanism that makes the shell connector a real local terminal.
LineEditor
type LineEditor struct
LineEditor is a stateful line editor for terminal sessions.
AuthConfig
type AuthConfig struct
Python “str | None“ (a nil pointer is Python None; TOML absence keeps nil).
AuditConfig
type AuditConfig struct
AuditConfig ports config_schema.AuditConfig.
UiConfig
type UiConfig struct
UiConfig ports config_schema.UiConfig.
RecordingConfig
type RecordingConfig struct
(Python Path); LoadServerConfig resolves it relative to the config file.
ControlPlaneConfig
type ControlPlaneConfig struct
ControlPlaneConfig ports config_schema.ControlPlaneConfig.
SecurityConfig
type SecurityConfig struct
SecurityConfig ports config_schema.SecurityConfig.
TunnelConfig
type TunnelConfig struct
TunnelConfig ports config_schema.TunnelConfig.
WebhooksConfig
type WebhooksConfig struct
WebhooksConfig ports config_schema.WebhooksConfig.
ProfileStoreConfig
type ProfileStoreConfig struct
ProfileStoreConfig ports config_schema.ProfileStoreConfig.
ServerBindConfig
type ServerBindConfig struct
ServerBindConfig ports config_schema.ServerBindConfig.
PamConfig
type PamConfig struct
PamConfig ports config_schema.PamConfig.
GovernanceConfig
type GovernanceConfig struct
GovernanceConfig ports config_schema.GovernanceConfig.
GraphicalTargetConfig
type GraphicalTargetConfig struct
[[graphical_targets]] table). Note: min_role was intentionally dropped.
UtermServerConfig
type UtermServerConfig struct
UtermServerConfig ports config_schema.UtermServerConfig, the top-level model.
SessionDefinition
type SessionDefinition struct
config-backed definition for a named hosted terminal session.
ConnectionProfile
type ConnectionProfile struct
target owned by a principal. Times are POSIX seconds (Python time.time()).
FileProfileStore
type FileProfileStore struct
store for connection profiles, serialising concurrent access with a mutex.
InterceptResult
type InterceptResult struct
InterceptResult from an interceptor.
ClientMetadata
type ClientMetadata struct
ClientMetadata tags for selective fan-out.
ClientFilter
type ClientFilter struct
ClientFilter selects clients for SendToClients.
InterceptContext
type InterceptContext struct
InterceptContext for interceptor callbacks.
DefaultTelnetPolicy
type DefaultTelnetPolicy struct
DefaultTelnetPolicy is ANSI 80×25 with minimal option answers.
Options
type Options struct
Options for CreateSession.
Hub
type Hub struct
Hub creates and tracks sessions.
Session
type Session struct
Session is the ordered multi-client proxy session.
ClientHandle
type ClientHandle struct
ClientHandle is an in-process client attachment.
MemoryUpstream
type MemoryUpstream struct
MemoryUpstream is a deterministic test upstream.
ConnectionTransportUpstream
type ConnectionTransportUpstream struct
ConnectionTransportUpstream adapts transports.ConnectionTransport to UpstreamPipe.
ScriptedTelnetUpstream
type ScriptedTelnetUpstream struct
ScriptedTelnetUpstream feeds raw wire through IAC parse + policy (no TCP).
Principal
type Principal struct
principal.
Request
type Request struct
against: HTTP-ish headers, cookies, and the immediate TCP peer IP.
ApiKey
type ApiKey struct
stored.
ApiKeyStore
type ApiKeyStore struct
timing-safe validation. Safe for concurrent use.
WebhookIDPOptions
type WebhookIDPOptions struct
auth_webhook.WebhookIdentityProvider.init defaults.
WebhookIdentityProvider
type WebhookIdentityProvider struct
IdentityProvider that delegates resolution to an external signed webhook.
HeaderPair
type HeaderPair struct
HeaderPair is one (name, value) response-header entry.
LocalIdentityProvider
type LocalIdentityProvider struct
IdentityProvider covering the api_key, header and jwt auth modes.
AuthorizationService
type AuthorizationService struct
pluggable gateway. It delegates to a provider (default: local RBAC).
DevIDPOptions
type DevIDPOptions struct
(subject “dev-user”, roles [“admin”], ttl 24h, resolved token path).
PamEvent
type PamEvent struct
pam_listener.PamEvent.
PamNotifyListener
type PamNotifyListener struct
SO_PEERCRED (e.g. macOS) the check is skipped (warn + allow), matching Python.
PamSession
type PamSession struct
close_session. Port of pam.PamSession.
ResolvedUser
type ResolvedUser struct
uid_map.ResolvedUser.
UidMap
type UidMap struct
- os/user lookup on username — user runs as themselves
ResolveOpts
type ResolveOpts struct
*int means “not provided” (mirroring Python’s None default).
CaptureConnector
type CaptureConnector struct
CHANNEL_CONNECT frames are recorded for the analysis log.
PTYConnector
type PTYConnector struct
feeds the buffer (the push-vs-pull deviation is documented on readLoop).
CaptureFrame
type CaptureFrame struct
CaptureFrame is one decoded capture frame. Port of capture.CaptureFrame.
CaptureSocket
type CaptureSocket struct
Wire format: [1B channel][4B length big-endian][N bytes payload].
ResolvedIdentity
type ResolvedIdentity struct
SHA256 fingerprint that was resolved.
AuthorizedKeysFileResolver
type AuthorizedKeysFileResolver struct
immediately; wrap in a caching resolver for huge files.
CommandDispatcher
type CommandDispatcher struct
commands/dispatcher.py:CommandDispatcher.
LineBuffer
type LineBuffer struct
- ESC-introduced VT sequences (CSI \x1b[ …, SS3 \x1bO …) are swallowed.
AnimatedResult
type AnimatedResult struct
caller handles frame timing. Port of commands/types.py:AnimatedResult.
Result
type Result struct
while Animated is non-nil for the AnimatedResult case.
ConnectorConfig
type ConnectorConfig struct
intentionally unused (reserved), as in the reference.
UshellConnector
type UshellConnector struct
runs in a goroutine that appends frames under the same lock.
Context
type Context struct
analogue of the Python ctx dict.
HijackSession
type HijackSession struct
HijackSession is a live hijack lease. Port of the HijackSession dataclass.
AcquireResult
type AcquireResult struct
the AcquireResult dataclass.
HijackCoordinator
type HijackCoordinator struct
HijackCoordinator is single-writer hijack arbitration for one worker session.
ProtocolMismatchError
type ProtocolMismatchError struct
disconnect message.
Config
type Config struct
Config configures a TermBridge.
TermBridge
type TermBridge struct
TermBridge is the worker-side WebSocket bridge to the hub.
WatchdogOptions
type WatchdogOptions struct
defaults (StuckTimeout 120s, CheckInterval 5s, no callback).
Hijackable
type Hijackable struct
Hijackable provides pause/resume/step/watchdog primitives for a worker.
LinkPattern
type LinkPattern struct
the “g” flags default is applied.
LinkPatternRegistry
type LinkPatternRegistry struct
port guards its state with a sync.Mutex, so it is safe for concurrent use.
Meta
type Meta struct
non-empty only for stores with a local file.
Query
type Query struct
from the start. Event, when non-empty, filters by event type.
LocalFileStore
type LocalFileStore struct
opened via fileio.SecureOpenAppend (owner-only perms, no symlink follow).
InMemoryStore
type InMemoryStore struct
process exits.
WSOptions
type WSOptions struct
headers) plus the ping/size knobs.
SSHKeyAuth
type SSHKeyAuth struct
SSHKeyAuth holds a private key (PEM) and optional passphrase for key auth.
SSHOptions
type SSHOptions struct
SSHOptions carries SSH-specific connect options.
ConnectOptions
type ConnectOptions struct
values for Cols/Rows/Term/Timeout are replaced with the package defaults.
ReconnectPolicy
type ReconnectPolicy struct
It is the Go port of the Python ReconnectPolicy dataclass.
ReconnectingTransport
type ReconnectingTransport struct
itself implements ConnectionTransport so it is drop-in interchangeable.
ReconnectingOptions
type ReconnectingOptions struct
ReconnectingOptions configures a ReconnectingTransport.
TelnetTransport
type TelnetTransport struct
avoids background goroutines.
ChaosConfig
type ChaosConfig struct
ChaosConfig configures the fault injection of a ChaosTransport.
ChaosTransport
type ChaosTransport struct
It is a port of the Python ChaosTransport used for resilience testing.
WebSocketTransport
type WebSocketTransport struct
with a long-lived context; Receive selects that channel against the timeout.
TelnetEvent
type TelnetEvent struct
TelnetEvent is a public negotiation/subnegotiation event from ParseTelnetBuffer.
SSHTransport
type SSHTransport struct
client written against the same interface as the other transports.
InterceptDecision
type InterceptDecision struct
InterceptDecision is the browser’s decision for a paused request.
InterceptGate
type InterceptGate struct
not hold mu while blocking.
SpawnedPty
type SpawnedPty struct
Close is guarded for idempotency.
TtyProxy
type TtyProxy struct
stdout. Close restores the saved terminal state.
Frame
type Frame struct
Frame is a decoded tunnel frame: [channel][flags][payload…].
Client
type Client struct
writer, which this mutex discipline guarantees.
RGB
type RGB struct
RGB is a red/green/blue color triple with components in the 0-255 range.
RGB
type RGB struct
RGB is a 24-bit color triple.
ANSI16Entry
type ANSI16Entry struct
foreground and background codes.
Segment
type Segment struct
baking in RGB.
Style
type Style struct
Style is a pyte cell’s render-relevant attributes.
AnsiBuffer
type AnsiBuffer struct
render.buffer.AnsiBuffer.
RGBA8
type RGBA8 struct
RGBA8 is one 8-bit RGBA pixel.
LitevirtAIClient
type LitevirtAIClient struct
LitevirtAIClient is the Headless AI Client (Stream B) for litevirt.
FramebufferTracker
type FramebufferTracker struct
Group
type Group struct
together. Port of the Python FanOutGroup dataclass (fanout/_models.py).
SessionResult
type SessionResult struct
dataclass uses None), matching the wire shape produced by asdict().
Result
type Result struct
of FanOutResult (the fields the REST + browser-WS responses serialize).
Controller
type Controller struct
sessions. Port of FanOutController.
Config
type Config struct
Config configures a [Controller]. Zero values select production defaults.
InMemoryStore
type InMemoryStore struct
restart. Port of InMemoryFanOutStore.
SnapshotParams
type SnapshotParams struct
“now” (the Python builder’s ts=None default).
TermFrame
type TermFrame struct
TermFrame carries raw terminal output bytes from the worker to subscribers.
InputFrame
type InputFrame struct
InputFrame carries browser/operator input destined for the worker.
SnapshotReqFrame
type SnapshotReqFrame struct
SnapshotReqFrame is a browser-originated request for a fresh screen snapshot.
SnapshotFrame
type SnapshotFrame struct
SnapshotFrame is a worker-originated full-screen snapshot.
ControlFrame
type ControlFrame struct
ControlFrame is a server-originated worker-control frame (pause/resume/step).
HijackStateFrame
type HijackStateFrame struct
HijackStateFrame is a broadcast lease-state update.
HijackRequestFrame
type HijackRequestFrame struct
HijackRequestFrame is a browser-originated request to acquire the hijack lease.
HijackReleaseFrame
type HijackReleaseFrame struct
HijackReleaseFrame is a browser-originated request to release the hijack lease.
HijackStepFrame
type HijackStepFrame struct
HijackStepFrame is a browser-originated single-step request.
WorkerConnectedFrame
type WorkerConnectedFrame struct
WorkerConnectedFrame announces a worker connecting to the hub.
WorkerDisconnectedFrame
type WorkerDisconnectedFrame struct
WorkerDisconnectedFrame announces a worker disconnecting from the hub.
WorkerHelloFrame
type WorkerHelloFrame struct
capabilities.
HeartbeatFrame
type HeartbeatFrame struct
HeartbeatFrame is a browser-originated keepalive.
HeartbeatAckFrame
type HeartbeatAckFrame struct
lease.
PingFrame
type PingFrame struct
PingFrame is a liveness probe.
PongFrame
type PongFrame struct
PongFrame is the reply to a PingFrame.
HelloFrame
type HelloFrame struct
silently dropped on decode (no Extra map).
ResumeFrame
type ResumeFrame struct
ResumeFrame asks the server to resume a previous session.
IdentityFrame
type IdentityFrame struct
NewIdentityFrame applies and DecodeFrame restores when the keys are absent.
SessionTokenFrame
type SessionTokenFrame struct
SessionTokenFrame hands the browser a resumable session token.
ResumeOkFrame
type ResumeOkFrame struct
ResumeOkFrame acknowledges a successful resume.
ResumeFailedFrame
type ResumeFailedFrame struct
ResumeFailedFrame reports a failed resume attempt.
LinkPatternEntry
type LinkPatternEntry struct
“cmd”, “url”, “key” or “focus”.
LinkPatternsFrame
type LinkPatternsFrame struct
LinkPatternsFrame pushes the clickable-link pattern set to the browser.
AnalysisFrame
type AnalysisFrame struct
AnalysisFrame carries a formatted analysis blob plus its raw payload.
ErrorFrame
type ErrorFrame struct
reason/min/max extras.
StatusFrame
type StatusFrame struct
arbitrary status payloads round-trip via Extra.
InputModeChangedFrame
type InputModeChangedFrame struct
InputModeChangedFrame announces a change of the worker’s input mode.
ApprovalPendingFrame
type ApprovalPendingFrame struct
ApprovalPendingFrame announces a command awaiting operator approval.
ApprovalResolvedFrame
type ApprovalResolvedFrame struct
ApprovalResolvedFrame announces the outcome of an approval request.
PresenceUpdateFrame
type PresenceUpdateFrame struct
queued_keys) are attached only when relevant — they round-trip via Extra.
PresenceSyncFrame
type PresenceSyncFrame struct
The Python model is extra=“allow”.
PresenceLeaveFrame
type PresenceLeaveFrame struct
PresenceLeaveFrame announces a user leaving the presence roster.
ControlTransferFrame
type ControlTransferFrame struct
ControlTransferFrame is a DeckMux ownership-transfer notice.
Options
type Options struct
Options configure a SessionLogger.
SessionLogger
type SessionLogger struct
{“ts”: …, “event”: …, “data”: {…}}.
AnnotationSpan
type AnnotationSpan struct
AnnotationSpan is a contiguous range of recording event sequence numbers.
Annotation
type Annotation struct
in a session recording. A nil Span mirrors the Python default of None.
DetectionRule
type DetectionRule struct
applies to (mirroring the Python frozenset).
PatternDetector
type PatternDetector struct
match. The detector is stateless and may be shared across streams.
RE2TranslateError
type RE2TranslateError struct
custom rules supplied by callers.
StreamingDetector
type StreamingDetector struct
wrapped PatternDetector stays stateless and may be shared.
SessionStatus
type SessionStatus struct
null (matching model_dump, which always emits the key).
SessionListItem
type SessionListItem struct
list handler can both authorize (per-definition) and serialize (the status).
WatchParams
type WatchParams struct
WatchParams configures a session event long-poll (events/watch).
Annotation
type Annotation struct
Annotation is the payload of a session annotation (session.annotate).
PamIntegration
type PamIntegration struct
onClose teardown).
Deps
type Deps struct
disables the corresponding routes / uses a default).
Server
type Server struct
Server is the assembled HTTP/WebSocket server. Construct it with [New].
Metrics
type Metrics struct
/api/metrics. Safe for concurrent use.
PamTunnelBridge
type PamTunnelBridge struct
Port of PamTunnelBridge.
EgressGuard
type EgressGuard struct
never a hang or a 500).
NodeStatus
type NodeStatus struct
NodeStatus is the discovery heartbeat payload. Port of discovery.NodeStatus.
WebhookDiscoveryProvider
type WebhookDiscoveryProvider struct
try/except that swallows EgressBlockedError.
AnonConn
type AnonConn struct
a disconnected one’s presence/ownership. Safe for concurrent use.
DeckMuxPresence
type DeckMuxPresence struct
store/manager is itself concurrency-safe.
UserPresence
type UserPresence struct
mutated in place, so concurrent readers holding a prior copy never race).
PresenceStore
type PresenceStore struct
dict), which several wire payloads depend on.
TransferManager
type TransferManager struct
concurrent use.
ResolvedIdentity
type ResolvedIdentity struct
consumer-defined subject plus free-form claims and an SSH fingerprint.
IdentityPrincipal
type IdentityPrincipal struct
place of Python’s frozen dataclass.
Config
type Config struct
Config configures New. Mirrors the parameters of the Python create_mcp_app.
McpPrincipal
type McpPrincipal struct
de-duplicated set of role names.
AuthorizationContext
type AuthorizationContext struct
wrappers.
SessionRegistryImpl
type SessionRegistryImpl struct
satisfies server.SessionRegistry.
MemStore
type MemStore struct
construct it with NewMemStore.
TokenRecord
type TokenRecord struct
disclosure on the server leaks only digests.
Invite
type Invite struct
the Go analogue of the Python TunnelInvite dataclass.
AgentStatus
type AgentStatus struct
JSON round-trips faithfully.
SwarmStatus
type SwarmStatus struct
manager/models.py. Extra carries aggregate fields a plugin may inject.
SpawnBatchRequest
type SpawnBatchRequest struct
SpawnBatchRequest in manager/models.py.
ManagerConfig
type ManagerConfig struct
Pydantic ManagerConfig in manager/config.py, including its default values.
AuthMiddleware
type AuthMiddleware struct
manager/auth.py. It wraps an http.Handler.
AgentManager
type AgentManager struct
AgentManager in core.py.
AgentProcessManager
type AgentProcessManager struct
mirroring AgentProcessManager in process_impl.py + process_impl_spawn.py.
Server
type Server struct
created by create_manager_app.
AppOptions
type AppOptions struct
AppOptions configures CreateManagerApp.
TimeseriesManager
type TimeseriesManager struct
them back, mirroring manager/timeseries/manager.py TimeseriesManager.
WebhookAgentSpawnPolicyGate
type WebhookAgentSpawnPolicyGate struct
mirroring WebhookAgentSpawnPolicyGate in manager/ext.py.
ManagerTools
type ManagerTools struct
that.
EngineCapabilities
type EngineCapabilities struct
Port of control.plane.capability.EngineCapabilities.
Config
type Config struct
control.plane.types.ControlPlaneConfig.
NullString
type NullString struct
Port of the Python “str | None“ optional fields.
NullFloat
type NullFloat struct
Port of the Python “float | None“ optional fields.
SessionRecord
type SessionRecord struct
SessionRecord mirrors provide.uterm.control.plane.session.types.SessionRecord.
SessionTokenRecord
type SessionTokenRecord struct
SessionTokenRecord mirrors control.plane.token.types.SessionTokenRecord.
ResumeTokenRecord
type ResumeTokenRecord struct
ResumeTokenRecord mirrors control.plane.token.types.ResumeTokenRecord.
ApprovalRecord
type ApprovalRecord struct
ApprovalRecord mirrors control.plane.approval.types.ApprovalRecord.
LeaseRecord
type LeaseRecord struct
LeaseRecord mirrors control.plane.lease.types.LeaseRecord.
AuditHead
type AuditHead struct
AuditHead is the persisted audit-chain head “(seq, record_hash)“.
Error
type Error struct
Port of control.plane.errors.ControlPlaneError.
MenuOption
type MenuOption struct
MenuOption is a (key, description) pair extracted from a menu screen.
NumberedItem
type NumberedItem struct
NumberedItem is a (number, description) pair extracted from a numbered list.
MemoryGraphicalSession
type MemoryGraphicalSession struct
pixel white; key injection is a no-op.
ReplayOptions
type ReplayOptions struct
ReplayOptions configure ReplayLog.
TelnetOptions
type TelnetOptions struct
TelnetOptions configure ConnectTelnet.
WSOptions
type WSOptions struct
WSOptions configure ConnectWS.
TransportSession
type TransportSession struct
session.ConnectionChecker.
Options
type Options struct
Options configure a TransportSession.
Scope
type Scope struct
tenant scope or the system scope (used for seeded/system targets).
InMemoryRegistry
type InMemoryRegistry struct
registry with immutable seeded static targets + mutable runtime targets.
Error
type Error struct
Error ports GraphicalTargetException — a coded registry/validation error.
Definition
type Definition struct
their JSON is omitted when unset (System.Text.Json WhenWritingNull parity).
TerminalEmulator
type TerminalEmulator struct
must record the raw byte stream separately (see the replay package).
AcquireOptions
type AcquireOptions struct
90 when left empty/zero.
SendOptions
type SendOptions struct
2000 and 120 respectively when zero. Expect* fields are only sent when set.
EventsOptions
type EventsOptions struct
defaults to 200 when zero.
WatchOptions
type WatchOptions struct
MaxEvents to 50 when zero; EventTypes/Pattern are only sent when set.
QuickConnectOptions
type QuickConnectOptions struct
set; Config carries extra connector configuration merged into the body.
HijackClient
type HijackClient struct
multiple goroutines.
LogicalFrameDecoder
type LogicalFrameDecoder struct
terminal data). Port of LogicalFrameDecoder in control_ws.py.
ControlWSClient
type ControlWSClient struct
concurrency model — guarded by independent read/write mutexes.
DialOptions
type DialOptions struct
set; Headers are threaded into the WebSocket handshake.
APIError
type APIError struct
meaningful status codes the server emits (400/403/404/409/429).
ApprovalRequest
type ApprovalRequest struct
of the Python ApprovalRequest dataclass.
InMemoryApprovalStore
type InMemoryApprovalStore struct
lock) for every PENDING request that just timed out.
HijackSession
type HijackSession struct
provide.uterm.bridge.coordinator.HijackSession.
HijackLease
type HijackLease struct
deterministic.
WorkerTermState
type WorkerTermState struct
takes no locks.
ResumeSession
type ResumeSession struct
ownership within the TTL. Port of resume.ResumeSession.
InMemoryResumeStore
type InMemoryResumeStore struct
async control-plane token store, which is outside the wave-B perimeter).
StreamRedactor
type StreamRedactor struct
remaining rules are unaffected.
BackgroundTasks
type BackgroundTasks struct
consumed by StateStore.Shutdown. Wave B registers its loops here.
StateStoreConfig
type StateStoreConfig struct
reference.
StateStore
type StateStore struct
provide.uterm.server.bridge.hub.store.StateStore.
PresenceManager
type PresenceManager struct
semantics are preserved: it uses the hub’s shared mutex.
TokenBucket
type TokenBucket struct
mutex across every Allow call. Standalone use must serialise Allow calls.
ManualClock
type ManualClock struct
1.0), mirroring the fake clock used by the Python polling suite.
ErrWorkerNotFound
type ErrWorkerNotFound struct
“KeyError(worker_id)“); callers can read the id via [ErrWorkerNotFound.WorkerID].
WorkerRegistry
type WorkerRegistry struct
hub’s shared mutex, exactly as in Python.
TermHubConfig
type TermHubConfig struct
→ [NoOpPolicyGate], Clock nil → real clock).
TermHub
type TermHub struct
invariant.
PromptRegexError
type PromptRegexError struct
“unsafe”, “invalid”.
ConnectionManager
type ConnectionManager struct
shared mutex, preserving the Python lock semantics verbatim.
RateLimiter
type RateLimiter struct
This port guards all bucket state with a mutex so it is safe under -race.
PolicyDecision
type PolicyDecision struct
Action is one of “allow”, “deny”, “hold”.
RedactionRule
type RedactionRule struct
RedactionRule is a regex-based redaction rule. Port of ext.RedactionRule.
ConnectionHeuristics
type ConnectionHeuristics struct
ext.ConnectionHeuristics.
BehavioralThresholds
type BehavioralThresholds struct
ext.BehavioralThresholds. Nil pointers mirror the Python None (unset).
TelemetryEvent
type TelemetryEvent struct
TelemetryEvent is a lifecycle telemetry event. Port of ext.TelemetryEvent.
HijackLeaseManager
type HijackLeaseManager struct
release / heartbeat; this port omits tracing (no OTel dependency).
Subscription
type Subscription struct
worker-disconnected sentinel.
EventBus
type EventBus struct
it is safe under -race.
EventBusOptions
type EventBusOptions struct
input 8192).
MessageRouter
type MessageRouter struct
semantics verbatim.
IdleCandidate
type IdleCandidate struct
IdleCandidate is one entry returned by [MessageRouter.GetIdleCandidates].
PollingCoordinator
type PollingCoordinator struct
registry + lock are read to observe the worker’s latest snapshot.
Principal
type Principal struct
off provide.uterm.server.bridge.identity.Principal.
BrowserRoleResolutionError
type BrowserRoleResolutionError struct
the WS should be rejected. Port of core_helpers.BrowserRoleResolutionError.
WebSocketRejection
type WebSocketRejection struct
resolver returning it is re-raised as-is (not wrapped).
PolicyContext
type PolicyContext struct
PolicyContext is the context handed to a policy gate. Port of ext.PolicyContext.
InvalidInputModeError
type InvalidInputModeError struct
core_orchestration.set_worker_hello_mode.
PromptMatch
type PromptMatch struct
the Python pydantic model of the same name.
PromptDetection
type PromptDetection struct
PromptDetection is the complete prompt-detection result.
PromptDetectionDiagnostics
type PromptDetectionDiagnostics struct
diagnostics for debugging.
DetectorPatternCompileError
type DetectorPatternCompileError struct
of the same name.
PromptDetector
type PromptDetector struct
text. Faithful port of the Python class of the same name.
RegexRule
type RegexRule struct
RegexRule is a match pattern with a mode. Faithful to the Python model.
ScreenConstraint
type ScreenConstraint struct
ScreenConstraint constrains where a prompt may appear on screen.
KVExtractRule
type KVExtractRule struct
KVExtractRule describes a single key/value extraction.
PromptRule
type PromptRule struct
PromptRule is one detectable prompt.
MenuOption
type MenuOption struct
MenuOption is a single selectable option in a menu.
MenuRule
type MenuRule struct
MenuRule describes a menu prompt.
TimingRule
type TimingRule struct
TimingRule holds action timing configuration.
ActionRule
type ActionRule struct
ActionRule is one step in a flow.
FlowRule
type FlowRule struct
FlowRule is a named sequence of actions.
RuleSet
type RuleSet struct
RuleSet is the top-level rule collection loaded from rules.json.
FlowStep
type FlowStep struct
CurrentPromptID or NextAction corresponds to Python’s None.
FlowEngine
type FlowEngine struct
FlowEngine advances named flows using prompt detectors and rule metadata.
ScreenBuffer
type ScreenBuffer struct
to the Python pydantic model.
BufferManager
type BufferManager struct
BufferManager manages a screen-history buffer with timing calculation.
ScreenSaver
type ScreenSaver struct
Faithful port of the Python ScreenSaver.
DetectionEngine
type DetectionEngine struct
Faithful port of the Python DetectionEngine.
RE2TranslateError
type RE2TranslateError struct
((?=…), (?!…), (?<=…), (?<!…)) and backreferences (\1, (?P=name)).
TelnetWsGateway
type TelnetWsGateway struct
TelnetWsGateway.
IacNegotiator
type IacNegotiator struct
port of the Python IacNegotiator.
SshWsGateway
type SshWsGateway struct
WebSocket terminal server. Port of the Python SshWsGateway.
Hello
type Hello struct
Hello carries client-advertised typed-channel versions.
Negotiated
type Negotiated struct
counters.
ExpectResult
type ExpectResult struct
provide.uterm.expect.ExpectResult.
ExpectOptions
type ExpectOptions struct
ExpectOptions configure SendAndExpect.
Cursor
type Cursor struct
Cursor is a screen cursor position.
PromptDetection
type PromptDetection struct
Fields mirror the Python detection dict keys.
Snapshot
type Snapshot struct
TerminalEmulator.get_snapshot() dict.
PromptResult
type PromptResult struct
PromptResult is the accepted-prompt result of WaitForPrompt.
PromptCandidate
type PromptCandidate struct
the detection plus the screen context it was seen on.
TimeoutError
type TimeoutError struct
TimeoutError reports that no matching prompt was detected in time.
WaitOptions
type WaitOptions struct
package defaults.
PromptWaiter
type PromptWaiter struct
provide.uterm.io.PromptWaiter.
InputSender
type InputSender struct
Port of provide.uterm.io.InputSender.
Transaction
type Transaction struct
if conflict-free — merges this transaction’s key-level changes onto root.
Engine
type Engine struct
of control.plane.memory.engine.MemoryControlPlane.
SessionTokenKey
type SessionTokenKey struct
it is usable as a map key — mirrors the Python tuple key.
State
type State struct
and is not part of transaction snapshots.
Transaction
type Transaction struct
close, invoke onClose to release the engine tx-lock.
Engine
type Engine struct
control.plane.sqlite.engine.SqliteControlPlane.