cockpit
library
Functions
cockpitAppTempEnvironment (String path )
→ Map <String , String >
Returns the cross-platform temporary environment for an app directory.
cockpitAtomicJsonTemporaryTargetName (String name )
→ String ?
cockpitAuthorizeTestAction ({required CockpitTestSafetyPolicy policy , required CockpitTestSafetyRequest request })
→ Future <CockpitTestError? >
cockpitBuildFlutterLaunchArguments ({required CockpitFlutterLaunchConfiguration userConfiguration , required Iterable <String > internalArguments })
→ List <String >
cockpitBuildRemoteControlDartDefineArguments ({required String host , required int port , required String flutterVersion , String ? launchId , bool disableHttpNetworkObserver = false , bool disableRuntimeObserver = false })
→ List <String >
cockpitCancelRecordingSubscription <T > (StreamSubscription <T > ? subscription )
→ Future <void >
cockpitClearActiveHostRecordingSession (String key )
→ void
cockpitClearPersistedHostRecordingSession (String key )
→ void
cockpitCommandTypeIsAiEvidenceKeyOperation (CockpitCommandType commandType )
→ bool
cockpitCommandUsesAiEvidenceDefaults (CockpitCommand command )
→ bool
cockpitCommandWithAiEvidenceDefaults (CockpitCommand command )
→ CockpitCommand
cockpitCompleteSystemControlCapabilities (List <CockpitSystemControlCapability > capabilities , {required CockpitPlaneKind plane , required CockpitSystemControlAvailability availability , required String strategy , List <String > requires = const <String>[] , List <String > limitations = const <String>[] })
→ List <CockpitSystemControlCapability >
cockpitCreateRecordingTempFile (String basename )
→ Future <File >
cockpitDartExecutable ({bool ? isWindows })
→ String
cockpitDefaultPidLivenessChecker (int pid , {CockpitRecordingTimedProcessRunner runProcess = cockpitRunRecordingProcessWithTimeout })
→ Future <bool >
cockpitDeleteAtomicJsonTemporary ({required String path , required CockpitDirectorySyncer directorySyncer })
→ Future <void >
cockpitFlutterExecutable ({bool ? isWindows })
→ String
cockpitHasActiveAdbRecordingSession (String deviceId )
→ bool
cockpitHasActiveHostRecordingSession (String key )
→ bool
cockpitHasActiveSimctlRecordingSession (String deviceId )
→ bool
cockpitHasLiveAdbRecordingSession (String deviceId , {String executable = 'adb' , CockpitRecordingProcessRunner ? processRunner , CockpitPidLivenessChecker pidLivenessChecker = cockpitDefaultPidLivenessChecker })
→ Future <bool >
cockpitHasLiveHostRecordingSession (String key , {CockpitPidLivenessChecker pidLivenessChecker = cockpitDefaultPidLivenessChecker })
→ Future <bool >
cockpitHasLiveSimctlRecordingSession (String deviceId , {CockpitPidLivenessChecker pidLivenessChecker = cockpitDefaultPidLivenessChecker })
→ Future <bool >
cockpitHostRecordingSessionPaths (String key )
→ CockpitHostRecordingSessionPaths
cockpitInteractiveArtifactsFromExecution (CockpitCommandExecution execution , CockpitInteractiveArtifactLevel artifactLevel )
→ List <CockpitInteractiveArtifactDescriptor >
cockpitInteractiveDiagnosticsFromSnapshot (CockpitSnapshot snapshot , CockpitInteractiveDiagnosticsLevel diagnosticsLevel )
→ Map <String , Object ? > ?
cockpitInteractiveDiffSnapshots (CockpitSnapshot previous , CockpitSnapshot current )
→ CockpitInteractiveSnapshotDelta
cockpitInteractiveStaticSummaryForProfile (CockpitInteractiveResultProfile profile , {String ? routeName })
→ CockpitInteractiveSnapshotSummary ?
cockpitInteractiveSummarizeSnapshot (CockpitSnapshot snapshot )
→ CockpitInteractiveSnapshotSummary
cockpitKillLocalProcessDescendants (int rootPid )
→ Future <void >
cockpitKillRecordingProcess (Process process , {ProcessSignal signal = ProcessSignal.sigkill , Duration waitTimeout = const Duration(seconds: 2) , CockpitPidLivenessChecker livenessChecker = cockpitDefaultPidLivenessChecker })
→ Future <bool >
cockpitMinimumChildEnvironment ({Map <String , String > ? environment , Map <String , String > ? parentEnvironment , bool ? windows })
→ Map <String , String >
cockpitNormalizeMcpInputSchema (Map <String , Object ? > schema )
→ Map <String , Object ? >
cockpitNormalizeProjectDir (String projectDir )
→ String
cockpitParseFlutterArgumentString (String value )
→ List <String >
cockpitPersistHostRecordingSession (String key , CockpitHostRecordingPersistedSession session )
→ Future <void >
cockpitProbeAndroidDeviceState (CockpitProcessManager processManager , String deviceId , {required Duration timeout })
→ Future <CockpitAndroidDeviceProbeResult >
cockpitProbeAppReachability (Uri baseUri )
→ Future <bool >
cockpitProcessDescendantsFromPs (String psOutput , int rootPid )
→ List <int >
cockpitReadActiveFlutterVersion ({CockpitFlutterCommandRunner processRunner = cockpitRunIsolatedProcess , bool ? isWindows })
→ Future <String >
cockpitReadActiveHostRecordingSession (String key )
→ CockpitHostRecordingRuntimeSession ?
cockpitReadFlutterVersion (String flutterExecutable , {CockpitFlutterCommandRunner ? processRunner , String ? workingDirectory })
→ Future <String >
cockpitReadLogTail (File file , {required int maximumLines })
→ Future <List <String > >
cockpitReadPersistedHostRecordingSession (String key )
→ CockpitHostRecordingPersistedSession ?
cockpitReadRemoteSessionStatus (Uri baseUri )
→ Future <CockpitRemoteSessionStatus >
cockpitReadRemoteSnapshotConsistently ({required Uri baseUri , required CockpitSnapshotOptions options , required CockpitRemoteSnapshotDetailedReader readSnapshot , CockpitRemoteSnapshotUiIdleWaiter ? waitForUiIdle , DateTime ? deadline })
→ Future <CockpitRemoteSnapshotResponse >
cockpitRecentHostRecordingStderrLines (CockpitHostRecordingPersistedSession session , {int maxLines = 8 })
→ List <String >
cockpitRecordingArtifactForName (String recordingName )
→ CockpitArtifactRef
cockpitRecordingFileName (String recordingName )
→ String
cockpitReleaseRecordingProcessStreams ({required StreamSubscription <List <int > > ? stdoutSubscription , required StreamSubscription <String > ? stderrSubscription })
→ Future <void >
cockpitRemoteAppTempKey ({required String platform , required int hostPort })
→ String
Returns the stable store key for a remote desktop app bound to hostPort.
cockpitRemoteBindHostForPlatform (String platform )
→ String
cockpitRemotePublicHostForPlatform (String platform )
→ String
cockpitResolveActiveDartExecutable ({CockpitExecutableLookupRunner processRunner = cockpitRunIsolatedProcess , bool ? isWindows , String ? currentExecutable })
→ Future <String >
cockpitResolveActiveFlutterExecutable ({CockpitFlutterCommandRunner processRunner = cockpitRunIsolatedProcess , bool ? isWindows })
→ Future <String >
cockpitResolveFlutterVersionForLaunch ({required String flutterExecutable , String ? explicitFlutterVersion , CockpitFlutterVersionReader ? legacyFlutterVersionReader , CockpitFlutterExecutableVersionReader flutterVersionForExecutableReader = cockpitReadFlutterVersion })
→ Future <String >
cockpitRunIsolatedProcess (String executable , List <String > arguments , {String ? workingDirectory , Map <String , String > ? environment , bool runInShell = false , Encoding ? stdoutEncoding = systemEncoding , Encoding ? stderrEncoding = systemEncoding })
→ Future <ProcessResult >
cockpitRunManagedProcessWithTimeout (CockpitProcessManager processManager , String executable , List <String > arguments , {String ? workingDirectory , Duration timeout = const Duration(seconds: 30) })
→ Future <ProcessResult >
cockpitRunRecordingProcessWithTimeout (String executable , List <String > arguments , {required Duration timeout })
→ Future <ProcessResult >
cockpitSignalRecordingPid (int pid , ProcessSignal signal , {required CockpitPidSignalSender signalSender , required CockpitPidLivenessChecker livenessChecker , required Duration waitTimeout , Duration pollInterval = const Duration(milliseconds: 100) })
→ Future <bool >
cockpitStartDetachedRecordingProcess (String executable , List <String > arguments )
→ Future <Process >
cockpitStartIsolatedProcess (String executable , List <String > arguments , {String ? workingDirectory , Map <String , String > ? environment , bool runInShell = false , ProcessStartMode mode = ProcessStartMode.normal })
→ Future <Process >
cockpitStoreActiveHostRecordingSession (String key , CockpitHostRecordingRuntimeSession session )
→ void
cockpitTestActionIsMutation (CockpitTestActionKind kind )
→ bool
cockpitUsesManagedAppTemp (String platform )
→ bool
Whether desktop apps on platform require host-managed temporary state.
cockpitValidateCanonicalRegularFile (String path , {required String diagnostic })
→ Future <void >
cockpitWaitForNonEmptyFile (File file , {required Duration timeout , Duration pollInterval = const Duration(milliseconds: 100) })
→ Future <bool >
cockpitWaitForPidExit (int pid , {required Duration timeout , required CockpitPidLivenessChecker livenessChecker , Duration pollInterval = const Duration(milliseconds: 100) })
→ Future <bool >
cockpitWaitForRecordingProcessExit (Process process , {required Duration timeout })
→ Future <bool >
cockpitWaitForRecordingProcessOrPidExit (Process process , {required Duration timeout , required CockpitPidLivenessChecker livenessChecker , Duration pollInterval = const Duration(milliseconds: 100) })
→ Future <bool >
cockpitWaitForRemoteSessionReady ({required Uri baseUri , required Duration timeout , required CockpitRemoteSessionStatusReader statusReader , String ? expectedSessionId , String ? expectedPlatform , Duration pollInterval = const Duration(milliseconds: 500) })
→ Future <CockpitRemoteSessionStatus >
cockpitWaitForStableFile (File file , {required Duration timeout , Duration pollInterval = const Duration(milliseconds: 100) , Duration stableWindow = const Duration(milliseconds: 400) })
→ Future <bool >
createCockpitSupervisorApiClient ({Iterable <String > requiredFeatures = const <String>[] , bool selfContained = false })
→ Future <CockpitSupervisorApiClient >
decodeCockpitStructuredInput (String source )
→ Object ?
Decodes JSON, LON, or YAML into the same JSON-compatible value model.
Typedefs
CockpitAdbCaptureAdapterFactory
= CockpitCaptureAdapter Function(String deviceId )
CockpitAdbRecordingAdapterFactory
= CockpitRecordingAdapter Function(String deviceId )
CockpitAndroidBuildArtifactResolver
= Future <CockpitAndroidBuildArtifact > Function({required String buildDirectory , String ? flavor , required String projectDir })
CockpitAndroidDeviceStateProbe
= Future <CockpitAndroidDeviceProbeResult > Function(String deviceId , {required Duration timeout })
CockpitApplyFixesRequest
= CockpitApplyWorkspaceFixesRequest
CockpitApplyFixesService
= CockpitApplyWorkspaceFixesService
CockpitAppReachabilityProbe
= Future <bool > Function(Uri baseUri )
CockpitAppStopper
= Future <void > Function(String appId )
CockpitBrowserHostAppIdResolver
= String ? Function(String deviceId )
CockpitCaptureScreenshotResult
= CockpitRunCommandResult
CockpitCaptureScreenshotRunCommand
= Future <CockpitRunCommandResult > Function(CockpitRunCommandRequest request )
CockpitCommandArtifactTempFileFactory
= Future <File > Function(String relativePath )
CockpitDesktopAppStarter
= Future <int ? > Function({List <String > arguments , Map <String , String > ? environment , required String executablePath , required Duration timeout , String ? workingDirectory })
CockpitDevelopmentProbeScreenshotCollector
= Future <CockpitDevelopmentProbeScreenshot ? > Function(CockpitDevelopmentSessionHandle sessionHandle , CockpitDevelopmentProbeProfile profile )
CockpitDevelopmentProbeSnapshotCollector
= Future <CockpitCollectRemoteSnapshotResult > Function(CockpitCollectRemoteSnapshotRequest request )
CockpitDevelopmentSessionLauncher
= Future <CockpitDevelopmentSessionBootstrap > Function(CockpitLaunchDevelopmentSessionRequest request )
CockpitDevelopmentSessionReloader
= Future <CockpitDevelopmentSessionReloadResult > Function(Uri supervisorBaseUri , CockpitDevelopmentReloadMode mode )
CockpitDevelopmentSessionStatusReader
= Future <CockpitDevelopmentSessionSupervisorResponse > Function(Uri supervisorBaseUri )
CockpitDevelopmentSessionStopper
= Future <CockpitDevelopmentSessionStopResult > Function(Uri supervisorBaseUri )
CockpitEntrypointExists
= bool Function(String absolutePath )
CockpitErrorEntry
= CockpitRuntimeErrorEntry
CockpitExecutableLookupRunner
= Future <ProcessResult > Function(String executable , List <String > arguments )
CockpitExistingDesktopAppStopper
= Future <void > Function(CockpitAppHandle app )
CockpitFlutterCommandRunner
= Future <ProcessResult > Function(String executable , List <String > arguments )
CockpitFlutterExecutableVersionReader
= Future <String > Function(String flutterExecutable )
CockpitFlutterVersionReader
= Future <String > Function()
CockpitHostPlatformResolver
= String Function()
CockpitHostPortAllocator
= Future <int > Function()
CockpitHostPortAvailabilityChecker
= Future <bool > Function(int port )
CockpitHttpClientFactory
= HttpClient Function()
CockpitInspectFlutterSurfaceFunction
= Future <CockpitInspectUiResult > Function(CockpitInspectUiRequest request )
CockpitInspectSurfaceFunction
= Future <CockpitInspectSurfaceResult > Function(CockpitInspectSurfaceRequest request )
CockpitInteractiveNow
= DateTime Function()
CockpitIosBundleIdResolver
= Future <String > Function({required String appBundlePath })
CockpitIosDeviceConnectionReader
= Future <CockpitIosDeviceConnection? > Function(String deviceId )
CockpitIosPhysicalAppBundlePathResolver
= Future <String > Function({String ? flavor , required String projectDir })
CockpitIosPhysicalBundleIdResolver
= Future <String > Function({required String appBundlePath })
CockpitIosPhysicalProcessRunner
= Future <ProcessResult > Function(String executable , List <String > arguments , {Map <String , String > ? environment , String ? workingDirectory })
CockpitIosSimulatorAppBundlePathResolver
= Future <String > Function({String ? flavor , required String projectDir })
CockpitIosWdaRunner
= Future <String > Function(CockpitIosWdaCommand command , {required Duration timeout })
CockpitLaunchFlutterAppTargetFunction
= Future <CockpitLaunchAppResult > Function(CockpitLaunchAppRequest request )
CockpitLaunchTargetFunction
= Future <CockpitLaunchTargetResult > Function(CockpitLaunchTargetRequest request )
CockpitLinuxAppExecutablePathResolver
= Future <String > Function({required String projectDir })
CockpitLinuxCaptureAdapterFactory
= CockpitCaptureAdapter Function(String appId , {int ? processId })
CockpitLinuxDisplayConfigResolver
= Future <CockpitLinuxDisplayConfig > Function()
CockpitLinuxRecordingAdapterFactory
= CockpitRecordingAdapter Function(String appId , {int ? processId })
CockpitListTargetsResult
= CockpitListLaunchTargetsResult
CockpitListTargetsService
= CockpitListLaunchTargetsService
CockpitLockedJsonTransaction <T , R >
= FutureOr <CockpitLockedJsonUpdate <T , R > > Function(T current )
CockpitLogsSnapshotReader
= Future <CockpitRemoteSnapshotResponse > Function(Uri baseUri , CockpitSnapshotOptions options )
CockpitMachineClientConnector
= Future <CockpitFlutterRunMachineClient > Function()
CockpitMacosAppBundlePathResolver
= Future <String > Function({String ? flavor , required String projectDir })
CockpitMacosAppStarter
= Future <int ? > Function({required String appBundlePath , required Map <String , String > ? environment , required String ? executablePath , required Duration timeout })
CockpitMacosBundleExecutablePathResolver
= Future <String > Function({required String appBundlePath })
CockpitMacosBundleIdResolver
= Future <String > Function({required String appBundlePath })
CockpitMacosCaptureAdapterFactory
= CockpitCaptureAdapter Function(String appId , {int ? processId })
CockpitMacosRecordingAdapterFactory
= CockpitRecordingAdapter Function(String appId , {int ? processId })
CockpitPidLivenessChecker
= Future <bool > Function(int pid )
CockpitPidSignalSender
= bool Function(int pid , ProcessSignal signal )
CockpitPlatformStopProcessRunner
= Future <ProcessResult > Function(String executable , List <String > arguments )
CockpitProcessRunner
= Future <ProcessResult > Function(String executable , List <String > arguments )
CockpitReadErrorsRequest
= CockpitReadRuntimeErrorsRequest
CockpitReadErrorsResult
= CockpitReadRuntimeErrorsResult
CockpitReadFlutterTargetFunction
= Future <CockpitReadAppResult > Function(CockpitReadAppRequest request )
CockpitReadLaunchedAppFunction
= Future <CockpitReadAppResult > Function(CockpitReadAppRequest request )
CockpitReadNetworkSnapshotReader
= Future <CockpitRemoteSnapshotResponse > Function(Uri baseUri , CockpitSnapshotOptions options )
CockpitReadTargetFunction
= Future <CockpitReadTargetResult > Function(CockpitReadTargetRequest request )
CockpitRecordingProcessRunner
= Future <ProcessResult > Function(String executable , List <String > arguments )
CockpitRecordingProcessStarter
= Future <Process > Function(String executable , List <String > arguments )
CockpitRecordingTempFileFactory
= Future <File > Function(String basename )
CockpitRecordingTimedProcessRunner
= Future <ProcessResult > Function(String executable , List <String > arguments , {required Duration timeout })
CockpitRemoteArtifactTempFileFactory
= Future <File > Function(String basename )
CockpitRemoteCaptureAdapterFactory
= CockpitCaptureAdapter Function(CockpitRemoteSessionClient client )
CockpitRemoteCommandExecutor
= Future <CockpitCommandExecution > Function(Uri baseUri , CockpitCommand command )
CockpitRemoteControlReadinessProbe
= Future <bool > Function(Uri baseUri )
CockpitRemoteReachabilityProbe
= Future <bool > Function(Uri baseUri )
CockpitRemoteRecordingAdapterFactory
= CockpitRecordingAdapter Function(CockpitRemoteSessionClient client )
CockpitRemoteRecordingStarter
= Future <CockpitRecordingSession > Function(Uri baseUri , CockpitRecordingRequest request )
CockpitRemoteRecordingStopper
= Future <CockpitRecordingResult > Function(Uri baseUri )
CockpitRemoteSessionStatusReader
= Future <CockpitRemoteSessionStatus > Function(Uri baseUri )
CockpitRemoteSnapshotArtifactDownloader
= Future <Map <String , String > > Function(Uri baseUri , Iterable <CockpitRemoteArtifactDownload > downloads )
CockpitRemoteSnapshotDetailedReader
= Future <CockpitRemoteSnapshotResponse > Function(Uri baseUri , CockpitSnapshotOptions options )
CockpitRemoteSnapshotReader
= Future <CockpitRemoteSnapshotResponse > Function(Uri baseUri , CockpitSnapshotOptions options )
CockpitRemoteSnapshotUiIdleWaiter
= Future <bool > Function(Uri baseUri , {required bool includeNetworkIdle , required Duration quietWindow , required Duration timeout })
CockpitRemoteStatusReader
= Future <CockpitRemoteSessionStatus > Function(Uri baseUri )
CockpitRemoteUiIdleWaiter
= Future <bool > Function(Uri baseUri , {required bool includeNetworkIdle , required Duration quietWindow , required Duration timeout })
CockpitRemoteViewportResize
= Future <CockpitViewportResizeResult > Function(Uri baseUri , CockpitViewportResizeRequest request , Duration requestTimeout )
CockpitRunBatchCommand
= CockpitInteractiveBatchCommand
CockpitRunBatchResult
= CockpitExecuteRemoteCommandBatchResult
CockpitRunBatchStartRecordingFunction
= Future <CockpitStartRecordingResult > Function(CockpitStartRecordingRequest request )
CockpitRunBatchStopRecordingFunction
= Future <CockpitStopRecordingResult > Function(CockpitStopRecordingRequest request )
CockpitRunCommandResult
= CockpitExecuteRemoteCommandResult
CockpitRunShellFunction
= Future <CockpitRunShellResult > Function(CockpitRunShellRequest request )
CockpitRunTestsRequest
= CockpitRunWorkspaceTestsRequest
CockpitRunTestsService
= CockpitRunWorkspaceTestsService
CockpitSimctlCaptureAdapterFactory
= CockpitCaptureAdapter Function(String deviceId )
CockpitSimctlRecordingAdapterFactory
= CockpitRecordingAdapter Function(String deviceId )
CockpitStartRecordingResult
= CockpitStartRemoteRecordingResult
CockpitStopAutomationAppFunction
= Future <void > Function(CockpitAppHandle app )
CockpitStopDevelopmentAppFunction
= Future <CockpitStopDevelopmentSessionResult > Function(CockpitStopDevelopmentSessionRequest request )
CockpitStopRecordingResult
= CockpitStopRemoteRecordingResult
CockpitSupervisorLogger
= Future <void > Function(String appId )
CockpitSystemControlAdapterFactory
= CockpitSystemControlAdapter Function(String platform )
CockpitSystemControlCaptureAdapterFactory
= CockpitCaptureAdapter ? Function(CockpitSystemControlActionRequest request )
CockpitSystemControlDescribeFunction
= Future <CockpitSystemControlDescribeResult > Function(CockpitSystemControlDescribeRequest request )
CockpitSystemControlRecordingAdapterFactory
= CockpitRecordingAdapter ? Function(CockpitSystemControlActionRequest request )
CockpitSystemControlRunActionFunction
= Future <CockpitSystemControlActionResult > Function(CockpitSystemControlActionRequest request )
CockpitTestBundlePrePublicationValidator
= Future <CockpitTestError? > Function(String stagingPath )
CockpitUiIdleBackoffWait
= Future <void > Function(Duration duration )
CockpitVideoArtifactProcessRunner
= Future <ProcessResult > Function(String executable , List <String > arguments , {required Duration timeout })
CockpitVmServiceObserver
= void Function(Uri uri )
CockpitWaitIdleResult
= CockpitWaitRemoteUiIdleResult
CockpitWdaCaptureAdapterFactory
= CockpitCaptureAdapter Function(Uri baseUri )
CockpitWebRemoteSessionBridgeServerFactory
= CockpitWebRemoteSessionBridgeServer? Function({required CockpitDevelopmentSessionHandle handle })
CockpitWindowsAppExecutablePathResolver
= Future <String > Function({required String projectDir })
CockpitWindowsCaptureAdapterFactory
= CockpitCaptureAdapter Function(String appId , {int ? processId })
CockpitWindowsRecordingAdapterFactory
= CockpitRecordingAdapter Function(String appId , {int ? processId })
CockpitWorkingDirectoryProcessRunner
= Future <ProcessResult > Function(String executable , List <String > arguments , {Map <String , String > ? environment , String ? workingDirectory })