ICommandScheduler
public
interface
ICommandScheduler
com.android.tradefed.command.ICommandScheduler |
Un programador para ejecutar comandos de TradeFederation.
Resumen
Clases anidadas | |
---|---|
interface |
ICommandScheduler.IScheduledInvocationListener
Objeto de escucha para eventos de invocación cuando se completa la invocación. |
Métodos públicos | |
---|---|
abstract
boolean
|
addCommand(String[] args)
Agrega un comando al programador. |
abstract
void
|
addCommandFile(String cmdFile,
Agrega todos los comandos del archivo determinado al programador. |
abstract
void
|
await()
Espera a que el programador comience a ejecutarse, lo que incluye esperar a que se complete la entrega de la TF anterior, si corresponde. |
abstract
void
|
completeHandover()
Informa al programador de comandos que una secuencia de transferencia iniciada está completa y que debe volver a inicializar su administrador remoto en el puerto predeterminado. |
abstract
void
|
displayCommandQueue(PrintWriter printWriter)
Muestra información de depuración detallada sobre el estado de la cola de ejecución de comandos. |
abstract
void
|
displayCommandsInfo(PrintWriter printWriter, String regex)
Muestra una lista de los comandos actuales. |
abstract
void
|
displayInvocationsInfo(PrintWriter printWriter)
Muestra una lista de las invocaciones actuales. |
abstract
void
|
dumpCommandsXml(PrintWriter printWriter, String regex)
Vacía el archivo en formato XML expandido del comando con todos los valores de |
abstract
void
|
execCommand(IInvocationContext context, ICommandScheduler.IScheduledInvocationListener listener, String[] args)
Aloca directamente un dispositivo y ejecuta un comando sin agregarlo a la cola de comandos con un |
abstract
void
|
execCommand(ICommandScheduler.IScheduledInvocationListener listener, String[] args)
Asignar directamente un dispositivo y ejecutar un comando sin agregarlo a la cola de comandos |
abstract
void
|
execCommand(ICommandScheduler.IScheduledInvocationListener listener, ITestDevice device, String[] args)
Ejecuta el comando directamente en el dispositivo ya asignado. |
abstract
CommandFileWatcher
|
getCommandFileWatcher()
Obtén el |
abstract
int
|
getExecutingCommandCount()
Muestra la cantidad de comandos en estado de ejecución. |
abstract
String
|
getInvocationInfo(int invocationId)
Muestra la información de una invocación especificando el ID de invocación. |
abstract
CommandRunner.ExitCode
|
getLastInvocationExitCode()
Muestra el código de error de la última invocación que se ejecutó. |
abstract
Throwable
|
getLastInvocationThrowable()
Muestra el |
abstract
int
|
getReadyCommandCount()
Muestra la cantidad de comandos en estado listo en la cola. |
abstract
void
|
handoverInitiationComplete()
Informa al programador de comandos que se completó el intercambio inicial de entrega de dispositivos y comandos en uso, y que puede comenzar a programar la operación. |
abstract
boolean
|
handoverShutdown(int handoverPort)
Inicia un |
abstract
void
|
join()
Espera a que se complete el programador. |
abstract
void
|
join(long millis)
Espera a que se complete el programador o que se agote el tiempo de espera después de la duración especificada en milisegundos. |
abstract
void
|
removeAllCommands()
Quita todos los comandos del programador |
abstract
void
|
setClearcutClient(ClearcutClient client)
Configura el cliente para que informe datos del arnés |
abstract
boolean
|
shouldShutdownOnCmdfileError()
Muestra verdadero si necesitamos cerrar el programador en un error de comando. |
abstract
void
|
shutdown()
Intenta cerrar el programador de comandos de forma ordenada. |
abstract
void
|
shutdownHard(boolean killAdb)
Intenta cerrar de manera forzosa el programador de comandos. |
abstract
void
|
shutdownHard()
Intenta cerrar de manera forzosa el programador de comandos. |
abstract
void
|
shutdownOnEmpty()
Es similar a |
abstract
void
|
start()
Inicia |
abstract
boolean
|
stopInvocation(int invocationId, String cause)
Para detener una invocación en ejecución, especifica su ID. |
default
boolean
|
stopInvocation(int invocationId)
Para detener una invocación en ejecución, especifica su ID. |
abstract
boolean
|
stopInvocation(ITestInvocation invocation)
Detener una invocación en ejecución |
Métodos públicos
addCommand
public abstract boolean addCommand (String[] args)
Agrega un comando al programador.
Un comando es, en esencia, una instancia de una configuración para ejecutar y sus argumentos asociados.
Si se especifica el argumento “--help”, el texto de ayuda de la configuración se enviará a stdout. De lo contrario, la configuración se agregará a la cola para que se ejecute.
Parámetros | |
---|---|
args |
String : Los argumentos de configuración. |
Muestra | |
---|---|
boolean |
true si el comando se agregó correctamente |
Arroja | |
---|---|
ConfigurationException |
Si no se pudo analizar el comando |
addCommandFile
public abstract void addCommandFile (String cmdFile,extraArgs)
Agrega todos los comandos del archivo determinado al programador.
Parámetros | |
---|---|
cmdFile |
String : Es la ruta de acceso del sistema de archivos del archivo de comandos. |
extraArgs |
: Es un ERROR(/List) de argumentos String que se agregarán a cada comando analizado del archivo. Puede estar vacío, pero no debe ser nulo. |
Arroja | |
---|---|
ConfigurationException |
Si no se pudo analizar el archivo de comandos |
También:
await
public abstract void await ()
Espera a que el programador comience a ejecutarse, lo que incluye esperar a que se complete la entrega de la TF anterior, si corresponde.
completeHandover
public abstract void completeHandover ()
Informa al programador de comandos que una secuencia de transferencia iniciada está completa y que debe volver a inicializar su administrador remoto en el puerto predeterminado.
displayCommandQueue
public abstract void displayCommandQueue (PrintWriter printWriter)
Muestra información de depuración detallada sobre el estado de la cola de ejecución de comandos.
displayCommandsInfo
public abstract void displayCommandsInfo (PrintWriter printWriter, String regex)
Muestra una lista de los comandos actuales.
Parámetros | |
---|---|
printWriter |
PrintWriter : Es el ERROR(/PrintWriter) al que se enviará el resultado. |
regex |
String : Es la expresión regular con la que deben coincidir los comandos para que se impriman. Si es nulo, se imprimirán todos los comandos.
|
displayInvocationsInfo
public abstract void displayInvocationsInfo (PrintWriter printWriter)
Muestra una lista de las invocaciones actuales.
Parámetros | |
---|---|
printWriter |
PrintWriter : Es el ERROR(/PrintWriter) al que se enviará el resultado.
|
dumpCommandsXml
public abstract void dumpCommandsXml (PrintWriter printWriter, String regex)
Vacía el archivo en formato XML expandido del comando con todos los valores de Option
especificados para todos los comandos actuales.
Parámetros | |
---|---|
printWriter |
PrintWriter : Es el ERROR(/PrintWriter) al que se enviará el estado. |
regex |
String : Es la expresión regular con la que deben coincidir los comandos para que se volque el archivo en formato XML. Si es nulo, se volcarán todos los comandos.
|
execCommand
public abstract void execCommand (IInvocationContext context, ICommandScheduler.IScheduledInvocationListener listener, String[] args)
Aloca directamente un dispositivo y ejecuta un comando sin agregarlo a la cola de comandos con un IInvocationContext
ya existente.
Parámetros | |
---|---|
context |
IInvocationContext : Un IInvocationContext existente. |
listener |
ICommandScheduler.IScheduledInvocationListener : Es el ICommandScheduler.IScheduledInvocationListener que se informará. |
args |
String : Los argumentos del comando |
Arroja | |
---|---|
ConfigurationException |
si el comando no era válido |
NoDeviceException |
si no hay ningún dispositivo para usar |
execCommand
public abstract void execCommand (ICommandScheduler.IScheduledInvocationListener listener, String[] args)
Asignar directamente un dispositivo y ejecutar un comando sin agregarlo a la cola de comandos
Parámetros | |
---|---|
listener |
ICommandScheduler.IScheduledInvocationListener : Es el ICommandScheduler.IScheduledInvocationListener que se informará. |
args |
String : Los argumentos del comando |
Arroja | |
---|---|
ConfigurationException |
si el comando no era válido |
NoDeviceException |
si no hay ningún dispositivo para usar |
execCommand
public abstract void execCommand (ICommandScheduler.IScheduledInvocationListener listener, ITestDevice device, String[] args)
Ejecuta el comando directamente en el dispositivo ya asignado.
Parámetros | |
---|---|
listener |
ICommandScheduler.IScheduledInvocationListener : Es el ICommandScheduler.IScheduledInvocationListener que se informará. |
device |
ITestDevice : Es el ITestDevice que se usará. |
args |
String : Los argumentos del comando |
Arroja | |
---|---|
ConfigurationException |
si el comando no era válido |
getCommandFileWatcher
public abstract CommandFileWatcher getCommandFileWatcher ()
Obtén el CommandFileWatcher
adecuado para este programador
Muestra | |
---|---|
CommandFileWatcher |
getExecutingCommandCount
public abstract int getExecutingCommandCount ()
Muestra la cantidad de comandos en estado de ejecución.
Muestra | |
---|---|
int |
getInvocationInfo
public abstract String getInvocationInfo (int invocationId)
Muestra la información de una invocación especificando el ID de invocación.
Parámetros | |
---|---|
invocationId |
int : El ID de seguimiento de la invocación. |
Muestra | |
---|---|
String |
Un String que contiene información sobre la invocación.
|
getLastInvocationExitCode
public abstract CommandRunner.ExitCode getLastInvocationExitCode ()
Muestra el código de error de la última invocación que se ejecutó. Devuelve 0 (sin errores) si aún no se ejecutó ninguna invocación.
Muestra | |
---|---|
CommandRunner.ExitCode |
getLastInvocationThrowable
public abstract Throwable getLastInvocationThrowable ()
Muestra el Throwable
de la última invocación que se ejecutó.
Muestra un valor nulo si no hay un elemento throwable disponible.
Muestra | |
---|---|
Throwable |
getReadyCommandCount
public abstract int getReadyCommandCount ()
Muestra la cantidad de comandos en estado listo en la cola.
Muestra | |
---|---|
int |
handoverInitiationComplete
public abstract void handoverInitiationComplete ()
Informa al programador de comandos que se completó el intercambio inicial de entrega de dispositivos y comandos en uso, y que puede comenzar a programar la operación.
handoverShutdown
public abstract boolean handoverShutdown (int handoverPort)
Inicia un shutdown()
y lo entrega a otro proceso de Tradefed en este mismo host.
El programador informará al proceso de tradefed remoto que escucha en ese puerto los dispositivos liberados a medida que estén disponibles.
Parámetros | |
---|---|
handoverPort |
int |
Muestra | |
---|---|
boolean |
true si la iniciación de la entrega se realizó correctamente, false de lo contrario
|
join
public abstract void join (long millis)
Espera a que se complete el programador o que se agote el tiempo de espera después de la duración especificada en milisegundos.
Parámetros | |
---|---|
millis |
long |
También:
removeAllCommands
public abstract void removeAllCommands ()
Quita todos los comandos del programador
setClearcutClient
public abstract void setClearcutClient (ClearcutClient client)
Configura el cliente para que informe datos del arnés
Parámetros | |
---|---|
client |
ClearcutClient |
shouldShutdownOnCmdfileError
public abstract boolean shouldShutdownOnCmdfileError ()
Muestra verdadero si necesitamos cerrar el programador en un error de comando.
Muestra | |
---|---|
boolean |
apagado
public abstract void shutdown ()
Intenta cerrar el programador de comandos de forma ordenada.
Borra los comandos que esperan a que se prueben y solicita que todas las invocaciones en curso se cierren de forma correcta.
Después de llamar a shutdown, el bucle principal del programador esperará a que se completen todas las invocaciones en curso antes de salir por completo.
shutdownHard
public abstract void shutdownHard (boolean killAdb)
Intenta cerrar de manera forzosa el programador de comandos.
Es similar a shutdown()
, pero también finalizará, de manera opcional, la conexión adb, en un intento por "inspirar" a las invocaciones en curso para que se completen más rápido.
Parámetros | |
---|---|
killAdb |
boolean |
shutdownHard
public abstract void shutdownHard ()
Intenta cerrar de manera forzosa el programador de comandos. Igual que shutdownHard(true).
shutdownOnEmpty
public abstract void shutdownOnEmpty ()
Es similar a shutdown()
, pero esperará a que se ejecuten todos los comandos antes de salir.
Ten en cuenta que, si algún comando está en modo de bucle, el programador nunca finalizará.
start
public abstract void start ()
Inicia ICommandScheduler
.
Se debe llamar antes de llamar a otros métodos.
Se ejecutará hasta que se llame a shutdown()
.
Consulta Thread.start()
.
stopInvocation
public abstract boolean stopInvocation (int invocationId, String cause)
Para detener una invocación en ejecución, especifica su ID.
Parámetros | |
---|---|
invocationId |
int : El ID de seguimiento de la invocación. |
cause |
String : Es la causa por la que se detuvo la invocación. |
Muestra | |
---|---|
boolean |
Es verdadero si se detuvo la invocación; de lo contrario, es falso. |
Arroja | |
---|---|
UnsupportedOperationException |
si la implementación no lo admite |
stopInvocation
public boolean stopInvocation (int invocationId)
Para detener una invocación en ejecución, especifica su ID.
Parámetros | |
---|---|
invocationId |
int |
Muestra | |
---|---|
boolean |
Es verdadero si se detuvo la invocación; de lo contrario, es falso. |
Arroja | |
---|---|
UnsupportedOperationException |
si la implementación no lo admite |
stopInvocation
public abstract boolean stopInvocation (ITestInvocation invocation)
Detener una invocación en ejecución
Parámetros | |
---|---|
invocation |
ITestInvocation |
Muestra | |
---|---|
boolean |
Es verdadero si se detuvo la invocación; de lo contrario, es falso. |
Arroja | |
---|---|
UnsupportedOperationException |
si la implementación no lo admite |