運行工具

public interface IRunUtil

com.android.tradefed.util.IRunUtil


用於運行定時操作和系統命令的介面。

概括

嵌套類

interface IRunUtil.IRunnableResult

用於非同步執行返回布林狀態的操作的介面。

公共方法

abstract void allowInterrupt (boolean allow)

允許/禁止當前執行緒上的運行中斷。

abstract void interrupt (Thread thread, String message, ErrorIdentifier errorId)

中斷給定線程上正在進行/即將進行的運行操作。

abstract void interrupt (Thread thread, String message)

中斷給定線程上正在進行/即將進行的運行操作。

abstract boolean isInterruptAllowed ()

給予 RunUtil 的中斷狀態。

abstract Process runCmdInBackground (Redirect redirect, command) runCmdInBackground (Redirect redirect, command)

另一個runCmdInBackground(String)方法,它接受ERROR(/List)形式的指令參數。

abstract Process runCmdInBackground ( command) runCmdInBackground ( command)

另一個runCmdInBackground(String)方法,它接受ERROR(/List)形式的指令參數。

abstract Process runCmdInBackground ( command, OutputStream output) runCmdInBackground ( command, OutputStream output)

執行帶有ERROR(/OutputStream)的命令會記錄命令的輸出。

abstract Process runCmdInBackground (String... command)

異步執行系統指令的輔助方法。

abstract Process runCmdInBackground (Redirect redirect, String... command)

異步執行系統指令的輔助方法。

abstract boolean runEscalatingTimedRetry (long opTimeout, long initialPollInterval, long maxPollInterval, long maxTime, IRunUtil.IRunnableResult runnable)

多次阻塞並執行一個操作,直到成功。

abstract boolean runFixedTimedRetry (long opTimeout, long pollInterval, long maxTime, IRunUtil.IRunnableResult runnable)

多次阻塞並執行一個操作,直到成功。

abstract boolean runFixedTimedRetryWithOutputMonitor (long opTimeout, long idleOutputTimeout, long pollInterval, long maxTime, IRunUtil.IRunnableResult runnable)

多次阻塞並執行一個操作,直到成功。

abstract CommandStatus runTimed (long timeout, IRunUtil.IRunnableResult runnable, boolean logErrors)

阻止並執行操作,如果花費的時間超過指定時間則中止。

abstract CommandResult runTimedCmd (long timeout, OutputStream stdout, OutputStream stderr, String... command)

用於執行系統命令的幫助程序方法,如果花費的時間超過指定時間則中止,並將輸出重定向到檔案(如果指定)。

abstract CommandResult runTimedCmd (long timeout, String... command)

執行系統指令的幫助程序方法,如果花費的時間超過指定時間,則中止。

abstract CommandResult runTimedCmdRetry (long timeout, long retryInterval, int attempts, String... command)

執行系統指令的幫助程序方法,如果花費的時間超過指定時間,則中止。

abstract CommandResult runTimedCmdRetryWithOutputMonitor (long timeout, long idleOutputTimeout, long retryInterval, int attempts, String... command)

執行系統指令的幫助程序方法,如果花費的時間超過指定時間,則中止。

abstract CommandResult runTimedCmdSilently (long timeout, String... command)

執行系統指令的幫助程序方法,如果花費的時間超過指定時間,則中止。

abstract CommandResult runTimedCmdSilentlyRetry (long timeout, long retryInterval, int attempts, String... command)

執行系統指令的幫助程序方法,如果花費的時間超過指定時間,則中止。

abstract CommandResult runTimedCmdWithInput (long timeout, String input, File stdoutFile, File stderrFile, String... command)

用於執行系統命令的幫助程序方法,如果花費的時間超過指定時間則中止,並將輸出重定向到檔案(如果指定)。

abstract CommandResult runTimedCmdWithInput (long timeout, String input, String... command)

用於執行需要 stdin 輸入的系統命令的幫助程序方法,如果花費的時間超過指定時間,則中止。

abstract CommandResult runTimedCmdWithInput (long timeout, String input, command) runTimedCmdWithInput (long timeout, String input, command)

用於執行需要 stdin 輸入的系統命令的幫助程序方法,如果花費的時間超過指定時間,則中止。

abstract CommandResult runTimedCmdWithInputRedirect (long timeout, File inputRedirect, String... command)

用於執行需要從檔案重新導向 Stdin 的系統指令的幫助程式方法,如果花費的時間超過指定時間,則中止。

abstract CommandResult runTimedCmdWithOutputMonitor (long timeout, long idleOutputTimeout, OutputStream stdout, OutputStream stderr, String... command)

用於執行系統命令的幫助程序方法,如果花費的時間超過指定時間則中止,並將輸出重定向到檔案(如果指定)。

abstract CommandResult runTimedCmdWithOutputMonitor (long timeout, long idleOutputTimeout, String... command)

執行系統指令的幫助程序方法,如果花費的時間超過指定時間,則中止。

abstract boolean runTimedRetry (long opTimeout, long pollInterval, int attempts, IRunUtil.IRunnableResult runnable)

多次阻塞並執行一個操作,直到成功。

abstract boolean runTimedRetryWithOutputMonitor (long opTimeout, long idleOutputTimeout, long pollInterval, int attempts, IRunUtil.IRunnableResult runnable)

多次阻塞並執行一個操作,直到成功。

abstract CommandStatus runTimedWithOutputMonitor (long timeout, long idleOutputTimeout, IRunUtil.IRunnableResult runnable, boolean logErrors)

阻止並執行操作,如果花費的時間超過指定時間則中止。

abstract void setEnvVariable (String key, String value)

設定運行系統指令時要使用的環境變數。

abstract void setEnvVariablePriority ( IRunUtil.EnvPriority priority)

決定在建立進程時是否取消設定環境變數的優先權高於設定它們。

abstract void setInterruptibleInFuture (Thread thread, long timeMs)

等待一段時間後設定為可中斷。

abstract void setLinuxInterruptProcess (boolean interrupt)

允許在逾時時對透過 #runTimed 方法執行的程序使用 linux「kill」中斷。

abstract void setRedirectStderrToStdout (boolean redirect)

設定標準錯誤流以在執行系統命令時重定向到標準輸出流。

abstract void setWorkingDir (File dir)

設定係統指令的工作目錄。

abstract void sleep (long time)

幫助程序方法在給定時間內休眠,忽略任何異常。

abstract void unsetEnvVariable (String key)

取消設定環境變量,因此系統命令在沒有此環境變量的情況下運行。

公共方法

允許中斷

public abstract void allowInterrupt (boolean allow)

允許/禁止當前執行緒上的運行中斷。如果允許,可以透過interrupt(Thread, String)方法從其他執行緒中斷目前執行緒的運行操作。

參數
allow boolean : 是否允許目前執行緒運行中斷。

打斷

public abstract void interrupt (Thread thread, 
                String message, 
                ErrorIdentifier errorId)

中斷給定線程上正在進行/即將進行的運行操作。給定執行緒上的運行操作將會拋出RunInterruptedException

參數
message StringRunInterruptedException的訊息。

errorId ErrorIdentifier :表示已知的中斷原因。

打斷

public abstract void interrupt (Thread thread, 
                String message)

中斷給定線程上正在進行/即將進行的運行操作。給定執行緒上的運行操作將會拋出RunInterruptedException

參數
message StringRunInterruptedException的訊息。

允許中斷

public abstract boolean isInterruptAllowed ()

給予 RunUtil 的中斷狀態。

退貨
boolean如果運行可以中斷,則為 true,否則為 false。

運行CmdInBackground

public abstract Process runCmdInBackground (Redirect redirect, 
                 command)

另一個runCmdInBackground(String)方法,它接受ERROR(/List)形式的指令參數。

參數
redirect Redirect :應用於ProcessBuilder ERROR(/Redirect)

command : ERROR(/List)包含指定的系統指令和可選的 exec 參數

退貨
Process執行命令的Process

投擲
如果命令運行失敗

運行CmdInBackground

public abstract Process runCmdInBackground ( command)

另一個runCmdInBackground(String)方法,它接受ERROR(/List)形式的指令參數。

參數
command : ERROR(/List)包含指定的系統指令和可選的 exec 參數

退貨
Process執行命令的Process

投擲
如果命令運行失敗

運行CmdInBackground

public abstract Process runCmdInBackground ( command, 
                OutputStream output)

執行帶有ERROR(/OutputStream)的命令會記錄命令的輸出。 Stdout 和 stderr 合併在一起。

參數
command :要運行的命令

output OutputStream :保存輸出的OutputStream

退貨
Process運行命令的Process

投擲
IO異常

運行CmdInBackground

public abstract Process runCmdInBackground (String... command)

異步執行系統指令的輔助方法。

啟動命令後立即返回。

參數
command String : 指定的系統指令和 exec 的可選參數

退貨
Process執行命令的Process

投擲
如果命令運行失敗

運行CmdInBackground

public abstract Process runCmdInBackground (Redirect redirect, 
                String... command)

異步執行系統指令的輔助方法。

啟動命令後立即返回。

參數
redirect Redirect :應用於ProcessBuilder ERROR(/Redirect)

command String : 指定的系統指令和 exec 的可選參數

退貨
Process執行命令的Process

投擲
如果命令運行失敗

運行升級定時重試

public abstract boolean runEscalatingTimedRetry (long opTimeout, 
                long initialPollInterval, 
                long maxPollInterval, 
                long maxTime, 
                IRunUtil.IRunnableResult runnable)

多次阻塞並執行一個操作,直到成功。

操作嘗試之間的等待時間呈指數增加。這是為了在執行輪詢伺服器等操作時使用,以便在伺服器暫時關閉時為其提供恢復時間。

參數
opTimeout long :單次操作嘗試等待的最長時間(以毫秒為單位)

initialPollInterval long :操作嘗試之間等待的初始時間

maxPollInterval long :操作嘗試之間等待的最長時間

maxTime long :繼續嘗試操作的總的近似最大時間

runnable IRunUtil.IRunnableResult :要執行的IRunUtil.IRunnableResult

退貨
boolean true如果操作在 maxTime 過期之前成功完成

運行固定定時重試

public abstract boolean runFixedTimedRetry (long opTimeout, 
                long pollInterval, 
                long maxTime, 
                IRunUtil.IRunnableResult runnable)

多次阻塞並執行一個操作,直到成功。

參數
opTimeout long :單次操作嘗試等待的最長時間(以毫秒為單位)

pollInterval long :操作嘗試之間等待的初始時間

maxTime long :繼續嘗試操作的總的近似最大時間

runnable IRunUtil.IRunnableResult :要執行的IRunUtil.IRunnableResult

退貨
boolean true如果操作在 maxTime 過期之前成功完成

runFixedTimedRetryWithOutputMonitor

public abstract boolean runFixedTimedRetryWithOutputMonitor (long opTimeout, 
                long idleOutputTimeout, 
                long pollInterval, 
                long maxTime, 
                IRunUtil.IRunnableResult runnable)

多次阻塞並執行一個操作,直到成功。也會監視輸出流的活動,如果在指定時間內沒有觀察到流活動,則中止。如果idleOutputTimeout設定為零,則不會發生串流監控。

參數
opTimeout long :單次操作嘗試等待的最長時間(以毫秒為單位)

idleOutputTimeout long :等待輸出流上的輸出的最長時間(以毫秒為單位)

pollInterval long :操作嘗試之間等待的初始時間

maxTime long :繼續嘗試操作的總的近似最大時間

runnable IRunUtil.IRunnableResult :要執行的IRunUtil.IRunnableResult

退貨
boolean true如果操作在 maxTime 過期之前成功完成

運行時

public abstract CommandStatus runTimed (long timeout, 
                IRunUtil.IRunnableResult runnable, 
                boolean logErrors)

阻止並執行操作,如果花費的時間超過指定時間則中止。

參數
timeout long :等待的最長時間(以毫秒為單位)

runnable IRunUtil.IRunnableResult :要執行的IRunUtil.IRunnableResult

logErrors boolean :是否記錄異常錯誤。

退貨
CommandStatus CommandStatus操作結果。

運行定時命令

public abstract CommandResult runTimedCmd (long timeout, 
                OutputStream stdout, 
                OutputStream stderr, 
                String... command)

用於執行系統命令的幫助程序方法,如果花費的時間超過指定時間則中止,並將輸出重定向到檔案(如果指定)。當以這種方式提供ERROR(/OutputStream)時,它們將在函數末尾保持開啟。

參數
timeout long :超時等待的最長時間(以毫秒為單位)。 0 表示沒有超時。

stdout OutputStream : ERROR(/OutputStream)其中 std 輸出將會被重新導向。可以為空。

stderr OutputStream : ERROR(/OutputStream)錯誤輸出將會被重新導向。可以為空。

command String : 指定的系統指令和 exec 的可選參數

退貨
CommandResult包含命令運行結果的CommandResult

運行定時命令

public abstract CommandResult runTimedCmd (long timeout, 
                String... command)

執行系統指令的幫助程序方法,如果花費的時間超過指定時間,則中止。

參數
timeout long :等待的最長時間(以毫秒為單位)。 0 表示沒有超時。

command String : 指定的系統指令和 exec 的可選參數

退貨
CommandResult包含命令運行結果的CommandResult

運行定時命令重試

public abstract CommandResult runTimedCmdRetry (long timeout, 
                long retryInterval, 
                int attempts, 
                String... command)

執行系統指令的幫助程序方法,如果花費的時間超過指定時間,則中止。

參數
timeout long :每次嘗試等待的最長時間(以毫秒為單位)

retryInterval long :指令重試之間等待的時間

attempts int : 最大嘗試次數

command String : 指定的系統指令和 exec 的可選參數

退貨
CommandResult包含命令運行結果的CommandResult

runTimedCmdRetryWithOutputMonitor

public abstract CommandResult runTimedCmdRetryWithOutputMonitor (long timeout, 
                long idleOutputTimeout, 
                long retryInterval, 
                int attempts, 
                String... command)

執行系統指令的幫助程序方法,如果花費的時間超過指定時間,則中止。也會監視輸出流的活動,如果在指定時間內沒有觀察到流活動,則中止。如果idleOutputTimeout設定為零,則不會發生串流監控。

參數
timeout long :每次嘗試等待的最長時間(以毫秒為單位)

idleOutputTimeout long :等待輸出流上的輸出的最長時間(以毫秒為單位)

retryInterval long :指令重試之間等待的時間

attempts int : 最大嘗試次數

command String : 指定的系統指令和 exec 的可選參數

退貨
CommandResult包含命令運行結果的CommandResult

靜默運轉定時命令

public abstract CommandResult runTimedCmdSilently (long timeout, 
                String... command)

執行系統指令的幫助程序方法,如果花費的時間超過指定時間,則中止。與runTimedCmd(long, String)類似,但不會記錄任何異常錯誤。

參數
timeout long :等待的最長時間(以毫秒為單位)

command String : 指定的系統指令和 exec 的可選參數

退貨
CommandResult包含命令運行結果的CommandResult

runTimedCmd靜默重試

public abstract CommandResult runTimedCmdSilentlyRetry (long timeout, 
                long retryInterval, 
                int attempts, 
                String... command)

執行系統指令的幫助程序方法,如果花費的時間超過指定時間,則中止。與runTimedCmdRetry(long, long, int, String[])類似,但不會記錄任何異常錯誤。

參數
timeout long :等待的最長時間(以毫秒為單位)

retryInterval long :指令重試之間等待的時間

attempts int : 最大嘗試次數

command String : 指定的系統指令和 exec 的可選參數

退貨
CommandResult包含命令運行結果的CommandResult

帶輸入的運行定時命令

public abstract CommandResult runTimedCmdWithInput (long timeout, 
                String input, 
                File stdoutFile, 
                File stderrFile, 
                String... command)

用於執行系統命令的幫助程序方法,如果花費的時間超過指定時間則中止,並將輸出重定向到檔案(如果指定)。

參數
timeout long :超時等待的最長時間(以毫秒為單位)。 0 表示沒有超時。

input String :傳遞給進程的標準輸入

stdoutFile FileERROR(/File)其中標準輸出將被重定向。可以為空。

stderrFile FileERROR(/File) ,錯誤輸出將被重定向。可以為空。

command String : 指定的系統指令和 exec 的可選參數

退貨
CommandResult包含命令運行結果的CommandResult

帶輸入的運行定時命令

public abstract CommandResult runTimedCmdWithInput (long timeout, 
                String input, 
                String... command)

用於執行需要 stdin 輸入的系統命令的幫助程序方法,如果花費的時間超過指定時間,則中止。

參數
timeout long :等待的最長時間(以毫秒為單位)

input String :傳遞給進程的標準輸入

command String : 指定的系統指令和 exec 的可選參數

退貨
CommandResult包含命令運行結果的CommandResult

帶輸入的運行定時命令

public abstract CommandResult runTimedCmdWithInput (long timeout, 
                String input, 
                 command)

用於執行需要 stdin 輸入的系統命令的幫助程序方法,如果花費的時間超過指定時間,則中止。

參數
timeout long :等待的最長時間(以毫秒為單位)

input String :傳遞給進程的標準輸入

command : ERROR(/List)包含系統指令和可選的 exec 參數

退貨
CommandResult包含命令運行結果的CommandResult

runTimedCmdWithInputRedirect

public abstract CommandResult runTimedCmdWithInputRedirect (long timeout, 
                File inputRedirect, 
                String... command)

用於執行需要從檔案重新導向 Stdin 的系統指令的幫助程式方法,如果花費的時間超過指定時間,則中止。

參數
timeout long :等待的最長時間(以毫秒為單位)

inputRedirect File :使用ProcessBuilder.redirectInput()ERROR(/File)重新導向為標準輸入。如果為 null,則 stdin 將不會被重新導向。

command String : 指定的系統指令和 exec 的可選參數

退貨
CommandResult包含命令運行結果的CommandResult

帶輸出監視器的運行定時命令

public abstract CommandResult runTimedCmdWithOutputMonitor (long timeout, 
                long idleOutputTimeout, 
                OutputStream stdout, 
                OutputStream stderr, 
                String... command)

用於執行系統命令的幫助程序方法,如果花費的時間超過指定時間則中止,並將輸出重定向到檔案(如果指定)。當以這種方式提供ERROR(/OutputStream)時,它們將在函數末尾保持開啟。

參數
timeout long :超時等待的最長時間(以毫秒為單位)。 0 表示沒有超時。

idleOutputTimeout long :等待輸出流上的輸出的最長時間(以毫秒為單位)

stdout OutputStream : ERROR(/OutputStream)其中 std 輸出將會被重新導向。可以為空。

stderr OutputStream : ERROR(/OutputStream)錯誤輸出將會被重新導向。可以為空。

command String : 指定的系統指令和 exec 的可選參數

退貨
CommandResult包含命令運行結果的CommandResult

帶輸出監視器的運行定時命令

public abstract CommandResult runTimedCmdWithOutputMonitor (long timeout, 
                long idleOutputTimeout, 
                String... command)

執行系統指令的幫助程序方法,如果花費的時間超過指定時間,則中止。也會監視輸出流的活動,如果在指定時間內沒有觀察到流活動,則中止。如果idleOutputTimeout設定為零,則不會發生串流監控。

參數
timeout long :等待的最長時間(以毫秒為單位)。 0 表示沒有超時。

idleOutputTimeout long :等待輸出流上的輸出的最長時間(以毫秒為單位)

command String : 指定的系統指令和 exec 的可選參數

退貨
CommandResult包含命令運行結果的CommandResult

運行定時重試

public abstract boolean runTimedRetry (long opTimeout, 
                long pollInterval, 
                int attempts, 
                IRunUtil.IRunnableResult runnable)

多次阻塞並執行一個操作,直到成功。

參數
opTimeout long :一次操作嘗試等待的最長時間(以毫秒為單位)

pollInterval long :指令重試之間等待的時間

attempts int : 最大嘗試次數

runnable IRunUtil.IRunnableResult :要執行的IRunUtil.IRunnableResult

退貨
boolean如果操作在嘗試到達之前成功完成,則為true

runTimedRetryWithOutputMonitor

public abstract boolean runTimedRetryWithOutputMonitor (long opTimeout, 
                long idleOutputTimeout, 
                long pollInterval, 
                int attempts, 
                IRunUtil.IRunnableResult runnable)

多次阻塞並執行一個操作,直到成功。也會監視輸出流的活動,如果在指定時間內沒有觀察到流活動,則中止。如果idleOutputTimeout設定為零,則不會發生串流監控。

參數
opTimeout long :一次操作嘗試等待的最長時間(以毫秒為單位)

idleOutputTimeout long :等待輸出流上的輸出的最長時間(以毫秒為單位)

pollInterval long :指令重試之間等待的時間

attempts int : 最大嘗試次數

runnable IRunUtil.IRunnableResult :要執行的IRunUtil.IRunnableResult

退貨
boolean如果操作在嘗試到達之前成功完成,則為true

帶輸出監視器的運轉定時

public abstract CommandStatus runTimedWithOutputMonitor (long timeout, 
                long idleOutputTimeout, 
                IRunUtil.IRunnableResult runnable, 
                boolean logErrors)

阻止並執行操作,如果花費的時間超過指定時間則中止。也會監視輸出流的活動,如果在指定時間內沒有觀察到流活動,則中止。如果idleOutputTimeout設定為零,則不會發生串流監控。

參數
timeout long :等待的最長時間(以毫秒為單位)

idleOutputTimeout long :等待輸出流上的輸出的最長時間(以毫秒為單位)

runnable IRunUtil.IRunnableResult :要執行的IRunUtil.IRunnableResult

logErrors boolean :是否記錄異常錯誤。

退貨
CommandStatus CommandStatus操作結果。

設定環境變數

public abstract void setEnvVariable (String key, 
                String value)

設定運行系統指令時要使用的環境變數。

參數
key String :變數名

value String :變數值

也可以看看:

設定環境變數優先權

public abstract void setEnvVariablePriority (IRunUtil.EnvPriority priority)

決定在建立進程時是否取消設定環境變數的優先權高於設定它們。預設情況下,取消設定具有更高的優先權:這表示如果嘗試設定具有相同名稱的變量,則不會發生這種情況,因為該變數將被取消設定。不能在預設IRunUtil實例上使用。

參數
priority IRunUtil.EnvPriority

設定可中斷的未來

public abstract void setInterruptibleInFuture (Thread thread, 
                long timeMs)

等待一段時間後設定為可中斷。 ERROR(/CommandScheduler#shutdownHard())強制我們最終終止。

參數
thread Thread :將變成可中斷的執行緒。

timeMs long :設定可中斷之前等待的時間。

設定Linux中斷行程

public abstract void setLinuxInterruptProcess (boolean interrupt)

允許在逾時時對透過 #runTimed 方法執行的程序使用 linux「kill」中斷。不能在預設IRunUtil實例上使用。

參數
interrupt boolean

setRedirectStderrToStdout

public abstract void setRedirectStderrToStdout (boolean redirect)

設定標準錯誤流以在執行系統命令時重定向到標準輸出流。初始值為假。

參數
redirect boolean :是否重定向的新值

設定工作目錄

public abstract void setWorkingDir (File dir)

設定係統指令的工作目錄。

參數
dir File :工作目錄

也可以看看:

睡覺

public abstract void sleep (long time)

幫助程序方法在給定時間內休眠,忽略任何異常。

參數
time long :女士要睡覺了。小於或等於 0 的值將被忽略

取消設定環境變數

public abstract void unsetEnvVariable (String key)

取消設定環境變量,因此系統命令在沒有此環境變量的情況下運行。

參數
key String :變數名

也可以看看: