ICommandScheduler
public interface ICommandScheduler
com.android.tradefed.command.ICommandScheduler |
Harmonogram do uruchamiania poleceń TradeFederation.
Streszczenie
Klasy zagnieżdżone | |
---|---|
interface | ICommandScheduler.IScheduledInvocationListener Odbiornik zdarzeń wywołania po zakończeniu wywołania. |
Metody publiczne | |
---|---|
abstract Pair <Boolean, Integer> | addCommand (String[] args) Dodaje polecenie do harmonogramu. |
abstract void | addCommandFile (String cmdFile, extraArgs) addCommandFile (String cmdFile, extraArgs) Dodaje wszystkie polecenia z podanego pliku do harmonogramu |
abstract void | await () Czeka na uruchomienie programu planującego, w tym oczekiwanie na zakończenie przekazywania ze starego TF, jeśli ma to zastosowanie. |
abstract void | displayCommandQueue (PrintWriter printWriter) Wygeneruj szczegółowe informacje debugowania dotyczące stanu kolejki wykonywania poleceń. |
abstract void | displayCommandsInfo (PrintWriter printWriter, String regex) Wygeneruj listę bieżących poleceń. |
abstract void | displayInvocationsInfo (PrintWriter printWriter) Wyświetla listę bieżących wywołań. |
abstract void | dumpCommandsXml (PrintWriter printWriter, String regex) Zrzuć rozszerzony plik xml dla polecenia ze wszystkimi wartościami |
abstract long | execCommand ( IInvocationContext context, ICommandScheduler.IScheduledInvocationListener listener, String[] args) Bezpośrednio przydziela urządzenie i wykonuje polecenie bez dodawania go do kolejki poleceń przy użyciu już istniejącego |
abstract long | execCommand ( ICommandScheduler.IScheduledInvocationListener listener, String[] args) Bezpośrednio przydziela urządzenie i wykonuje polecenie bez dodawania go do kolejki poleceń. |
abstract long | execCommand ( ICommandScheduler.IScheduledInvocationListener listener, devices, String[] args) execCommand ( ICommandScheduler.IScheduledInvocationListener listener, devices, String[] args) Bezpośrednio wykonaj polecenie na już przydzielonych urządzeniach. |
abstract CommandFileWatcher | getCommandFileWatcher () Uzyskaj odpowiedni |
abstract int | getExecutingCommandCount () Zwraca liczbę poleceń w stanie wykonywania. |
abstract String | getInvocationInfo (int invocationId) Zwróć informacje na bu wywołania, określając identyfikator wywołania. |
abstract CommandRunner.ExitCode | getLastInvocationExitCode () Zwróć kod błędu ostatniego uruchomionego wywołania. |
abstract Throwable | getLastInvocationThrowable () Zwróć |
abstract int | getReadyCommandCount () Zwraca liczbę poleceń w stanie gotowości w kolejce. |
abstract boolean | isDeviceInInvocationThread ( ITestDevice device) Zwraca wartość true, jeśli urządzenie jest używane przez aktywny wątek wywołania. |
abstract void | join () Czeka na zakończenie harmonogramu. |
abstract void | join (long millis) Czeka na zakończenie harmonogramu lub przekroczenie limitu czasu po czasie określonym w milisekundach. |
abstract void | removeAllCommands () Usuń wszystkie polecenia z harmonogramu |
abstract void | setClearcutClient (ClearcutClient client) Ustaw klienta, aby raportował dane wiązki przewodów |
abstract boolean | shouldShutdownOnCmdfileError () Zwróć wartość true, jeśli musimy zamknąć program planujący w przypadku błędów polecenia |
default void | shutdown () Próba płynnego zamknięcia programu planującego polecenia. |
abstract void | shutdown (boolean notifyStop) Próba płynnego zamknięcia programu planującego polecenia. |
abstract void | shutdownHard (boolean killAdb) Spróbuj wymusić zamknięcie harmonogramu poleceń. |
abstract void | shutdownHard () Spróbuj wymusić zamknięcie harmonogramu poleceń. |
abstract void | shutdownOnEmpty () Podobny do |
abstract void | start () Uruchom |
abstract boolean | stopInvocation (int invocationId, String cause) Zatrzymaj uruchomione wywołanie, określając jego identyfikator. |
default boolean | stopInvocation (int invocationId) Zatrzymaj uruchomione wywołanie, określając jego identyfikator. |
abstract boolean | stopInvocation ( ITestInvocation invocation) Zatrzymaj uruchomioną inwokację. |
Metody publiczne
dodaj polecenie
public abstract Pair<Boolean, Integer> addCommand (String[] args)
Dodaje polecenie do harmonogramu.
Polecenie to zasadniczo instancja konfiguracji do uruchomienia i związanych z nią argumentów.
Jeśli podano argument „--help”, tekst pomocy dla konfiguracji zostanie wysłany na standardowe wyjście. W przeciwnym razie konfiguracja zostanie dodana do kolejki do uruchomienia.
Parametry | |
---|---|
args | String : argumenty konfiguracji. |
Zwroty | |
---|---|
Pair <Boolean, Integer> | Para wartości, pierwsza wartość to logiczna true , jeśli polecenie zostało pomyślnie dodane. Druga wartość to znany identyfikator śledzenia poleceń (wartość nieujemna), jeśli polecenie zostało dodane pomyślnie, zwróć 0, gdy polecenie zostanie dodane dla wszystkich urządzeń, w przeciwnym razie -1. |
Rzuty | |
---|---|
ConfigurationException | jeśli nie można przeanalizować polecenia |
dodaj plik polecenia
public abstract void addCommandFile (String cmdFile,extraArgs)
Dodaje wszystkie polecenia z podanego pliku do harmonogramu
Parametry | |
---|---|
cmdFile | String : ścieżka do systemu plików pliku poleceń |
extraArgs | ERROR(/List) z argumentów ERROR(/String) do dołączenia do każdego polecenia analizowanego z pliku. Może być pusty, ale nie powinien mieć wartości null. |
Rzuty | |
---|---|
ConfigurationException | jeśli nie można przeanalizować pliku poleceń |
Zobacz też:
czekać na
public abstract void await ()
Czeka na uruchomienie programu planującego, w tym oczekiwanie na zakończenie przekazywania ze starego TF, jeśli ma to zastosowanie.
wyświetl kolejkę poleceń
public abstract void displayCommandQueue (PrintWriter printWriter)
Wygeneruj szczegółowe informacje debugowania dotyczące stanu kolejki wykonywania poleceń.
wyświetl poleceniaInformacje
public abstract void displayCommandsInfo (PrintWriter printWriter, String regex)
Wygeneruj listę bieżących poleceń.
Parametry | |
---|---|
printWriter | PrintWriter : ERROR(/PrintWriter) do wyjścia. |
regex | String : wyrażenie regularne, do którego należy dopasować polecenia, aby zostały wydrukowane. Jeśli null, wydrukowane zostaną wszystkie polecenia. |
wyświetl informacje o inwokacjach
public abstract void displayInvocationsInfo (PrintWriter printWriter)
Wyświetla listę bieżących wywołań.
Parametry | |
---|---|
printWriter | PrintWriter : ERROR(/PrintWriter) do wyjścia. |
dumpCommandsXml
public abstract void dumpCommandsXml (PrintWriter printWriter, String regex)
Zrzuć rozszerzony plik xml dla polecenia ze wszystkimi wartościami Option
określonymi dla wszystkich bieżących poleceń.
Parametry | |
---|---|
printWriter | PrintWriter : ERROR(/PrintWriter) do którego ma zostać wysłany status. |
regex | String : wyrażenie regularne, do którego należy dopasować polecenia, aby plik xml został zrzucony. Jeśli null, wszystkie polecenia zostaną zrzucone. |
execCommand
public abstract long execCommand (IInvocationContext context, ICommandScheduler.IScheduledInvocationListener listener, String[] args)
Bezpośrednio przydziela urządzenie i wykonuje polecenie bez dodawania go do kolejki poleceń przy użyciu już istniejącego IInvocationContext
.
Parametry | |
---|---|
context | IInvocationContext : istniejący IInvocationContext . |
listener | ICommandScheduler.IScheduledInvocationListener : ICommandScheduler.IScheduledInvocationListener , który ma zostać poinformowany |
args | String : argumenty polecenia |
Zwroty | |
---|---|
long |
Rzuty | |
---|---|
ConfigurationException | jeśli polecenie było nieprawidłowe |
NoDeviceException | jeśli nie ma urządzenia do użycia |
execCommand
public abstract long execCommand (ICommandScheduler.IScheduledInvocationListener listener, String[] args)
Bezpośrednio przydziela urządzenie i wykonuje polecenie bez dodawania go do kolejki poleceń.
Parametry | |
---|---|
listener | ICommandScheduler.IScheduledInvocationListener : ICommandScheduler.IScheduledInvocationListener , który ma zostać poinformowany |
args | String : argumenty polecenia |
Zwroty | |
---|---|
long | Identyfikator wywołania zaplanowanego polecenia. |
Rzuty | |
---|---|
ConfigurationException | jeśli polecenie było nieprawidłowe |
NoDeviceException | jeśli nie ma urządzenia do użycia |
execCommand
public abstract long execCommand (ICommandScheduler.IScheduledInvocationListener listener,devices, String[] args)
Bezpośrednio wykonaj polecenie na już przydzielonych urządzeniach.
Parametry | |
---|---|
listener | ICommandScheduler.IScheduledInvocationListener : ICommandScheduler.IScheduledInvocationListener , który ma zostać poinformowany |
devices | ERROR(/List ) ERROR(/List ) używać |
args | String : argumenty polecenia |
Zwroty | |
---|---|
long | Identyfikator wywołania zaplanowanego polecenia. |
Rzuty | |
---|---|
ConfigurationException | jeśli polecenie było nieprawidłowe |
getCommandFileWatcher
public abstract CommandFileWatcher getCommandFileWatcher ()
Uzyskaj odpowiedni CommandFileWatcher
dla tego harmonogramu
Zwroty | |
---|---|
CommandFileWatcher |
getExecutingCommandCount
public abstract int getExecutingCommandCount ()
Zwraca liczbę poleceń w stanie wykonywania.
Zwroty | |
---|---|
int |
pobierz informacje o wywołaniu
public abstract String getInvocationInfo (int invocationId)
Zwróć informacje na bu wywołania, określając identyfikator wywołania.
Parametry | |
---|---|
invocationId | int : identyfikator śledzenia wywołania. |
Zwroty | |
---|---|
String | ERROR(/String) zawierający informacje o wywołaniu. |
getLastInvocationExitCode
public abstract CommandRunner.ExitCode getLastInvocationExitCode ()
Zwróć kod błędu ostatniego uruchomionego wywołania. Zwróć 0 (brak błędu), jeśli żadne wywołanie nie zostało jeszcze uruchomione.
Zwroty | |
---|---|
CommandRunner.ExitCode |
getLastInvocationThrowable
public abstract Throwable getLastInvocationThrowable ()
Zwróć ERROR(/Throwable)
z ostatniego uruchomionego wywołania. Zwróć null, jeśli nie ma dostępnego przedmiotu do rzucania.
Zwroty | |
---|---|
Throwable |
getReadyCommandCount
public abstract int getReadyCommandCount ()
Zwraca liczbę poleceń w stanie gotowości w kolejce.
Zwroty | |
---|---|
int |
isDeviceInInvocationThread
public abstract boolean isDeviceInInvocationThread (ITestDevice device)
Zwraca wartość true, jeśli urządzenie jest używane przez aktywny wątek wywołania.
Parametry | |
---|---|
device | ITestDevice |
Zwroty | |
---|---|
boolean |
dołączyć
public abstract void join ()
Czeka na zakończenie harmonogramu.
Zobacz też:
dołączyć
public abstract void join (long millis)
Czeka na zakończenie harmonogramu lub przekroczenie limitu czasu po czasie określonym w milisekundach.
Parametry | |
---|---|
millis | long |
Zobacz też:
usuń wszystkie polecenia
public abstract void removeAllCommands ()
Usuń wszystkie polecenia z harmonogramu
setClearcutClient
public abstract void setClearcutClient (ClearcutClient client)
Ustaw klienta, aby raportował dane wiązki przewodów
Parametry | |
---|---|
client | ClearcutClient |
shouldShutdownOnCmdfileError
public abstract boolean shouldShutdownOnCmdfileError ()
Zwróć wartość true, jeśli musimy zamknąć program planujący w przypadku błędów polecenia
Zwroty | |
---|---|
boolean |
zamknięcie
public void shutdown ()
Próba płynnego zamknięcia programu planującego polecenia.
Czyści polecenia oczekujące na przetestowanie i żąda płynnego zamknięcia wszystkich trwających wywołań.
Po wywołaniu zamknięcia główna pętla programu planującego będzie czekać na zakończenie wszystkich trwających wywołań przed całkowitym zakończeniem działania.
zamknięcie
public abstract void shutdown (boolean notifyStop)
Próba płynnego zamknięcia programu planującego polecenia.
Parametry | |
---|---|
notifyStop | boolean : jeśli true, powiadamia wywołania o zamknięciu TF. |
zamknięcieTwarde
public abstract void shutdownHard (boolean killAdb)
Spróbuj wymusić zamknięcie harmonogramu poleceń.
Podobny do shutdown()
, ale opcjonalnie zabije również połączenie adb, próbując „zainspirować” trwające wywołania do szybszego ukończenia.
Parametry | |
---|---|
killAdb | boolean |
zamknięcieTwarde
public abstract void shutdownHard ()
Spróbuj wymusić zamknięcie harmonogramu poleceń. To samo co shutdownHard(true).
zamknięcie przy pustym
public abstract void shutdownOnEmpty ()
Podobny do shutdown()
, ale zamiast tego czeka na wykonanie wszystkich poleceń przed wyjściem.
początek
public abstract void start ()
Uruchom ICommandScheduler
.
shutdown()
. zobacz ERROR(/Thread#start())
. stopInwokacja
public abstract boolean stopInvocation (int invocationId, String cause)
Zatrzymaj uruchomione wywołanie, określając jego identyfikator.
Parametry | |
---|---|
invocationId | int : identyfikator śledzenia wywołania. |
cause | String : przyczyna zatrzymania wywołania. |
Zwroty | |
---|---|
boolean | true, jeśli wywołanie zostało zatrzymane, w przeciwnym razie false |
Rzuty | |
---|---|
| jeśli implementacja tego nie obsługuje |
stopInwokacja
public boolean stopInvocation (int invocationId)
Zatrzymaj uruchomione wywołanie, określając jego identyfikator.
Parametry | |
---|---|
invocationId | int |
Zwroty | |
---|---|
boolean | true, jeśli wywołanie zostało zatrzymane, w przeciwnym razie false |
Rzuty | |
---|---|
| jeśli implementacja tego nie obsługuje |
stopInwokacja
public abstract boolean stopInvocation (ITestInvocation invocation)
Zatrzymaj uruchomioną inwokację.
Parametry | |
---|---|
invocation | ITestInvocation |
Zwroty | |
---|---|
boolean | true, jeśli wywołanie zostało zatrzymane, w przeciwnym razie false |
Rzuty | |
---|---|
| jeśli implementacja tego nie obsługuje |
Treść strony i umieszczone na niej fragmenty kodu podlegają licencjom opisanym w Licencji na treści. Java i OpenJDK są znakami towarowymi lub zastrzeżonymi znakami towarowymi należącymi do firmy Oracle lub jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2023-03-30 UTC.