ICommandScheduler

public interface ICommandScheduler

com.android.tradefed.command.ICommandScheduler

已知間接子類別 ClusterCommandScheduler、CommandScheduler ClusterCommandScheduler 用於支援 TFC (交易叢集) 的 ICommandScheduler。  CommandScheduler 這個排程器可在所有可用裝置上執行 TradeFederation 指令。

---

用於執行 TradeFederation 指令的排程器。

摘要

巢狀類別
interface	ICommandScheduler.IScheduledInvocationListener 叫用完成時的叫用事件監聽器。

公用方法
abstract Pair<Boolean, Integer>	addCommand(String[] args) 將指令新增至排程器。
abstract void	addCommandFile(String cmdFile, extraArgs) 將指定檔案中的所有指令新增至排程器
abstract void	await() 等待排程器開始執行，包括等待舊 TF 的移交作業完成 (如適用)。
abstract void	displayCommandQueue(PrintWriter printWriter) 輸出指令執行佇列狀態的詳細偵錯資訊。
abstract void	displayCommandsInfo(PrintWriter printWriter, String regex) 輸出目前指令清單。
abstract void	displayInvocationsInfo(PrintWriter printWriter) 顯示目前叫用作業清單。
abstract void	dumpCommandsXml(PrintWriter printWriter, String regex) 針對指令轉儲已展開的 XML 檔案，其中包含所有目前指令指定的 Option 值。
abstract long	execCommand(IInvocationContext context, ICommandScheduler.IScheduledInvocationListener listener, String[] args) 直接配置裝置並執行指令，不必使用現有的 IInvocationContext 將指令新增至指令佇列。
abstract long	execCommand(ICommandScheduler.IScheduledInvocationListener listener, String[] args) 直接分配裝置並執行指令，且不會將裝置新增至指令佇列。
abstract long	execCommand(ICommandScheduler.IScheduledInvocationListener listener, ITestDevice device, String[] args) 直接在已指派的裝置上執行指令。
abstract long	execCommand(ICommandScheduler.IScheduledInvocationListener listener, devices, String[] args) 直接在已分配的裝置上執行指令。
abstract CommandFileWatcher	getCommandFileWatcher() 取得這個排程器適用的 CommandFileWatcher
abstract int	getExecutingCommandCount() 傳回執行狀態的 Command 數量。
abstract String	getInvocationInfo(int invocationId) 指定叫用 ID 後，傳回叫用作業的相關資訊。
abstract CommandRunner.ExitCode	getLastInvocationExitCode() 傳回上次執行叫用的錯誤代碼。
abstract Throwable	getLastInvocationThrowable() 從上次執行的叫用作業傳回 Throwable。
abstract int	getReadyCommandCount() 傳回佇列中處於就緒狀態的指令數量。
abstract boolean	isDeviceInInvocationThread(ITestDevice device) 如果裝置由有效的叫用執行緒使用，就會傳回 true。
abstract void	join() 等待排程器完成。
abstract void	join(long millis) 等待排程器完成或在指定的時間長度 (以毫秒為單位) 後逾時。
abstract void	removeAllCommands() 從排程器中移除所有指令
abstract void	setClearcutClient(ClearcutClient client) 將用戶端設為回報束縛資料
abstract boolean	shouldShutdownOnCmdfileError() 如果我們需要因指令錯誤而關閉排程器，則傳回 true
default void	shutdown() 嘗試安全關閉指令排程器。
abstract void	shutdown(boolean notifyStop) 嘗試安全關閉指令排程器。
abstract void	shutdownHard(boolean killAdb) 嘗試強制關閉指令排程器。
abstract void	shutdownHard() 嘗試強制關閉指令排程器。
abstract void	shutdownOnEmpty() 與 shutdown() 類似，但會等待所有指令執行完畢，再離開。
abstract void	start() 啟動 ICommandScheduler。
abstract boolean	stopInvocation(int invocationId, String cause) 指定 ID 即可停止執行中的叫用作業。
default boolean	stopInvocation(int invocationId) 指定執行中呼叫的 ID，即可停止該呼叫。
abstract boolean	stopInvocation(ITestInvocation invocation) 停止執行中的叫用作業。
default void	stopScheduling() 停止安排及接受新測試，但不會停止 Tradefed。

公用方法

addCommand

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

將指令新增至排程器。

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

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

參數
args	String：設定引數。

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

擲回
ConfigurationException	如果無法剖析指令

另請參閱：

• IConfigurationFactory.createConfigurationFromArgs(String[])

addCommandFile

public abstract void addCommandFile (String cmdFile, 
                 extraArgs)

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

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

擲回
ConfigurationException	if 指令檔案無法剖析

另請參閱：

• CommandFileParser

等人

public abstract void await ()

等待排程器開始執行，包括等待舊 TF 轉換完成 (如適用)。

displayCommandQueue

public abstract void displayCommandQueue (PrintWriter printWriter)

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

displayCommandsInfo

public abstract void displayCommandsInfo (PrintWriter printWriter, 
                String regex)

輸出目前指令的清單。

參數
printWriter	PrintWriter：輸出至的 ERROR(/PrintWriter)。
regex	String：必須比對指令才能列印的規則運算式。如果為空值，則會列印所有指令。

displayInvocationsInfo

public abstract void displayInvocationsInfo (PrintWriter printWriter)

顯示目前叫用作業清單。

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

dumpCommandsXml

public abstract void dumpCommandsXml (PrintWriter printWriter, 
                String regex)

針對目前指令的所有指定 Option 值，傾印指令展開的 XML 檔案。

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

execCommand

public abstract 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 abstract long execCommand (ICommandScheduler.IScheduledInvocationListener listener, 
                String[] args)

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

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

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

擲回
ConfigurationException	如果指令無效
NoDeviceException	如果沒有裝置可以使用

execCommand

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

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

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

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

擲回
ConfigurationException	如果指令無效

execCommand

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

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

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

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

擲回
ConfigurationException	如果指令無效

getCommandFileWatcher

public abstract CommandFileWatcher getCommandFileWatcher ()

取得這個排程器適用的 CommandFileWatcher

傳回
CommandFileWatcher

getExecutingCommandCount

public abstract int getExecutingCommandCount ()

傳回執行中狀態的指令數量。

傳回
int

getInvocationInfo

public abstract String getInvocationInfo (int invocationId)

指定叫用 ID 後，傳回叫用作業的相關資訊。

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

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

getLastInvocationExitCode

public abstract CommandRunner.ExitCode getLastInvocationExitCode ()

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

傳回
CommandRunner.ExitCode

getLastInvocationThrowable

public abstract Throwable getLastInvocationThrowable ()

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

傳回
Throwable

getReadyCommandCount

public abstract int getReadyCommandCount ()

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

傳回
int

isDeviceInInvocationThread

public abstract boolean isDeviceInInvocationThread (ITestDevice device)

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

參數
device	ITestDevice

傳回
boolean

加入

public abstract void join ()

等待排程器完成。

另請參閱：

• Thread.join()

加入

public abstract void join (long millis)

等待排程器完成或在以毫秒為單位指定的時間長度後逾時。

參數
millis	long

另請參閱：

• Thread.join(long)

removeAllCommands

public abstract void removeAllCommands ()

從排程器中移除所有指令

setClearcutClient

public abstract void setClearcutClient (ClearcutClient client)

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

參數
client	ClearcutClient

shouldShutdownOnCmdfileError

public abstract boolean shouldShutdownOnCmdfileError ()

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

傳回
boolean

關機

public void shutdown ()

嘗試順利關閉指令排程器。

清除等待測試的指令，並要求所有進行中的叫用作業能順利關閉。

在呼叫關閉作業後，排程器主迴圈會等待所有進行中的叫用完成，然後才完全結束。

關機

public abstract void shutdown (boolean notifyStop)

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

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

shutdownHard

public abstract void shutdownHard (boolean killAdb)

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

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

參數
killAdb	boolean

關閉危險物品

public abstract void shutdownHard ()

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

shutdownOnEmpty

public abstract void shutdownOnEmpty ()

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

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

start

public abstract void start ()

啟動 ICommandScheduler。

必須先呼叫，才能呼叫其他方法。

將持續執行到呼叫 shutdown() 為止。請參閱 Thread.start()。

stopInvocation

public abstract boolean stopInvocation (int invocationId, 
                String cause)

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

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

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

擲回
UnsupportedOperationException	如果實作不支援這項功能

stopInvocation

public boolean stopInvocation (int invocationId)

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

參數
invocationId	int

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

擲回
UnsupportedOperationException	如果實作不支援這項功能

stopInvocation

public abstract boolean stopInvocation (ITestInvocation invocation)

停止執行中的叫用作業。

參數
invocation	ITestInvocation

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

擲回
UnsupportedOperationException	如果實作不支援這項功能

stopScheduling

public void stopScheduling ()

停止安排和接受新測試，但不會停止 Tradefed。這表示要啟用兩步驟關機程序，先排空所有執行中的測試，然後終止 Tradefed 程序。