ICommandScheduler
public interface ICommandScheduler
com.android.tradefed.command.ICommandScheduler |
Un programador para ejecutar comandos de TradeFederation.
Resumen
clases anidadas | |
---|---|
interface | ICommandScheduler.IScheduledInvocationListener Escucha de 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, extraArgs) addCommandFile (String cmdFile, extraArgs) Agrega todos los comandos del archivo dado al programador |
abstract void | await () Espera a que el programador comience a ejecutarse, incluida la espera a que se complete la transferencia del TF anterior, si corresponde. |
abstract void | completeHandover () Informa al programador de comandos que una secuencia de transferencia iniciada está completamente completa y que debe reinicializar su administrador remoto en el puerto predeterminado. |
abstract void | displayCommandQueue (PrintWriter printWriter) Genera información de depuración detallada sobre el estado de la cola de ejecución de comandos. |
abstract void | displayCommandsInfo (PrintWriter printWriter, String regex) Genera una lista de comandos actuales. |
abstract void | displayInvocationsInfo (PrintWriter printWriter) Muestra una lista de invocaciones actuales. |
abstract void | dumpCommandsXml (PrintWriter printWriter, String regex) Vuelque el archivo xml expandido para el comando con todos los valores |
abstract void | execCommand (IInvocationContext context, ICommandScheduler.IScheduledInvocationListener listener, String[] args) Asigna directamente un dispositivo y ejecuta un comando sin agregarlo a la cola de comandos utilizando un |
abstract void | execCommand ( ICommandScheduler.IScheduledInvocationListener listener, String[] args) Asigna directamente un dispositivo y ejecuta un comando sin agregarlo a la cola de comandos. |
abstract void | execCommand ( ICommandScheduler.IScheduledInvocationListener listener, ITestDevice device, String[] args) Ejecute directamente el comando en el dispositivo ya asignado. |
abstract CommandFileWatcher | getCommandFileWatcher () Obtenga el |
abstract int | getExecutingCommandCount () Devuelve el número de comandos en estado de ejecución. |
abstract String | getInvocationInfo (int invocationId) Devuelve la información sobre una invocación bu especificando la identificación de la invocación. |
abstract CommandRunner.ExitCode | getLastInvocationExitCode () Devuelve el código de error de la última invocación que se ejecutó. |
abstract Throwable | getLastInvocationThrowable () Devuelve el |
abstract int | getReadyCommandCount () Devuelve el número de comandos en estado listo en la cola. |
abstract void | handoverInitiationComplete () Informa al programador de comandos que el intercambio de transferencia inicial de dispositivos y comandos en uso está completo 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 el programador se complete o expire después de la duración especificada en milisegundos. |
abstract void | removeAllCommands () Eliminar todos los comandos del programador |
abstract void | setClearcutClient (ClearcutClient client) Configurar el cliente para que informe los datos del arnés |
abstract boolean | shouldShutdownOnCmdfileError () Devuelve verdadero si necesitamos apagar el programador debido a un error de comando |
abstract void | shutdown () Intente cerrar correctamente el programador de comandos. |
abstract void | shutdownHard (boolean killAdb) Intente cerrar por la fuerza el programador de comandos. |
abstract void | shutdownHard () Intente cerrar por la fuerza el programador de comandos. |
abstract void | shutdownOnEmpty () Similar a |
abstract void | start () Inicie |
abstract boolean | stopInvocation (int invocationId, String cause) Detenga una invocación en ejecución especificando su identificación. |
default boolean | stopInvocation (int invocationId) Detenga una invocación en ejecución especificando su identificación. |
abstract boolean | stopInvocation ( ITestInvocation invocation) Detener una invocación en ejecución. |
Métodos públicos
agregarcomando
public abstract boolean addCommand (String[] args)
Agrega un comando al programador.
Un comando es esencialmente una instancia de una configuración a ejecutar y sus argumentos asociados. Si se especifica el argumento "--help", el texto de ayuda para la configuración se enviará a la salida estándar. De lo contrario, la configuración se agregará a la cola para ejecutar.Parámetros | |
---|---|
args | String : los argumentos de configuración. |
Devoluciones | |
---|---|
boolean | true si el comando se agregó correctamente |
Lanza | |
---|---|
ConfigurationException | si el comando no se pudo analizar |
agregar archivo de comando
public abstract void addCommandFile (String cmdFile,extraArgs)
Agrega todos los comandos del archivo dado al programador
Parámetros | |
---|---|
cmdFile | String : la ruta del sistema de archivos del archivo de comando |
extraArgs | ERROR(/List) de argumentos String para agregar a cada comando analizado desde el archivo. Puede estar vacío pero no debe ser nulo. |
Lanza | |
---|---|
ConfigurationException | si el archivo de comando no se pudo analizar |
Ver también:
esperar
public abstract void await ()
Espera a que el programador comience a ejecutarse, incluida la espera a que se complete la transferencia del TF anterior, si corresponde.
entrega completa
public abstract void completeHandover ()
Informa al programador de comandos que una secuencia de transferencia iniciada está completamente completa y que debe reinicializar su administrador remoto en el puerto predeterminado.
mostrarCommandQueue
public abstract void displayCommandQueue (PrintWriter printWriter)
Genera información de depuración detallada sobre el estado de la cola de ejecución de comandos.
mostrarComandosInfo
public abstract void displayCommandsInfo (PrintWriter printWriter, String regex)
Genera una lista de comandos actuales.
Parámetros | |
---|---|
printWriter | PrintWriter : el ERROR(/PrintWriter) al que enviar. |
regex | String : la expresión regular con la que se deben hacer coincidir los comandos para poder imprimirlos. Si es nulo, se imprimirán todos los comandos. |
mostrarInvocacionesInfo
public abstract void displayInvocationsInfo (PrintWriter printWriter)
Muestra una lista de invocaciones actuales.
Parámetros | |
---|---|
printWriter | PrintWriter : el ERROR(/PrintWriter) al que enviar. |
dumpCommandsXml
public abstract void dumpCommandsXml (PrintWriter printWriter, String regex)
Vuelque el archivo xml expandido para el comando con todos los valores Option
especificados para todos los comandos actuales.
Parámetros | |
---|---|
printWriter | PrintWriter : el ERROR(/PrintWriter) al que enviar el estado. |
regex | String : la expresión regular con la que se deben hacer coincidir los comandos para que se volque el archivo xml. Si es nulo, se volcarán todos los comandos. |
comando ejecutivo
public abstract void execCommand (IInvocationContext context, ICommandScheduler.IScheduledInvocationListener listener, String[] args)
Asigna directamente un dispositivo y ejecuta un comando sin agregarlo a la cola de comandos utilizando un IInvocationContext
ya existente.
Parámetros | |
---|---|
context | IInvocationContext : un IInvocationContext existente. |
listener | ICommandScheduler.IScheduledInvocationListener : el ICommandScheduler.IScheduledInvocationListener que debe ser informado |
args | String : los argumentos del comando. |
Lanza | |
---|---|
ConfigurationException | si el comando no era válido |
NoDeviceException | si no hay ningún dispositivo para usar |
comando ejecutivo
public abstract void execCommand (ICommandScheduler.IScheduledInvocationListener listener, String[] args)
Asigna directamente un dispositivo y ejecuta un comando sin agregarlo a la cola de comandos.
Parámetros | |
---|---|
listener | ICommandScheduler.IScheduledInvocationListener : el ICommandScheduler.IScheduledInvocationListener que debe ser informado |
args | String : los argumentos del comando. |
Lanza | |
---|---|
ConfigurationException | si el comando no era válido |
NoDeviceException | si no hay ningún dispositivo para usar |
comando ejecutivo
public abstract void execCommand (ICommandScheduler.IScheduledInvocationListener listener, ITestDevice device, String[] args)
Ejecute directamente el comando en el dispositivo ya asignado.
Parámetros | |
---|---|
listener | ICommandScheduler.IScheduledInvocationListener : el ICommandScheduler.IScheduledInvocationListener que debe ser informado |
device | ITestDevice : el ITestDevice a utilizar |
args | String : los argumentos del comando. |
Lanza | |
---|---|
ConfigurationException | si el comando no era válido |
obtenerCommandFileWatcher
public abstract CommandFileWatcher getCommandFileWatcher ()
Obtenga el CommandFileWatcher
apropiado para este programador
Devoluciones | |
---|---|
CommandFileWatcher |
getExecutingCommandCount
public abstract int getExecutingCommandCount ()
Devuelve el número de comandos en estado de ejecución.
Devoluciones | |
---|---|
int |
obtener información de invocación
public abstract String getInvocationInfo (int invocationId)
Devuelve la información sobre una invocación bu especificando la identificación de la invocación.
Parámetros | |
---|---|
invocationId | int : la identificación de seguimiento de la invocación. |
Devoluciones | |
---|---|
String | Una String que contiene información sobre la invocación. |
obtenerÚltimoCódigo de Salida de Invocación
public abstract CommandRunner.ExitCode getLastInvocationExitCode ()
Devuelve el código de error de la última invocación que se ejecutó. Devuelve 0 (sin error), si aún no se ha ejecutado ninguna invocación.
Devoluciones | |
---|---|
CommandRunner.ExitCode |
getLastInvocationThrowable
public abstract Throwable getLastInvocationThrowable ()
Devuelve el Throwable
de la última invocación que se ejecutó. Devuelve nulo, si no hay ningún elemento arrojable disponible.
Devoluciones | |
---|---|
Throwable |
getReadyCommandCount
public abstract int getReadyCommandCount ()
Devuelve el número de comandos en estado listo en la cola.
Devoluciones | |
---|---|
int |
traspasoIniciaciónCompletar
public abstract void handoverInitiationComplete ()
Informa al programador de comandos que el intercambio de transferencia inicial de dispositivos y comandos en uso está completo y que puede comenzar a programar la operación.
entregaApagar
public abstract boolean handoverShutdown (int handoverPort)
Inicia un shutdown()
y un traspaso a otro proceso alimentado por comercio en este mismo host.
Parámetros | |
---|---|
handoverPort | int |
Devoluciones | |
---|---|
boolean | true si el inicio de la transferencia fue exitoso; false en caso contrario |
unirse
public abstract void join ()
Espera a que se complete el programador.
Ver también:
unirse
public abstract void join (long millis)
Espera a que el programador se complete o expire después de la duración especificada en milisegundos.
Parámetros | |
---|---|
millis | long |
Ver también:
eliminar todos los comandos
public abstract void removeAllCommands ()
Eliminar todos los comandos del programador
setClearcutCliente
public abstract void setClearcutClient (ClearcutClient client)
Configurar el cliente para que informe los datos del arnés
Parámetros | |
---|---|
client | ClearcutClient |
deberíaShutdownOnCmdfileError
public abstract boolean shouldShutdownOnCmdfileError ()
Devuelve verdadero si necesitamos apagar el programador debido a un error de comando
Devoluciones | |
---|---|
boolean |
cerrar
public abstract void shutdown ()
Intente cerrar correctamente el programador de comandos.
Borra los comandos en espera de ser probados y solicita que todas las invocaciones en curso se cierren correctamente. Después de llamar al apagado, el bucle principal del programador esperará a que se completen todas las invocaciones en curso antes de salir por completo.apagadoDifícil
public abstract void shutdownHard (boolean killAdb)
Intente cerrar por la fuerza el programador de comandos.
Similar a shutdown()
, pero opcionalmente también cancelará la conexión adb, en un intento de "inspirar" las invocaciones en progreso para que se completen más rápido.
Parámetros | |
---|---|
killAdb | boolean |
apagadoDifícil
public abstract void shutdownHard ()
Intente cerrar por la fuerza el programador de comandos. Igual que ShutdownHard (verdadero).
apagadoOnEmpty
public abstract void shutdownOnEmpty ()
Similar a shutdown()
, pero esperará a que se ejecuten todos los comandos antes de salir.
comenzar
public abstract void start ()
Inicie ICommandScheduler
.
shutdown()
. ver Thread.start()
. detenerInvocación
public abstract boolean stopInvocation (int invocationId, String cause)
Detenga una invocación en ejecución especificando su identificación.
Parámetros | |
---|---|
invocationId | int : la identificación de seguimiento de la invocación. |
cause | String : la causa por la que se detuvo la invocación. |
Devoluciones | |
---|---|
boolean | Verdadero si se detuvo la invocación, falso en caso contrario. |
Lanza | |
---|---|
UnsupportedOperationException | si la implementación no soporta esto |
detenerInvocación
public boolean stopInvocation (int invocationId)
Detenga una invocación en ejecución especificando su identificación.
Parámetros | |
---|---|
invocationId | int |
Devoluciones | |
---|---|
boolean | Verdadero si se detuvo la invocación, falso en caso contrario. |
Lanza | |
---|---|
UnsupportedOperationException | si la implementación no soporta esto |
detenerInvocación
public abstract boolean stopInvocation (ITestInvocation invocation)
Detener una invocación en ejecución.
Parámetros | |
---|---|
invocation | ITestInvocation |
Devoluciones | |
---|---|
boolean | Verdadero si se detuvo la invocación, falso en caso contrario. |
Lanza | |
---|---|
UnsupportedOperationException | si la implementación no soporta esto |
El contenido y el código de ejemplo de esta página están sujetos a las licencias que se describen en la licencia de contenido. Java y OpenJDK son marcas registradas de Oracle o sus entidades asociadas.
Última actualización: 2023-12-01 (UTC).