iCommandScheduler

public interface ICommandScheduler

com.android.tradefed.command.ICommandScheduler

Bekannte indirekte abgeleitete Klassen ClusterCommandScheduler, CommandScheduler ClusterCommandScheduler Ein ICommandScheduler zur Unterstützung von TFC (Tradefed Cluster).  CommandScheduler Ein Planer zum Ausführen von TradeFederation-Befehlen auf allen verfügbaren Geräten.

---

Ein Planer zum Ausführen von TradeFederation-Befehlen.

Zusammenfassung

Verschachtelte Klassen
interface	ICommandScheduler.IScheduledInvocationListener Listener für Aufrufereignisse bei Abschluss des Aufrufs.

Öffentliche Methoden
abstract Pair<Boolean, Integer>	addCommand(String[] args) Fügt dem Planer einen Befehl hinzu.
abstract void	addCommandFile(String cmdFile, extraArgs) Fügt dem Planer alle Befehle aus der angegebenen Datei hinzu
abstract void	await() Wartet, bis der Planer ausgeführt wird, einschließlich Warten auf den Abschluss der Übergabe der alten TF falls zutreffend.
abstract void	displayCommandQueue(PrintWriter printWriter) Gibt detaillierte Debug-Informationen zum Status der Warteschlange für die Befehlsausführung aus.
abstract void	displayCommandsInfo(PrintWriter printWriter, String regex) Gibt eine Liste der aktuellen Befehle aus.
abstract void	displayInvocationsInfo(PrintWriter printWriter) Zeigt eine Liste der aktuellen Aufrufe an.
abstract void	dumpCommandsXml(PrintWriter printWriter, String regex) Speichern Sie die erweiterte XML-Datei für den Befehl mit allen Option-Werte, die für alle aktuellen Befehle angegeben wurden.
abstract long	execCommand(IInvocationContext context, ICommandScheduler.IScheduledInvocationListener listener, String[] args) Ordnet ein Gerät direkt zu und führt einen Befehl aus, ohne es der Befehlswarteschlange hinzuzufügen mit einer bereits vorhandenen IInvocationContext.
abstract long	execCommand(ICommandScheduler.IScheduledInvocationListener listener, String[] args) Ordnet ein Gerät direkt zu und führt einen Befehl aus, ohne es der Befehlswarteschlange hinzuzufügen.
abstract long	execCommand(ICommandScheduler.IScheduledInvocationListener listener, devices, String[] args) Führen Sie Befehle direkt auf bereits zugewiesenen Geräten aus.
abstract CommandFileWatcher	getCommandFileWatcher() Passenden CommandFileWatcher für diesen Planer abrufen
abstract int	getExecutingCommandCount() Gibt die Anzahl der Befehle im Ausführungsstatus zurück.
abstract String	getInvocationInfo(int invocationId) Gibt die Informationen zu einem Aufruf zurück, indem die Aufruf-ID angegeben wird.
abstract CommandRunner.ExitCode	getLastInvocationExitCode() Gibt den Fehlercode des letzten ausgeführten Aufrufs zurück.
abstract Throwable	getLastInvocationThrowable() Gibt das Throwable des letzten ausgeführten Aufrufs zurück.
abstract int	getReadyCommandCount() Gibt die Anzahl der Befehle im Status „Bereit“ in der Warteschlange zurück.
abstract boolean	isDeviceInInvocationThread(ITestDevice device) Gibt „true“ zurück, wenn das Gerät von einem aktiven Aufrufthread verwendet wird.
abstract void	join() Wartet auf den Abschluss des Planers.
abstract void	join(long millis) Wartet auf den Abschluss des Planers oder auf das Zeitlimit nach dem angegebenen Zeitraum in Millisekunden.
abstract void	removeAllCommands() Alle Befehle aus dem Planer entfernen
abstract void	setClearcutClient(ClearcutClient client) Den Kunden für die Berichterstellung über die Nutzungsdaten einrichten
abstract boolean	shouldShutdownOnCmdfileError() Gibt „true“ zurück, wenn der Planer bei einem Befehlsfehler heruntergefahren werden muss
default void	shutdown() Versuchen Sie, den Befehlsplaner ordnungsgemäß herunterzufahren.
abstract void	shutdown(boolean notifyStop) Versuchen Sie, den Befehlsplaner ordnungsgemäß herunterzufahren.
abstract void	shutdownHard(boolean killAdb) Versuchen Sie, das Herunterfahren des Befehlsplaners zu erzwingen.
abstract void	shutdownHard() Versuchen Sie, das Herunterfahren des Befehlsplaners zu erzwingen.
abstract void	shutdownOnEmpty() Ähnlich wie „shutdown()“, wird aber darauf gewartet, dass alle Befehle ausgeführt wurden bevor Sie die Seite verlassen.
abstract void	start() Starten Sie ICommandScheduler.
abstract boolean	stopInvocation(int invocationId, String cause) Beenden Sie einen laufenden Aufruf, indem Sie seine ID angeben.
default boolean	stopInvocation(int invocationId) Beenden Sie einen laufenden Aufruf, indem Sie seine ID angeben.
abstract boolean	stopInvocation(ITestInvocation invocation) Beenden Sie einen laufenden Aufruf.
default void	stopScheduling() Neue Tests werden nicht mehr geplant und akzeptiert, Tradefed wird aber nicht beendet.

Öffentliche Methoden

Befehl hinzufügen

public abstract Pair<Boolean, Integer> addCommand (String[] args)

Fügt dem Planer einen Befehl hinzu.

Ein Befehl ist im Wesentlichen eine Instanz einer Konfiguration, die ausgeführt werden soll, und der zugehörigen Argumente.

Wenn "--help" wird angegeben, wird der Hilfetext für die Konfiguration an stdout ausgegeben. Andernfalls wird die Konfiguration zur Ausführung der Warteschlange hinzugefügt.

Parameter
args	String: die Konfigurationsargumente

Returns
Pair<Boolean, Integer>	Ein Wertepaar. Der erste Wert ist ein boolescher Wert true, wenn der Befehl hinzugefügt wurde. erfolgreich war. Der zweite Wert ist die bekannte Befehls-Tracker-ID(nicht negativer Wert), wenn die Befehl wurde hinzugefügt; andernfalls wird 0 zurückgegeben, wenn der Befehl für alle Geräte hinzugefügt wird. -1.

Ausgabe
ConfigurationException	Befehl konnte nicht geparst werden

Weitere Informationen:

• IConfigurationFactory.createConfigurationFromArgs(String[])

addCommandFile (Befehlsdatei)

public abstract void addCommandFile (String cmdFile, 
                 extraArgs)

Fügt dem Planer alle Befehle aus der angegebenen Datei hinzu

Parameter
cmdFile	String: der Dateisystempfad der comand-Datei
extraArgs	: ERROR(/List) von String-Argumenten, die an jeden geparsten Befehl angehängt werden sollen aus Datei. Kann leer, aber nicht null sein.

Ausgabe
ConfigurationException	Befehlsdatei konnte nicht geparst werden

Weitere Informationen:

• CommandFileParser

warten

public abstract void await ()

Wartet, bis der Planer ausgeführt wird, einschließlich Warten auf den Abschluss der Übergabe der alten TF falls zutreffend.

displayCommandQueue

public abstract void displayCommandQueue (PrintWriter printWriter)

Gibt detaillierte Debug-Informationen zum Status der Warteschlange für die Befehlsausführung aus.

displayCommandsInfo

public abstract void displayCommandsInfo (PrintWriter printWriter, 
                String regex)

Gibt eine Liste der aktuellen Befehle aus.

Parameter
printWriter	PrintWriter: ERROR(/PrintWriter), in den die Ausgabe erfolgen soll.
regex	String: der reguläre Ausdruck, mit dem Befehle abgeglichen werden sollen, um gedruckt. Bei null werden alle Befehle ausgegeben.

displayInvocationsInfo

public abstract void displayInvocationsInfo (PrintWriter printWriter)

Zeigt eine Liste der aktuellen Aufrufe an.

Parameter
printWriter	PrintWriter: ERROR(/PrintWriter), in den die Ausgabe erfolgen soll.

dumpCommandsXml

public abstract void dumpCommandsXml (PrintWriter printWriter, 
                String regex)

Speichern Sie die erweiterte XML-Datei für den Befehl mit allen Option-Werte, die für alle aktuellen Befehle angegeben wurden.

Parameter
printWriter	PrintWriter: ERROR(/PrintWriter), an den der Status ausgegeben werden soll.
regex	String: der reguläre Ausdruck, mit dem Befehle in der richtigen Reihenfolge für die zu speichern. Wenn null ist, werden alle Befehle ausgegeben.

Befehl ausführen

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

Ordnet ein Gerät direkt zu und führt einen Befehl aus, ohne es der Befehlswarteschlange hinzuzufügen mit einer bereits vorhandenen IInvocationContext.

Parameter
context	IInvocationContext: eine vorhandene IInvocationContext.
listener	ICommandScheduler.IScheduledInvocationListener: die zu informierenden ICommandScheduler.IScheduledInvocationListener
args	String: die Befehlsargumente

Returns
long

Ausgabe
ConfigurationException	Befehl war ungültig
NoDeviceException	wenn kein Gerät zur Verfügung steht

Befehl ausführen

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

Ordnet ein Gerät direkt zu und führt einen Befehl aus, ohne es der Befehlswarteschlange hinzuzufügen.

Parameter
listener	ICommandScheduler.IScheduledInvocationListener: die zu informierenden ICommandScheduler.IScheduledInvocationListener
args	String: die Befehlsargumente

Returns
long	Die Aufruf-ID des geplanten Befehls.

Ausgabe
ConfigurationException	Befehl war ungültig
NoDeviceException	wenn kein Gerät zur Verfügung steht

Befehl ausführen

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

Führen Sie Befehle direkt auf bereits zugewiesenen Geräten aus.

Parameter
listener	ICommandScheduler.IScheduledInvocationListener: die zu informierenden ICommandScheduler.IScheduledInvocationListener
devices	: die zu verwendende ERROR(/List)
args	String: die Befehlsargumente

Returns
long	Die Aufruf-ID des geplanten Befehls.

Ausgabe
ConfigurationException	Befehl war ungültig

getCommandFileWatcher

public abstract CommandFileWatcher getCommandFileWatcher ()

Passenden CommandFileWatcher für diesen Planer abrufen

Returns
CommandFileWatcher

getExecutingCommandCount

public abstract int getExecutingCommandCount ()

Gibt die Anzahl der Befehle im Ausführungsstatus zurück.

Returns
int

getInvocationInfo

public abstract String getInvocationInfo (int invocationId)

Gibt die Informationen zu einem Aufruf zurück, indem die Aufruf-ID angegeben wird.

Parameter
invocationId	int: die Tracking-ID des Aufrufs.

Returns
String	Ein String mit Informationen zum Aufruf.

getLastInvocationExitCode

public abstract CommandRunner.ExitCode getLastInvocationExitCode ()

Gibt den Fehlercode des letzten ausgeführten Aufrufs zurück. Gibt 0 (kein Fehler) zurück, wenn noch kein Aufruf ausgeführt wurde.

Returns
CommandRunner.ExitCode

getLastInvocationThrowable (GetLastInvocationThrowable)

public abstract Throwable getLastInvocationThrowable ()

Gibt das Throwable des letzten ausgeführten Aufrufs zurück. Gibt null zurück, wenn kein Wurfgerät verfügbar ist.

Returns
Throwable

getReadyCommandCount (Anzahl der Bereitschaftsbefehle)

public abstract int getReadyCommandCount ()

Gibt die Anzahl der Befehle im Status „Bereit“ in der Warteschlange zurück.

Returns
int

isDeviceInvocationThread

public abstract boolean isDeviceInInvocationThread (ITestDevice device)

Gibt „true“ zurück, wenn das Gerät von einem aktiven Aufrufthread verwendet wird.

Parameter
device	ITestDevice

Returns
boolean

zu betreten

public abstract void join ()

Wartet auf den Abschluss des Planers.

Weitere Informationen:

• Thread.join()

zu betreten

public abstract void join (long millis)

Wartet auf den Abschluss des Planers oder auf das Zeitlimit nach dem angegebenen Zeitraum in Millisekunden.

Parameter
millis	long

Weitere Informationen:

• Thread.join(long)

removeAllCommands

public abstract void removeAllCommands ()

Alle Befehle aus dem Planer entfernen

SetClearcutClient

public abstract void setClearcutClient (ClearcutClient client)

Den Kunden für die Berichterstellung über die Nutzungsdaten einrichten

Parameter
client	ClearcutClient

shouldShutdownOnCmdfileError

public abstract boolean shouldShutdownOnCmdfileError ()

Gibt „true“ zurück, wenn der Planer bei einem Befehlsfehler heruntergefahren werden muss

Returns
boolean

herunterfahren

public void shutdown ()

Versuchen Sie, den Befehlsplaner ordnungsgemäß herunterzufahren.

Löscht Befehle, die zum Testen warten, und fordert an, dass alle laufenden Aufrufe beendet werden anmutig herunter.

Nach dem Herunterfahren wartet die Planer-Hauptschleife auf alle Aufrufe in noch nicht abgeschlossen ist.

herunterfahren

public abstract void shutdown (boolean notifyStop)

Versuchen Sie, den Befehlsplaner ordnungsgemäß herunterzufahren.

Parameter
notifyStop	boolean: Wenn „true“, werden Aufrufe des TF-Herunterfahrens benachrichtigt.

Herunterfahren schwierig

public abstract void shutdownHard (boolean killAdb)

Versuchen Sie, das Herunterfahren des Befehlsplaners zu erzwingen.

Ähnlich wie „shutdown()“, beendet aber optional die ADB-Verbindung in einem „Inspirieren“ laufenden -Aufrufen schneller abgeschlossen.

Parameter
killAdb	boolean

Herunterfahren schwierig

public abstract void shutdownHard ()

Versuchen Sie, das Herunterfahren des Befehlsplaners zu erzwingen. Entspricht ShutdownHard(true).

ShutdownOnEmpty

public abstract void shutdownOnEmpty ()

Ähnlich wie „shutdown()“, wird aber darauf gewartet, dass alle Befehle ausgeführt wurden bevor Sie die Seite verlassen.

Wenn sich Befehle im Schleifenmodus befinden, wird der Planer niemals beendet.

start

public abstract void start ()

Starten Sie ICommandScheduler.

Muss vor dem Aufruf anderer Methoden aufgerufen werden.

Wird ausgeführt, bis shutdown() aufgerufen wird. siehe Thread.start().

stopInvocation

public abstract boolean stopInvocation (int invocationId, 
                String cause)

Beenden Sie einen laufenden Aufruf, indem Sie seine ID angeben.

Parameter
invocationId	int: die Tracking-ID des Aufrufs.
cause	String: der Grund für das Beenden des Aufrufs.

Returns
boolean	„true“, wenn der Aufruf beendet wurde, andernfalls „false“

Ausgabe
UnsupportedOperationException	Wenn die Implementierung dies nicht unterstützt

stopInvocation

public boolean stopInvocation (int invocationId)

Beenden Sie einen laufenden Aufruf, indem Sie seine ID angeben.

Parameter
invocationId	int

Returns
boolean	„true“, wenn der Aufruf beendet wurde, andernfalls „false“

Ausgabe
UnsupportedOperationException	Wenn die Implementierung dies nicht unterstützt

stopInvocation

public abstract boolean stopInvocation (ITestInvocation invocation)

Beenden Sie einen laufenden Aufruf.

Parameter
invocation	ITestInvocation

Returns
boolean	„true“, wenn der Aufruf beendet wurde, andernfalls „false“

Ausgabe
UnsupportedOperationException	Wenn die Implementierung dies nicht unterstützt

stopScheduling

public void stopScheduling ()

Neue Tests werden nicht mehr geplant und akzeptiert, Tradefed wird aber nicht beendet. Dadurch soll die Ein Herunterfahren in zwei Schritten, bei dem zuerst alle laufenden Tests geleert und dann Tradefed beendet wird .