ICommandScheduler
public
interface
ICommandScheduler
| com.android.tradefed.command.ICommandScheduler |
Harmonogram uruchamiania poleceń TradeFederation.
Podsumowanie
Zagnieżdżone klasy | |
|---|---|
interface |
ICommandScheduler.IScheduledInvocationListener
Detektor zdarzeń wywołania, który jest uruchamiany po zakończeniu wywołania. |
Metody publiczne | |
|---|---|
abstract
Pair<Boolean, Integer>
|
addCommand(String[] args)
Dodaje polecenie do harmonogramu. |
abstract
void
|
addCommandFile(String cmdFile, List<String> extraArgs)
Dodaje do harmonogramu wszystkie polecenia z danego pliku. |
abstract
void
|
await()
Czeka na rozpoczęcie działania algorytmu szeregowania, w tym na zakończenie przekazywania z TF do TF (jeśli dotyczy). |
abstract
void
|
displayCommandQueue(PrintWriter printWriter)
Wyświetla szczegółowe informacje debugowania o stanie kolejki wykonywania poleceń. |
abstract
void
|
displayCommandsInfo(PrintWriter printWriter, String regex)
Wyświetl listę bieżących poleceń. |
abstract
void
|
displayInvocationsInfo(PrintWriter printWriter)
Wyświetla listę bieżących wywołań. |
abstract
void
|
dumpCommandsXml(PrintWriter printWriter, String regex)
Wyeksportuj rozwinięty plik XML 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 istniejącego już |
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, ITestDevice device, String[] args)
Bezpośrednie wykonywanie poleceń na urządzeniu, które zostało już przydzielone. |
abstract
long
|
execCommand(ICommandScheduler.IScheduledInvocationListener listener, List<ITestDevice> devices, String[] args)
Bezpośrednie wykonywanie poleceń na urządzeniach, które zostały już przydzielone. |
abstract
CommandFileWatcher
|
getCommandFileWatcher()
Pobierz odpowiedni obiekt CommandFileWatcher dla tego harmonogramu |
abstract
int
|
getExecutingCommandCount()
Zwraca liczbę poleceń w stanie wykonywania. |
abstract
String
|
getInvocationInfo(int invocationId)
Zwraca informacje o wywołaniu, podając jego identyfikator. |
abstract
CommandRunner.ExitCode
|
getLastInvocationExitCode()
Zwraca kod błędu ostatniego wywołania, które zostało uruchomione. |
abstract
Throwable
|
getLastInvocationThrowable()
Zwraca |
abstract
int
|
getReadyCommandCount()
Zwraca liczbę poleceń w stanie gotowości w kolejce. |
abstract
boolean
|
isDeviceInInvocationThread(ITestDevice device)
Zwraca wartość „prawda”, jeśli urządzenie jest używane przez aktywny wątek wywołania. |
abstract
void
|
join()
Czeka na zakończenie działania harmonogramu. |
abstract
void
|
join(long millis)
Czeka na zakończenie działania harmonogramu lub przekroczenie limitu czasu po upływie czasu określonego w milisekundach. |
abstract
void
|
removeAllCommands()
Usuwanie wszystkich poleceń z harmonogramu |
abstract
void
|
setClearcutClient(ClearcutClient client)
Skonfiguruj klienta tak, aby raportował dane dotyczące wiązki |
default
void
|
setMaxPollTime(long polling)
|
default
void
|
setPrintSchedulingWarning(boolean print)
|
abstract
boolean
|
shouldShutdownOnCmdfileError()
Zwraca wartość „true”, jeśli w przypadku błędów poleceń trzeba wyłączyć harmonogram. |
default
void
|
shutdown()
Próba płynnego wyłączenia harmonogramu poleceń. |
abstract
void
|
shutdown(boolean notifyStop)
Próba płynnego wyłączenia harmonogramu poleceń. |
abstract
void
|
shutdownHard(boolean killAdb)
Próba wymuszonego zamknięcia harmonogramu poleceń. |
abstract
void
|
shutdownHard()
Próba wymuszonego zamknięcia harmonogramu poleceń. |
abstract
void
|
shutdownOnEmpty()
Podobne do |
abstract
void
|
start()
Uruchom |
abstract
boolean
|
stopInvocation(int invocationId, String cause)
Zatrzymaj trwające wywołanie, podając jego identyfikator. |
default
boolean
|
stopInvocation(int invocationId)
Zatrzymaj trwające wywołanie, podając jego identyfikator. |
abstract
boolean
|
stopInvocation(ITestInvocation invocation)
Zatrzymywanie uruchomionego wywołania |
default
void
|
stopScheduling()
Zatrzymuje planowanie i akceptowanie nowych testów, ale nie zatrzymuje Tradefed. |
Metody publiczne
addCommand
public abstract Pair<Boolean, Integer> addCommand (String[] args)
Dodaje polecenie do harmonogramu.
Polecenie to w zasadzie instancja konfiguracji do uruchomienia i powiązane z nią argumenty.
Jeśli podany jest argument „--help”, tekst pomocy dotyczący konfiguracji zostanie wyświetlony w standardowym wyjściu. W przeciwnym razie konfiguracja zostanie dodana do kolejki do uruchomienia.
| Parametry | |
|---|---|
args |
String: argumenty konfiguracji. |
| Zwraca | |
|---|---|
Pair<Boolean, Integer> |
Para wartości. Pierwsza wartość to wartość logiczna true, jeśli polecenie zostało dodane. Druga wartość to znany identyfikator śledzenia poleceń(wartość nieujemna), jeśli polecenie zostało dodane, 0, jeśli polecenie zostało dodane na wszystkich urządzeniach, lub -1. |
| Zgłasza | |
|---|---|
ConfigurationException |
jeśli nie udało się przeanalizować polecenia. |
addCommandFile
public abstract void addCommandFile (String cmdFile,
List<String> extraArgs)Dodaje do harmonogramu wszystkie polecenia z danego pliku.
| Parametry | |
|---|---|
cmdFile |
String: ścieżka systemu plików do pliku poleceń |
extraArgs |
List: List argumentów String dołączenia do każdego polecenia przeanalizowanego z pliku. Może być puste, ale nie powinno mieć wartości null. |
| Zgłasza | |
|---|---|
ConfigurationException |
jeśli nie udało się przeanalizować pliku poleceń. |
Zobacz też:
oczekiwać,
public abstract void await ()
Czeka na rozpoczęcie działania algorytmu szeregowania, w tym na zakończenie przekazywania z TF do TF (jeśli dotyczy).
| Zgłasza | |
|---|---|
InterruptedException |
|
displayCommandQueue
public abstract void displayCommandQueue (PrintWriter printWriter)
Wyświetla szczegółowe informacje debugowania o stanie kolejki wykonywania poleceń.
displayCommandsInfo
public abstract void displayCommandsInfo (PrintWriter printWriter,
String regex)Wyświetl listę bieżących poleceń.
| Parametry | |
|---|---|
printWriter |
PrintWriter: PrintWriter, do którego ma być wysyłane wyjście. |
regex |
String: wyrażenie regularne, do którego polecenia powinny być dopasowywane, aby można je było wydrukować. Jeśli wartość to null, zostaną wydrukowane wszystkie polecenia. |
displayInvocationsInfo
public abstract void displayInvocationsInfo (PrintWriter printWriter)
Wyświetla listę bieżących wywołań.
| Parametry | |
|---|---|
printWriter |
PrintWriter: PrintWriter, do którego ma być wysyłane wyjście. |
dumpCommandsXml
public abstract void dumpCommandsXml (PrintWriter printWriter,
String regex)Wyeksportuj rozwinięty plik XML polecenia ze wszystkimi wartościami Option określonymi dla wszystkich bieżących poleceń.
| Parametry | |
|---|---|
printWriter |
PrintWriter: PrintWriter, do którego ma być wysyłany stan. |
regex |
String: wyrażenie regularne, z którym polecenia powinny być zgodne, aby zrzucać plik XML. Jeśli wartość to null, zostaną zrzucone wszystkie polecenia. |
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 istniejącego już IInvocationContext.
| Parametry | |
|---|---|
context |
IInvocationContext: istniejący IInvocationContext. |
listener |
ICommandScheduler.IScheduledInvocationListener: ICommandScheduler.IScheduledInvocationListener, który ma otrzymać powiadomienie |
args |
String: argumenty polecenia |
| Zwraca | |
|---|---|
long |
|
| Zgłasza | |
|---|---|
ConfigurationException |
jeśli polecenie było nieprawidłowe. |
NoDeviceException |
jeśli nie masz urządzenia, którego możesz użyć. |
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 otrzymać powiadomienie |
args |
String: argumenty polecenia |
| Zwraca | |
|---|---|
long |
Identyfikator wywołania zaplanowanego polecenia. |
| Zgłasza | |
|---|---|
ConfigurationException |
jeśli polecenie było nieprawidłowe. |
NoDeviceException |
jeśli nie masz urządzenia, którego możesz użyć. |
execCommand
public abstract long execCommand (ICommandScheduler.IScheduledInvocationListener listener, ITestDevice device, String[] args)
Bezpośrednie wykonywanie poleceń na urządzeniu, które zostało już przydzielone.
| Parametry | |
|---|---|
listener |
ICommandScheduler.IScheduledInvocationListener: ICommandScheduler.IScheduledInvocationListener, który ma otrzymać powiadomienie |
device |
ITestDevice: ITestDevice, którego chcesz użyć. |
args |
String: argumenty polecenia |
| Zwraca | |
|---|---|
long |
Identyfikator wywołania zaplanowanego polecenia. |
| Zgłasza | |
|---|---|
ConfigurationException |
jeśli polecenie było nieprawidłowe. |
execCommand
public abstract long execCommand (ICommandScheduler.IScheduledInvocationListener listener, List<ITestDevice> devices, String[] args)
Bezpośrednie wykonywanie poleceń na urządzeniach, które zostały już przydzielone.
| Parametry | |
|---|---|
listener |
ICommandScheduler.IScheduledInvocationListener: ICommandScheduler.IScheduledInvocationListener, który ma otrzymać powiadomienie |
devices |
List: ERROR(/List, którego chcesz użyć. |
args |
String: argumenty polecenia |
| Zwraca | |
|---|---|
long |
Identyfikator wywołania zaplanowanego polecenia. |
| Zgłasza | |
|---|---|
ConfigurationException |
jeśli polecenie było nieprawidłowe. |
getCommandFileWatcher
public abstract CommandFileWatcher getCommandFileWatcher ()
Pobierz odpowiedni obiekt CommandFileWatcher dla tego harmonogramu
| Zwraca | |
|---|---|
CommandFileWatcher |
|
getExecutingCommandCount
public abstract int getExecutingCommandCount ()
Zwraca liczbę poleceń w stanie wykonywania.
| Zwraca | |
|---|---|
int |
|
getInvocationInfo
public abstract String getInvocationInfo (int invocationId)
Zwraca informacje o wywołaniu, podając jego identyfikator.
| Parametry | |
|---|---|
invocationId |
int: identyfikator śledzenia wywołania. |
| Zwraca | |
|---|---|
String |
String zawierający informacje o wywołaniu. |
getLastInvocationExitCode
public abstract CommandRunner.ExitCode getLastInvocationExitCode ()
Zwraca kod błędu ostatniego wywołania, które zostało uruchomione. Zwraca 0 (brak błędu), jeśli nie uruchomiono jeszcze żadnego wywołania.
| Zwraca | |
|---|---|
CommandRunner.ExitCode |
|
getLastInvocationThrowable
public abstract Throwable getLastInvocationThrowable ()
Zwraca Throwable z ostatniego uruchomienia.
Jeśli nie ma obiektu throwable, zwraca wartość null.
| Zwraca | |
|---|---|
Throwable |
|
getReadyCommandCount
public abstract int getReadyCommandCount ()
Zwraca liczbę poleceń w stanie gotowości w kolejce.
| Zwraca | |
|---|---|
int |
|
isDeviceInInvocationThread
public abstract boolean isDeviceInInvocationThread (ITestDevice device)
Zwraca wartość „prawda”, jeśli urządzenie jest używane przez aktywny wątek wywołania.
| Parametry | |
|---|---|
device |
ITestDevice |
| Zwraca | |
|---|---|
boolean |
|
złączenie
public abstract void join ()
Czeka na zakończenie działania harmonogramu.
| Zgłasza | |
|---|---|
InterruptedException |
|
Zobacz też:
złączenie
public abstract void join (long millis)
Czeka na zakończenie działania harmonogramu lub przekroczenie limitu czasu po upływie czasu określonego w milisekundach.
| Parametry | |
|---|---|
millis |
long |
| Zgłasza | |
|---|---|
InterruptedException |
|
Zobacz też:
removeAllCommands
public abstract void removeAllCommands ()
Usuwanie wszystkich poleceń z harmonogramu
setClearcutClient
public abstract void setClearcutClient (ClearcutClient client)
Skonfiguruj klienta tak, aby raportował dane dotyczące wiązki
| Parametry | |
|---|---|
client |
ClearcutClient |
setMaxPollTime
public void setMaxPollTime (long polling)
| Parametry | |
|---|---|
polling |
long |
setPrintSchedulingWarning
public void setPrintSchedulingWarning (boolean print)
| Parametry | |
|---|---|
print |
boolean |
shouldShutdownOnCmdfileError
public abstract boolean shouldShutdownOnCmdfileError ()
Zwraca wartość „true”, jeśli w przypadku błędów poleceń trzeba wyłączyć harmonogram.
| Zwraca | |
|---|---|
boolean |
|
wyłączenie,
public void shutdown ()
Próba płynnego wyłączenia harmonogramu poleceń.
Czyści polecenia oczekujące na przetestowanie i żąda, aby wszystkie wywołania w toku zostały prawidłowo zamknięte.
Po wywołaniu funkcji shutdown główna pętla harmonogramu poczeka, aż wszystkie wywołania w toku zostaną zakończone, zanim całkowicie się zamknie.
wyłączenie,
public abstract void shutdown (boolean notifyStop)
Próba płynnego wyłączenia harmonogramu poleceń.
| Parametry | |
|---|---|
notifyStop |
boolean: jeśli ma wartość „true”, powiadamia o wywołaniach zamknięcia TF. |
shutdownHard
public abstract void shutdownHard (boolean killAdb)
Próba wymuszonego zamknięcia harmonogramu poleceń.
Podobne do shutdown(), ale opcjonalnie zamyka też połączenie adb, aby „zachęcić” trwające wywołania do szybszego zakończenia.
| Parametry | |
|---|---|
killAdb |
boolean |
shutdownHard
public abstract void shutdownHard ()
Próba wymuszonego zamknięcia harmonogramu poleceń. Tak samo jak shutdownHard(true).
shutdownOnEmpty
public abstract void shutdownOnEmpty ()
Podobne do shutdown(), ale przed zakończeniem działania poczeka na wykonanie wszystkich poleceń.
Pamiętaj, że jeśli jakiekolwiek polecenia są w trybie pętli, harmonogram nigdy się nie zakończy.
rozpocznij
public abstract void start ()
Uruchom ICommandScheduler.
Musi być wywoływana przed wywołaniem innych metod.
Będzie działać do momentu wywołania funkcji shutdown().
zobacz Thread.start().
stopInvocation
public abstract boolean stopInvocation (int invocationId,
String cause)Zatrzymaj trwające wywołanie, podając jego identyfikator.
| Parametry | |
|---|---|
invocationId |
int: identyfikator śledzenia wywołania. |
cause |
String: przyczyna zatrzymania wywołania. |
| Zwraca | |
|---|---|
boolean |
wartość true, jeśli wywołanie zostało zatrzymane, w przeciwnym razie wartość false; |
| Zgłasza | |
|---|---|
UnsupportedOperationException |
jeśli wdrożenie nie obsługuje tej funkcji. |
stopInvocation
public boolean stopInvocation (int invocationId)
Zatrzymaj trwające wywołanie, podając jego identyfikator.
| Parametry | |
|---|---|
invocationId |
int |
| Zwraca | |
|---|---|
boolean |
wartość true, jeśli wywołanie zostało zatrzymane, w przeciwnym razie wartość false; |
| Zgłasza | |
|---|---|
UnsupportedOperationException |
jeśli wdrożenie nie obsługuje tej funkcji. |
stopInvocation
public abstract boolean stopInvocation (ITestInvocation invocation)
Zatrzymywanie uruchomionego wywołania
| Parametry | |
|---|---|
invocation |
ITestInvocation |
| Zwraca | |
|---|---|
boolean |
wartość true, jeśli wywołanie zostało zatrzymane, w przeciwnym razie wartość false; |
| Zgłasza | |
|---|---|
UnsupportedOperationException |
jeśli wdrożenie nie obsługuje tej funkcji. |
stopScheduling
public void stopScheduling ()
Zatrzymuje planowanie i akceptowanie nowych testów, ale nie zatrzymuje Tradefed. Ma to umożliwić dwuetapowe wyłączanie, w którym najpierw opróżniamy wszystkie uruchomione testy, a następnie kończymy proces Tradefed.