ICommandScheduler
public
interface
ICommandScheduler
com.android.tradefed.command.ICommandScheduler |
TradeFederation コマンドを実行するためのスケジューラ。
概要
ネストされたクラス | |
---|---|
interface |
ICommandScheduler.IScheduledInvocationListener
呼び出し完了時の呼び出しイベントのリスナー。 |
パブリック メソッド | |
---|---|
abstract
Pair<Boolean, Integer>
|
addCommand(String[] args)
スケジューラにコマンドを追加します。 |
abstract
void
|
addCommandFile(String cmdFile,
指定されたファイルのすべてのコマンドをスケジューラに追加する |
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 ファイルをダンプする
現在のすべてのコマンドに指定された |
abstract
long
|
execCommand(IInvocationContext context, ICommandScheduler.IScheduledInvocationListener listener, String[] args)
デバイスを直接割り当て、コマンドキューに追加せずにコマンドを実行する
既存の |
abstract
long
|
execCommand(ICommandScheduler.IScheduledInvocationListener listener, String[] args)
デバイスを直接割り当てて、コマンドキューに追加せずにコマンドを実行します。 |
abstract
long
|
execCommand(ICommandScheduler.IScheduledInvocationListener listener,
すでに割り当てられているデバイスでコマンドを直接実行します。 |
abstract
CommandFileWatcher
|
getCommandFileWatcher()
このスケジューラに適した CommandFileWatcher を取得する |
abstract
int
|
getExecutingCommandCount()
実行状態のコマンドの数を返します。 |
abstract
String
|
getInvocationInfo(int invocationId)
呼び出し ID を指定して呼び出し bu の情報を返します。 |
abstract
CommandRunner.ExitCode
|
getLastInvocationExitCode()
最後に実行された呼び出しのエラーコードを返します。 |
abstract
Throwable
|
getLastInvocationThrowable()
最後に実行された呼び出しから |
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()
|
abstract
void
|
start()
|
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」の場合引数を指定すると、構成のヘルプテキストが stdout に出力されます。 それ以外の場合、構成は実行キューに追加されます。
パラメータ | |
---|---|
args |
String : 構成引数。 |
戻り値 | |
---|---|
Pair<Boolean, Integer> |
値のペア。最初の値はブール値 true (コマンドが追加された場合)です。
確認します。2 番目の値は既知のコマンド トラッカー ID(負でない値)で、
コマンドは正常に追加されました。コマンドがすべてのデバイスに追加された場合は 0 を返します。それ以外の場合は 0 を返します。
-1. |
例外 | |
---|---|
ConfigurationException |
コマンドを解析できなかった場合 |
addCommandFile
public abstract void addCommandFile (String cmdFile,extraArgs)
指定されたファイルのすべてのコマンドをスケジューラに追加する
パラメータ | |
---|---|
cmdFile |
String : コマンド ファイルのファイル システム パス |
extraArgs |
: 解析された各コマンドに追加する String 引数の ERROR(/List)
おすすめします。空にすることもできますが、null にすることはできません。 |
例外 | |
---|---|
ConfigurationException |
コマンド ファイルを解析できなかった場合 |
関連項目:
待って
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 : コマンドを照合する正規表現
表示されます。null の場合、すべてのコマンドが出力されます。 |
displayInvocationsInfo
public abstract void displayInvocationsInfo (PrintWriter printWriter)
現在の呼び出しのリストを表示します。
パラメータ | |
---|---|
printWriter |
PrintWriter : 出力先の ERROR(/PrintWriter) 。 |
dumpCommandsXml
public abstract void dumpCommandsXml (PrintWriter printWriter, String regex)
コマンドの拡張 xml ファイルをダンプする
現在のすべてのコマンドに指定された Option
値。
パラメータ | |
---|---|
printWriter |
PrintWriter : ステータスの出力先の ERROR(/PrintWriter) 。 |
regex |
String :
ダンプする xml ファイルを指定します。null の場合、すべてのコマンドがダンプされます。 |
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 |
if コマンドが無効な場合 |
NoDeviceException |
使用するデバイスがない場合に |
execCommand
public abstract long execCommand (ICommandScheduler.IScheduledInvocationListener listener, String[] args)
デバイスを直接割り当てて、コマンドキューに追加せずにコマンドを実行します。
パラメータ | |
---|---|
listener |
ICommandScheduler.IScheduledInvocationListener : 通知対象の ICommandScheduler.IScheduledInvocationListener |
args |
String : コマンド引数 |
戻り値 | |
---|---|
long |
スケジュールされたコマンドの呼び出し ID。 |
例外 | |
---|---|
ConfigurationException |
if コマンドが無効な場合 |
NoDeviceException |
使用するデバイスがない場合に |
execCommand
public abstract long execCommand (ICommandScheduler.IScheduledInvocationListener listener,devices, String[] args)
すでに割り当てられているデバイスでコマンドを直接実行します。
パラメータ | |
---|---|
listener |
ICommandScheduler.IScheduledInvocationListener : 通知対象の ICommandScheduler.IScheduledInvocationListener |
devices |
: 使用する ERROR(/List |
args |
String : コマンド引数 |
戻り値 | |
---|---|
long |
スケジュールされたコマンドの呼び出し ID。 |
例外 | |
---|---|
ConfigurationException |
if コマンドが無効な場合 |
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 |
isDeviceInvocationThread
public abstract boolean isDeviceInInvocationThread (ITestDevice device)
デバイスがアクティブな呼び出しスレッドで使用されている場合は true を返します。
パラメータ | |
---|---|
device |
ITestDevice |
戻り値 | |
---|---|
boolean |
join
public abstract void join (long millis)
ミリ秒単位で指定された期間が経過したら、スケジューラが完了するかタイムアウトするのを待ちます。
パラメータ | |
---|---|
millis |
long |
関連項目:
deleteAllCommands
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()
に似ていますが、必要に応じて
「インスピレーション」をより迅速に完了できるようになります。
パラメータ | |
---|---|
killAdb |
boolean |
shutdownHard
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 |
実装でサポートされていない場合は |
スケジュール設定を停止
public void stopScheduling ()
新しいテストのスケジューリングと受け入れを停止しますが、Tradefed は停止しません。これにより、 2 段階のシャットダウン。まず実行中のテストをすべてドレインしてから、Tradefed を終了します。 プロセスです