ICommandScheduler

public interface ICommandScheduler

com.android.tradefed.command.ICommandScheduler


TradeFederation コマンドを実行するためのスケジューラー。

まとめ

入れ子になったクラス

interface ICommandScheduler.IScheduledInvocationListener

呼び出しが完了したときの呼び出しイベントのリスナー。

パブリックメソッド

abstract boolean addCommand (String[] args)

スケジューラにコマンドを追加します。

abstract void addCommandFile (String cmdFile, extraArgs) addCommandFile (String cmdFile, extraArgs)

指定されたファイルのすべてのコマンドをスケジューラに追加します

abstract void await ()

古い TF からのハンドオーバーが完了するまで待機することも含めて、スケジューラの実行が開始されるまで待機します (該当する場合)。

abstract void completeHandover ()

開始されたハンドオーバー シーケンスが完全に完了し、デフォルト ポートでリモート マネージャーを再初期化する必要があることをコマンド スケジューラに通知します。

abstract void displayCommandQueue (PrintWriter printWriter)

コマンド実行キューの状態に関する詳細なデバッグ情報を出力します。

abstract void displayCommandsInfo (PrintWriter printWriter, String regex)

現在のコマンドのリストを出力します。

abstract void displayInvocationsInfo (PrintWriter printWriter)

現在の呼び出しのリストを表示します。

abstract void dumpCommandsXml (PrintWriter printWriter, String regex)

現在のすべてのコマンドに指定されているすべてのOption値を使用して、コマンドの展開された XML ファイルをダンプします。

abstract void execCommand (IInvocationContext context, ICommandScheduler.IScheduledInvocationListener listener, String[] args)

既存のIInvocationContextを使用して、デバイスをコマンド キューに追加せずに、デバイスを直接割り当ててコマンドを実行します。

abstract void execCommand ( ICommandScheduler.IScheduledInvocationListener listener, String[] args)

コマンドキューにデバイスを追加せずに、デバイスを直接割り当ててコマンドを実行します。

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

割り当て済みのデバイス上でコマンドを直接実行します。

abstract CommandFileWatcher getCommandFileWatcher ()

このスケジューラに適切なCommandFileWatcher取得します

abstract int getExecutingCommandCount ()

実行状態のコマンドの数を返します。

abstract String getInvocationInfo (int invocationId)

呼び出しIDを指定して呼び出しBUの情報を返します。

abstract CommandRunner.ExitCode getLastInvocationExitCode ()

最後に実行された呼び出しのエラー コードを返します。

abstract Throwable getLastInvocationThrowable ()

最後に実行された呼び出しからのThrowableを返します。

abstract int getReadyCommandCount ()

キュー内の準備完了状態のコマンドの数を返します。

abstract void handoverInitiationComplete ()

使用中のデバイスとコマンドの初期ハンドオーバー交換が完了し、スケジュール操作を開始できることをコマンド スケジューラに通知します。

abstract boolean handoverShutdown (int handoverPort)

shutdown()を開始し、同じホスト上の別の tradefed プロセスにハンドオーバーします。

abstract void join ()

スケジューラが完了するまで待機します。

abstract void join (long millis)

スケジューラが完了するまで待機するか、ミリ秒単位で指定された期間後にタイムアウトします。

abstract void removeAllCommands ()

スケジューラからすべてのコマンドを削除します

abstract void setClearcutClient (ClearcutClient client)

ハーネス データをレポートするようにクライアントを設定する

abstract boolean shouldShutdownOnCmdfileError ()

コマンドエラー時にスケジューラをシャットダウンする必要がある場合は true を返します。

abstract void shutdown ()

コマンド スケジューラを正常にシャットダウンしてみます。

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)

実行中の呼び出しを停止します。

パブリックメソッド

addコマンド

public abstract boolean addCommand (String[] args)

スケジューラにコマンドを追加します。

コマンドは基本的に、実行する構成とそれに関連する引数のインスタンスです。

「--help」引数を指定すると、設定のヘルプ テキストが標準出力に出力されます。それ以外の場合、構成は実行するキューに追加されます。

パラメーター
args String : 構成引数。

戻り値
booleanコマンドが正常に追加された場合はtrue

投げる
ConfigurationExceptionコマンドを解析できなかった場合

addコマンドファイル

public abstract void addCommandFile (String cmdFile, 
                 extraArgs)

指定されたファイルのすべてのコマンドをスケジューラに追加します

パラメーター
cmdFile String : コマンドファイルのファイルシステムパス

extraArgs : ファイルから解析された各コマンドに追加するString引数のERROR(/List) 。空にすることもできますが、null にすることはできません。

投げる
ConfigurationExceptionコマンドファイルを解析できなかった場合

以下も参照してください。

待つ

public abstract void await ()

古い TF からのハンドオーバーが完了するまで待機することも含めて、スケジューラの実行が開始されるまで待機します (該当する場合)。

完了ハンドオーバー

public abstract void completeHandover ()

開始されたハンドオーバー シーケンスが完全に完了し、デフォルト ポートでリモート マネージャーを再初期化する必要があることをコマンド スケジューラに通知します。

表示コマンドキュー

public abstract void displayCommandQueue (PrintWriter printWriter)

コマンド実行キューの状態に関する詳細なデバッグ情報を出力します。

表示コマンド情報

public abstract void displayCommandsInfo (PrintWriter printWriter, 
                String regex)

現在のコマンドのリストを出力します。

パラメーター
printWriter PrintWriter : 出力先のERROR(/PrintWriter)

regex String : 出力するためにコマンドを照合する必要がある正規表現。 null の場合、すべてのコマンドが出力されます。

表示呼び出し情報

public abstract void displayInvocationsInfo (PrintWriter printWriter)

現在の呼び出しのリストを表示します。

パラメーター
printWriter PrintWriter : 出力先のERROR(/PrintWriter)

dumpCommandXml

public abstract void dumpCommandsXml (PrintWriter printWriter, 
                String regex)

現在のすべてのコマンドに指定されているすべてのOption値を使用して、コマンドの展開された XML ファイルをダンプします。

パラメーター
printWriter PrintWriter : ステータスを出力するERROR(/PrintWriter)

regex String : XML ファイルをダンプするためにコマンドを照合する必要がある正規表現。 null の場合、すべてのコマンドがダンプされます。

execコマンド

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

既存のIInvocationContextを使用して、デバイスをコマンド キューに追加せずに、デバイスを直接割り当ててコマンドを実行します。

パラメーター
context IInvocationContext : 既存のIInvocationContext

listener ICommandScheduler.IScheduledInvocationListener : 通知されるICommandScheduler.IScheduledInvocationListener

args String : コマンド引数

投げる
ConfigurationExceptionコマンドが無効だった場合
NoDeviceException使用するデバイスがない場合

execコマンド

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

コマンドキューにデバイスを追加せずに、デバイスを直接割り当ててコマンドを実行します。

パラメーター
listener ICommandScheduler.IScheduledInvocationListener : 通知されるICommandScheduler.IScheduledInvocationListener

args String : コマンド引数

投げる
ConfigurationExceptionコマンドが無効だった場合
NoDeviceException使用するデバイスがない場合

execコマンド

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

割り当て済みのデバイス上でコマンドを直接実行します。

パラメーター
listener ICommandScheduler.IScheduledInvocationListener : 通知されるICommandScheduler.IScheduledInvocationListener

device ITestDevice : 使用するITestDevice

args String : コマンド引数

投げる
ConfigurationExceptionコマンドが無効だった場合

getCommandFileWatcher

public abstract CommandFileWatcher getCommandFileWatcher ()

このスケジューラに適切なCommandFileWatcher取得します

戻り値
CommandFileWatcher

getExecutingCommandCount

public abstract int getExecutingCommandCount ()

実行状態のコマンドの数を返します。

戻り値
int

getInvocationInfo

public abstract String getInvocationInfo (int invocationId)

呼び出しIDを指定して呼び出しBUの情報を返します。

パラメーター
invocationId int : 呼び出しのトラッキング ID。

戻り値
String呼び出しに関する情報を含むString

getLastInvocationExitCode

public abstract CommandRunner.ExitCode getLastInvocationExitCode ()

最後に実行された呼び出しのエラー コードを返します。まだ呼び出しが実行されていない場合は、0 (エラーなし) を返します。

戻り値
CommandRunner.ExitCode

getLastInvocationThrowable

public abstract Throwable getLastInvocationThrowable ()

最後に実行された呼び出しからのThrowableを返します。使用可能なスロー可能オブジェクトがない場合は、null を返します。

戻り値
Throwable

getReadyCommandCount

public abstract int getReadyCommandCount ()

キュー内の準備完了状態のコマンドの数を返します。

戻り値
int

ハンドオーバー開始完了

public abstract void handoverInitiationComplete ()

使用中のデバイスとコマンドの初期ハンドオーバー交換が完了し、スケジュール操作を開始できることをコマンド スケジューラに通知します。

ハンドオーバーシャ​​ットダウン

public abstract boolean handoverShutdown (int handoverPort)

shutdown()を開始し、同じホスト上の別の tradefed プロセスにハンドオーバーします。

スケジューラは、解放されたデバイスが使用可能になると、そのポートでリッスンしているリモート Tradefed プロセスに通知します。

パラメーター
handoverPort int

戻り値
booleanハンドオーバーの開始が成功した場合はtrue 、それ以外の場合はfalse

参加する

public abstract void join ()

スケジューラが完了するまで待機します。

以下も参照してください。

参加する

public abstract void join (long millis)

スケジューラが完了するまで待機するか、ミリ秒単位で指定された期間後にタイムアウトします。

パラメーター
millis long

以下も参照してください。

すべてのコマンドを削除

public abstract void removeAllCommands ()

スケジューラからすべてのコマンドを削除します

setClearcutClient

public abstract void setClearcutClient (ClearcutClient client)

ハーネス データをレポートするようにクライアントを設定する

パラメーター
client ClearcutClient

shouldShutdownOnCmdfileError

public abstract boolean shouldShutdownOnCmdfileError ()

コマンドエラー時にスケジューラをシャットダウンする必要がある場合は true を返します。

戻り値
boolean

シャットダウン

public abstract void shutdown ()

コマンド スケジューラを正常にシャットダウンしてみます。

テストを待機しているコマンドをクリアし、進行中のすべての呼び出しを正常にシャットダウンするように要求します。

shutdown が呼び出された後、スケジューラのメイン ループは進行中のすべての呼び出しが完了するまで待機してから、完全に終了します。

シャットダウンハード

public abstract void shutdownHard (boolean killAdb)

コマンドスケジューラを強制的にシャットダウンしてみます。

shutdown()と似ていますが、進行中の呼び出しをより速く完了させるために、オプションで adb 接続を強制終了します。

パラメーター
killAdb boolean

シャットダウンハード

public abstract void shutdownHard ()

コマンドスケジューラを強制的にシャットダウンしてみます。 shutdownHard(true) と同じです。

shutdownOnEmpty

public abstract void shutdownOnEmpty ()

shutdown()と似ていますが、すべてのコマンドが実行されるまで待機してから終了します。

コマンドがループ モードにある場合、スケジューラは決して終了しないことに注意してください。

始める

public abstract void start ()

ICommandSchedulerを起動します。

他のメソッドを呼び出す前に呼び出す必要があります。

shutdown()が呼び出されるまで実行されます。 Thread.start()を参照してください。

stop呼び出し

public abstract boolean stopInvocation (int invocationId, 
                String cause)

ID を指定して実行中の呼び出しを停止します。

パラメーター
invocationId int : 呼び出しのトラッキング ID。

cause String : 呼び出しを停止する原因。

戻り値
boolean呼び出しが停止された場合は true、それ以外の場合は false

投げる
UnsupportedOperationException実装がこれをサポートしていない場合

stop呼び出し

public boolean stopInvocation (int invocationId)

ID を指定して実行中の呼び出しを停止します。

パラメーター
invocationId int

戻り値
boolean呼び出しが停止された場合は true、それ以外の場合は false

投げる
UnsupportedOperationException実装がこれをサポートしていない場合

stop呼び出し

public abstract boolean stopInvocation (ITestInvocation invocation)

実行中の呼び出しを停止します。

パラメーター
invocation ITestInvocation

戻り値
boolean呼び出しが停止された場合は true、それ以外の場合は false

投げる
UnsupportedOperationException実装がこれをサポートしていない場合