本頁面由 Cloud Translation API 翻譯而成。

CommandScheduler

public class CommandScheduler
extends Object implements ICommandScheduler

java.lang.Object
↳	com.android.tradefed.command.CommandScheduler

已知的直接子類別

ClusterCommandScheduler

ClusterCommandScheduler 支援 TFC (Tradefed 叢集) 的 ICommandScheduler。

這個排程器可在所有可用裝置上執行 TradeFederation 指令。

會嘗試根據執行時間的總執行次數，為要執行的指令排定優先順序，例如不常執行或執行速度快的指令，會優先於執行時間較長的指令。

在背景持續執行，直到關機為止。

摘要

公用建構函式
`CommandScheduler()` 建立 `CommandScheduler`。

公用方法
`Pair<Boolean, Integer>`	`addCommand(String[] args)` 將指令新增至排程器。
`void`	`addCommandFile(String cmdFilePath, extraArgs)` 將指定檔案的所有指令新增至排程器
`void`	`await()` 等待排程器開始執行，包括等待舊 TF 轉換完成 (如適用)。
`static TradefedDelegator`	`checkDelegation(String[] args)` 根據指令列建立委派者，看看是否需要委派執行作業。
`static`	`createReleaseMap(IInvocationContext context, Throwable e)` 建立裝置狀態對應，以便適當釋放裝置。
`ISandbox`	`createSandbox()` 建立叫用作業將用於執行的 `ISandbox`。
`void`	`displayCommandQueue(PrintWriter printWriter)` 輸出指令執行佇列狀態的詳細偵錯資訊。
`void`	`displayCommandsInfo(PrintWriter printWriter, String regex)` 輸出目前指令清單。
`void`	`displayInvocationsInfo(PrintWriter printWriter)` 顯示目前叫用作業清單。
`void`	`dumpCommandsXml(PrintWriter printWriter, String regex)` 針對指令轉儲已展開的 XML 檔案，其中包含所有目前指令指定的 `Option` 值。
`long`	`execCommand(ICommandScheduler.IScheduledInvocationListener listener, ITestDevice device, String[] args)` 直接在已指派的裝置上執行指令。
`long`	`execCommand(ICommandScheduler.IScheduledInvocationListener listener, reservedDevices, String[] args)` 直接在已分配的裝置上執行指令。
`long`	`execCommand(IInvocationContext context, ICommandScheduler.IScheduledInvocationListener listener, String[] args)` 直接分配裝置並執行指令，且不會使用現有的 `IInvocationContext` 將裝置新增至指令佇列。
`long`	`execCommand(ICommandScheduler.IScheduledInvocationListener listener, String[] args)` 直接配置裝置並執行指令，但不將指令新增至指令佇列。
`CommandFileWatcher`	`getCommandFileWatcher()` 為這個排程器取得適當的 CommandFileWatcher
`int`	`getExecutingCommandCount()` 傳回執行狀態的 Command 數量。
`CommandScheduler.HostState`	`getHostState()`
`String`	`getInvocationInfo(int invocationId)` 傳回用於指定叫用 ID 的叫用緩衝區資訊。
`CommandRunner.ExitCode`	`getLastInvocationExitCode()` 傳回上次執行的呼叫的錯誤代碼。
`Throwable`	`getLastInvocationThrowable()` 從上次執行的叫用作業傳回 `Throwable`。
`int`	`getReadyCommandCount()` 傳回佇列中處於就緒狀態的指令數量。
`long`	`getShutdownTimeout()`
`boolean`	`isDeviceInInvocationThread(ITestDevice device)` 如果裝置由有效的叫用執行緒使用，就會傳回 true。
`boolean`	`isShuttingDown()`
`void`	`notifyFileChanged(File cmdFile, extraArgs)`
`void`	`removeAllCommands()` 從排程器中移除所有指令
`void`	`run()` 這個執行緒的主要執行區塊。
`void`	`setClearcutClient(ClearcutClient client)` 將用戶端設為回報束縛資料
`boolean`	`shouldShutdownOnCmdfileError()` 如果我們需要因指令錯誤而關閉排程器，則傳回 true
`void`	`shutdown(boolean notifyStop)` 嘗試安全關閉指令排程器。
`void`	`shutdownHard(boolean killAdb)` 嘗試強制關閉指令排程器。
`void`	`shutdownHard()` 嘗試強制關閉指令排程器。
`void`	`shutdownOnEmpty()` 與 `shutdown()` 類似，但會等待所有指令執行完畢，再離開。
`void`	`start()` 啟動排程器，包括設定記錄功能、啟動 `DeviceManager` 等
`boolean`	`stopInvocation(ITestInvocation invocation)` 停止執行中的叫用作業。
`boolean`	`stopInvocation(int invocationId, String cause)` 指定 ID 即可停止執行中的叫用。
`void`	`stopScheduling()` 停止安排並接受新測試，但不停止交易。

受保護的方法
`void`	`cleanUp()` 關閉記錄，並在退出前執行任何必要的清理作業。
`IConfiguration`	`createConfiguration(String[] args)`
`IInvocationContext`	`createInvocationContext()`
`void`	`dryRunCommandReporting(ICommandScheduler.IScheduledInvocationListener handler, IConfiguration config)` 判斷指定指令是否為模擬測試。
`long`	`execCommand(IInvocationContext context, ICommandScheduler.IScheduledInvocationListener listener, reservedDevices, String[] args)`
`IConfigurationFactory`	`getConfigFactory()` 工廠方法，用於取得 `IConfigurationFactory` 的參照
`DeviceManagementGrpcServer`	`getDeviceManagementServer()`
`IDeviceManager`	`getDeviceManager()` 工廠方法，用於取得 `IDeviceManager` 的參照
`TradefedFeatureServer`	`getFeatureServer()`
`IHostOptions`	`getHostOptions()`
`IKeyStoreClient`	`getKeyStoreClient()` 使用 `IGlobalConfiguration` 中宣告的 `IKeyStoreFactory` 擷取 `IKeyStoreClient`，如果未定義任何值，則為空值。
`TestInvocationManagementServer`	`getTestInvocationManagementServer()`
`void`	`initLogging()` 初始化 ddmlib 記錄。
`boolean`	`isShutdown()`
`void`	`processReadyCommands(IDeviceManager manager)`

公用建構函式

CommandScheduler

public CommandScheduler ()

建立 CommandScheduler。

注意：必須先呼叫 start 才能使用。

公用方法

addCommand

public Pair<Boolean, Integer> addCommand (String[] args)

將指令新增至排程器。

基本上，指令是執行設定的例項及其相關引數。

如果指定「--help」引數，設定的說明文字就會輸出至標準輸出。否則，設定會新增至佇列以便執行。

參數
`args`	`String`：設定引數。

傳回
`Pair<Boolean, Integer>`	一組值，如果指令已成功新增，第一個值為布林值 `true`。如果指令已成功新增，第二個值即為已知指令追蹤器 ID(非負值)；如果為所有裝置新增指令，則會傳回 0，否則為 -1。

擲回
`ConfigurationException`

addCommandFile

public void addCommandFile (String cmdFilePath, 
                 extraArgs)

將指定檔案中的所有指令新增至排程器

參數
`cmdFilePath`	`String`：指令檔案的檔案系統路徑
`extraArgs`	：`String` 引數的 `ERROR(/List)`，用於附加至從檔案解析的每個指令。可以留空，但不得為空值。

擲回
`ConfigurationException`

await

public void await ()

等待排程器開始執行，包括等待舊 TF 的移交作業完成 (如適用)。

checkDelegation

public static TradefedDelegator checkDelegation (String[] args)

根據指令列建立委派者，看看是否需要委派執行作業。

參數
`args`	`String`

傳回
`TradefedDelegator`

擲回
	com.android.tradefed.config.ConfigurationException
`ConfigurationException`

createReleaseMap

public static  createReleaseMap (IInvocationContext context, 
                Throwable e)

建立裝置狀態的地圖，以便正確釋放裝置。

參數
`context`	`IInvocationContext`
`e`	`Throwable`

傳回

建立沙箱

public ISandbox createSandbox ()

建立叫用程序用於執行的 ISandbox。

傳回
`ISandbox`

displayCommandQueue

public void displayCommandQueue (PrintWriter printWriter)

輸出指令執行佇列狀態的詳細偵錯資訊。

displayCommandsInfo

public void displayCommandsInfo (PrintWriter printWriter, 
                String regex)

輸出目前指令的清單。

參數
`printWriter`	`PrintWriter`：要輸出的 `ERROR(/PrintWriter)`。
`regex`	`String`：要比對的指令規則運算式，以便列印。如果為空值，則會列印所有指令。

displayInvocationsInfo

public void displayInvocationsInfo (PrintWriter printWriter)

顯示目前叫用作業清單。

參數
`printWriter`	`PrintWriter`：要輸出的 `ERROR(/PrintWriter)`。

dumpCommandsXml

public void dumpCommandsXml (PrintWriter printWriter, 
                String regex)

針對所有目前指令指定的所有 Option 值，將指令的擴充 XML 檔案轉儲。

參數
`printWriter`	`PrintWriter`：要輸出狀態的 `ERROR(/PrintWriter)`。
`regex`	`String`：指令應與哪個規則運算式相符，才能轉儲 XML 檔案。如果為空值，則會轉儲所有指令。

execCommand

public long execCommand (ICommandScheduler.IScheduledInvocationListener listener, 
                ITestDevice device, 
                String[] args)

直接在已指派的裝置上執行指令。

參數
`listener`	`ICommandScheduler.IScheduledInvocationListener`：要通知的 `ICommandScheduler.IScheduledInvocationListener`
`device`	`ITestDevice`：要使用的 `ITestDevice`
`args`	`String`：指令引數

傳回
`long`	排定指令的叫用 ID。

擲回
`ConfigurationException`

execCommand

public long execCommand (ICommandScheduler.IScheduledInvocationListener listener, 
                 reservedDevices, 
                String[] args)

直接在已指派的裝置上執行指令。

參數
`listener`	`ICommandScheduler.IScheduledInvocationListener`：要通知的 `ICommandScheduler.IScheduledInvocationListener`
`reservedDevices`	：要使用的 `ERROR(/List)`
`args`	`String`：指令引數

傳回
`long`	排定指令的叫用 ID。

擲回
`ConfigurationException`

execCommand

public long execCommand (IInvocationContext context, 
                ICommandScheduler.IScheduledInvocationListener listener, 
                String[] args)

直接配置裝置並執行指令，不必使用現有的 IInvocationContext 將指令新增至指令佇列。

參數
`context`	`IInvocationContext`：現有的 `IInvocationContext`。
`listener`	`ICommandScheduler.IScheduledInvocationListener`：要接收通知的 `ICommandScheduler.IScheduledInvocationListener`
`args`	`String`：指令引數

傳回
`long`

擲回
`ConfigurationException`
`NoDeviceException`

execCommand

public long execCommand (ICommandScheduler.IScheduledInvocationListener listener, 
                String[] args)

直接配置裝置並執行指令，但不將指令新增至指令佇列。

參數
`listener`	`ICommandScheduler.IScheduledInvocationListener`：要通知的 `ICommandScheduler.IScheduledInvocationListener`
`args`	`String`：指令引數

傳回
`long`	排定指令的叫用 ID。

擲回
`ConfigurationException`
`NoDeviceException`

getCommandFileWatcher

public CommandFileWatcher getCommandFileWatcher ()

取得此排程器的適當 CommandFileWatcher

傳回
`CommandFileWatcher`

getExecutingCommandCount

public int getExecutingCommandCount ()

傳回執行狀態的 Command 數量。

傳回
`int`

getHostState

public CommandScheduler.HostState getHostState ()

傳回
`CommandScheduler.HostState`

getInvocationInfo

public String getInvocationInfo (int invocationId)

傳回指定叫用 ID 的叫用耳機資訊。

參數
`invocationId`	`int`：叫用的追蹤 ID。

傳回
`String`	包含叫用作業相關資訊的 `String`。

getLastInvocationExitCode

public CommandRunner.ExitCode getLastInvocationExitCode ()

傳回上次執行的叫用作業的錯誤代碼。如果尚未執行任何叫用作業，則傳回 0 (沒有錯誤)。

傳回
`CommandRunner.ExitCode`

getLastInvocationThrowable

public Throwable getLastInvocationThrowable ()

從上次執行的叫用傳回 Throwable。如果沒有可用的 throwable，則傳回空值。

傳回
`Throwable`

getReadyCommandCount

public int getReadyCommandCount ()

傳回佇列中處於就緒狀態的指令數量。

傳回
`int`

getShutdownTimeout

public long getShutdownTimeout ()

傳回
`long`

isDeviceInInvocationThread

public boolean isDeviceInInvocationThread (ITestDevice device)

如果裝置由有效的叫用執行緒使用，則傳回 true。

參數
`device`	`ITestDevice`

傳回
`boolean`

isShuttingDown

public boolean isShuttingDown ()

傳回
`boolean`

notifyFileChanged

public void notifyFileChanged (File cmdFile, 
                 extraArgs)

參數
`cmdFile`	`File`
`extraArgs`

removeAllCommands

public void removeAllCommands ()

從排程器中移除所有指令

得分

public void run ()

這個執行緒的主要執行區塊。

setClearcutClient

public void setClearcutClient (ClearcutClient client)

設定用戶端以回報束縛資料

參數
`client`	`ClearcutClient`

shouldShutdownOnCmdfileError

public boolean shouldShutdownOnCmdfileError ()

如果我們需要因指令錯誤而關閉排程器，則傳回 true

傳回
`boolean`

關機

public void shutdown (boolean notifyStop)

嘗試安全關閉指令排程器。

參數
`notifyStop`	`boolean`：如果為 true，系統會通知 TF 關閉的叫用。

shutdownHard

public void shutdownHard (boolean killAdb)

嘗試強制關閉指令排程器。

與 shutdown() 類似，但也會選擇終止 ADB 連線，以便「啟動」進行中的叫用作業，讓作業更快完成。

參數
`killAdb`	`boolean`

shutdownHard

public void shutdownHard ()

嘗試強制關閉指令排程器。與 shutdownHard(true) 相同。

shutdownOnEmpty

public void shutdownOnEmpty ()

與 shutdown() 類似，但會等待所有指令執行完畢，再離開。

請注意，如果任何指令處於迴圈模式，排程器就不會結束。

start

public void start ()

啟動排程器，包括設定記錄、初始化 DeviceManager 等

stopInvocation

public boolean stopInvocation (ITestInvocation invocation)

停止執行中的叫用作業。

參數
`invocation`	`ITestInvocation`

傳回
`boolean`	如果叫用已停止，傳回 true，否則傳回 false

stopInvocation

public boolean stopInvocation (int invocationId, 
                String cause)

指定執行中呼叫的 ID，停止該呼叫。

參數
`invocationId`	`int`：叫用作業的追蹤 ID。
`cause`	`String`：停止叫用的原因。

傳回
`boolean`	如果已停止叫用，則傳回 true，否則傳回 false

stopScheduling

public void stopScheduling ()

停止安排並接受新測試，但不停止交易。這是為了啟用兩個步驟關閉功能，其中會先清空所有執行中的測試，然後終止交易程序。

保護方法

清理

protected void cleanUp ()

關閉記錄，並在退出前執行任何必要的清理作業。

公開，以便模擬單元測試。

createConfiguration

protected IConfiguration createConfiguration (String[] args)

參數
`args`	`String`

傳回
`IConfiguration`

擲回
`ConfigurationException`

createInvocationContext

protected IInvocationContext createInvocationContext ()

傳回
`IInvocationContext`

dryRunCommandReporting

protected void dryRunCommandReporting (ICommandScheduler.IScheduledInvocationListener handler, 
                IConfiguration config)

判斷指定指令是否為模擬測試。如果指令是模擬執行，請驗證指令。如果有任何設定問題，系統會擲回 ConfigurationException。

參數
`handler`	`ICommandScheduler.IScheduledInvocationListener`：`ERROR(/InvocationEventHandler)` 用於回報模擬執行驗證的事件。
`config`	`IConfiguration`

傳回
`void`	如果指令是模擬測試，傳回 true，否則傳回 false。

擲回
	com.android.tradefed.config.ConfigurationException
`ConfigurationException`

execCommand

protected long execCommand (IInvocationContext context, 
                ICommandScheduler.IScheduledInvocationListener listener, 
                 reservedDevices, 
                String[] args)

參數
`context`	`IInvocationContext`
`listener`	`ICommandScheduler.IScheduledInvocationListener`
`reservedDevices`
`args`	`String`

傳回
`long`

擲回
`ConfigurationException`

getConfigFactory

protected IConfigurationFactory getConfigFactory ()

工廠方法，用於取得 IConfigurationFactory 的參照

傳回
`IConfigurationFactory`	要使用的 `IConfigurationFactory`

getDeviceManagementServer

protected DeviceManagementGrpcServer getDeviceManagementServer ()

傳回
`DeviceManagementGrpcServer`

getDeviceManager

protected IDeviceManager getDeviceManager ()

取得 IDeviceManager 參照的工廠方法

傳回
`IDeviceManager`	要使用的 `IDeviceManager`

getFeatureServer

protected TradefedFeatureServer getFeatureServer ()

傳回
`TradefedFeatureServer`

getHost 選項

protected IHostOptions getHostOptions ()

傳回
`IHostOptions`

getKeyStoreClient

protected IKeyStoreClient getKeyStoreClient ()

使用 IGlobalConfiguration 中宣告的 IKeyStoreFactory 擷取 IKeyStoreClient，如果未定義，則為空值。

傳回
`IKeyStoreClient`	IKeyStoreClient

getTestInvocationManagementServer

protected TestInvocationManagementServer getTestInvocationManagementServer ()

傳回
`TestInvocationManagementServer`

initLogging

protected void initLogging ()

初始化 ddmlib 記錄。

公開，方便單元測試模擬。

isShutdown

protected boolean isShutdown ()

傳回
`boolean`

processReadyCommands

protected void processReadyCommands (IDeviceManager manager)

參數
`manager`	`IDeviceManager`

CommandScheduler

摘要

公用建構函式

公用方法

受保護的方法

公用建構函式

CommandScheduler

公用方法

addCommand

addCommandFile

await

checkDelegation

createReleaseMap

建立沙箱

displayCommandQueue

displayCommandsInfo

displayInvocationsInfo

dumpCommandsXml

execCommand

execCommand

execCommand

execCommand

getCommandFileWatcher

getExecutingCommandCount

getHostState

getInvocationInfo

getLastInvocationExitCode

getLastInvocationThrowable

getReadyCommandCount

getShutdownTimeout

isDeviceInInvocationThread

isShuttingDown

notifyFileChanged

removeAllCommands

得分

setClearcutClient

shouldShutdownOnCmdfileError

關機

shutdownHard

shutdownHard

shutdownOnEmpty

start

stopInvocation

stopInvocation

stopScheduling

保護方法

清理

createConfiguration

createInvocationContext

dryRunCommandReporting

execCommand

getConfigFactory

getDeviceManagementServer

getDeviceManager

getFeatureServer

getHost 選項

getKeyStoreClient

getTestInvocationManagementServer

initLogging

isShutdown

processReadyCommands