Workspace ManagerAPI Reference

Choose documentation 3

latest

Current version

latest
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

LibTmux.Workspace.WorkspacePlan

API reference · Markdown

class LibTmux.Workspace.WorkspacePlan
class [source]

Contains the reviewed actions and observed preconditions for one workspace application.

Description#

Planning observes an interval, not a transaction. Native defaults, hooks and configuration remain tmux dependencies. Application resolves symbolic created identities and uses each action in order; enumeration performs no I/O.

Discussed in C# workspace builder API

Members

Endpoint

Endpoint : Server
property [source]

Gets the resolved endpoint selected by the caller.

SessionName

SessionName : string
property [source]

Gets the literal session name used for creation and conflict checks.

ObservedServer

ObservedServer : Server?
property [source]

Gets the identity-only observed server, or null when the endpoint was absent.

ExistingSession

ExistingSession : Session?
property [source]

Gets the exact conflicting session, or null when none was observed.

ExistingSessionPolicy

ExistingSessionPolicy : WorkspaceExistingSession
property [source]

Gets the reviewed conflict policy.

ServerStartup

ServerStartup : WorkspaceServerStartup
property [source]

Gets the reviewed startup policy for an initially absent endpoint.

Readiness

Readiness : WorkspaceReadiness
property [source]

Gets the reviewed pane startup contract.

ReadinessTimeout

ReadinessTimeout : TimeSpan
property [source]

Gets the budget for each cooperative startup signal.

CompensateOnFailure

CompensateOnFailure : bool
property [source]

Gets whether journal-owned resources are compensated after failure.

CleanupTimeout

CleanupTimeout : TimeSpan
property [source]

Gets the total budget for attempting cleanup after failure.

ObservationStartedAt

ObservationStartedAt : DateTimeOffset
property [source]

Gets the start of endpoint observation.

ObservationCompletedAt

ObservationCompletedAt : DateTimeOffset
property [source]

Gets the end of endpoint observation.

Actions

property [source]

Gets the complete ordered application operations.

Discussed in C# workspace builder behavior

CompensationActions

CompensationActions : IReadOnlyList<WorkspaceAction>
property [source]

Gets conditional cleanup operations over proven created identities, in cleanup order.

Description#

Owned readiness channels and replacement keepalives are always cleaned; workspace resources follow the selected compensation policy.

Esc

Type to search.