ICommandSchedulerICommandScheduler

public interface ICommandScheduler

com.android.tradefed.command.ICommandScheduler

Subclases indirectas conocidas ClusterCommandScheduler , CommandScheduler ClusterCommandScheduler Un ICommandScheduler para admitir TFC (Tradefed Cluster). Programador de comandos Un planificador para ejecutar comandos de TradeFederation en todos los dispositivos disponibles.

---

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 Pair <Boolean, Integer>	addCommand (String[] args) Agrega un comando al planificador.
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 de que se complete el traspaso del antiguo TF, si corresponde.
abstract void	displayCommandQueue (PrintWriter printWriter) Muestra información detallada de depuración 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 invocaciones actuales.
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.
abstract long	execCommand ( IInvocationContext context, ICommandScheduler.IScheduledInvocationListener listener, String[] args) Asigna directamente un dispositivo y ejecuta un comando sin agregarlo a la cola de comandos mediante un IInvocationContext ya existente.
abstract long	execCommand ( ICommandScheduler.IScheduledInvocationListener listener, String[] args) Asigna directamente un dispositivo y ejecuta un comando sin agregarlo a la cola de comandos.
abstract long	execCommand ( ICommandScheduler.IScheduledInvocationListener listener, devices, String[] args) execCommand ( ICommandScheduler.IScheduledInvocationListener listener, devices, String[] args) Ejecute directamente el comando en los dispositivos ya asignados.
abstract CommandFileWatcher	getCommandFileWatcher () Obtenga el CommandFileWatcher apropiado para este programador
abstract int	getExecutingCommandCount () Devuelve el número de Comandos en estado de ejecución.
abstract String	getInvocationInfo (int invocationId) Devuelve la información sobre un bu de invocación especificando el id de 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 Throwable de la última invocación que se ejecutó.
abstract int	getReadyCommandCount () Devuelve el número de Comandos en estado listo en la cola.
abstract boolean	isDeviceInInvocationThread ( ITestDevice device) Devuelve verdadero si el dispositivo es utilizado por un subproceso de invocación activo.
abstract void	join () Espera a que se complete el programador.
abstract void	join (long millis) Espera a que se complete el programador o se agote el tiempo de espera 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 informar datos de arnés
abstract boolean	shouldShutdownOnCmdfileError () Devuelve verdadero si necesitamos apagar el programador en un error de comando
default void	shutdown () Intente cerrar correctamente el programador de comandos.
abstract void	shutdown (boolean notifyStop) Intente cerrar correctamente el programador de comandos.
abstract void	shutdownHard (boolean killAdb) Intente apagar a la fuerza el programador de comandos.
abstract void	shutdownHard () Intente apagar a la fuerza el programador de comandos.
abstract void	shutdownOnEmpty () Similar a shutdown() , pero esperará a que se ejecuten todos los comandos antes de salir.
abstract void	start () Inicie ICommandScheduler .
abstract boolean	stopInvocation (int invocationId, String cause) Detenga una invocación en ejecución especificando su id.
default boolean	stopInvocation (int invocationId) Detenga una invocación en ejecución especificando su id.
abstract boolean	stopInvocation ( ITestInvocation invocation) Detener una invocación en ejecución.

Métodos públicos

añadirComando

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

Agrega un comando al planificador.

Un comando es esencialmente una instancia de una configuración para 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 ejecutarse.

Parámetros
args	String : los argumentos de configuración.

Devoluciones
Pair <Boolean, Integer>	Un par de valores, el primer valor es un booleano true si el comando se agregó correctamente. El segundo valor es la identificación del rastreador de comandos conocido (valor no negativo) si el comando se agregó correctamente, devuelve 0 cuando se agrega el comando para todos los dispositivos; de lo contrario, -1.

Lanza
ConfigurationException	si el comando no se pudo analizar

Ver también:

• IConfigurationFactory.createConfigurationFromArgs(String[])

añadirCommandFile

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	: un 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:

• CommandFileParser

esperar

public abstract void await ()

Espera a que el programador comience a ejecutarse, incluida la espera de que se complete el traspaso del antiguo TF, si corresponde.

mostrarCommandQueue

public abstract void displayCommandQueue (PrintWriter printWriter)

Muestra información detallada de depuración sobre el estado de la cola de ejecución de comandos.

mostrarCommandsInfo

public abstract void displayCommandsInfo (PrintWriter printWriter, 
                String regex)

Muestra una lista de los comandos actuales.

Parámetros
printWriter	PrintWriter : el ERROR(/PrintWriter) a la salida.
regex	String : la expresión regular con la que deben coincidir los comandos para que se impriman. 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) a la salida.

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) para enviar el estado.
regex	String : la expresión regular con la que se deben hacer coincidir los comandos para que se descargue el archivo xml. Si es nulo, se volcarán todos los comandos.

comandoejecutivo

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

Asigna directamente un dispositivo y ejecuta un comando sin agregarlo a la cola de comandos mediante un IInvocationContext ya existente.

Parámetros
context	IInvocationContext : un IInvocationContext existente.
listener	ICommandScheduler.IScheduledInvocationListener : el ICommandScheduler.IScheduledInvocationListener para ser informado
args	String : los argumentos del comando

Devoluciones
long

Lanza
ConfigurationException	si el comando no es válido
NoDeviceException	si no hay ningún dispositivo para usar

comandoejecutivo

public abstract long 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 para ser informado
args	String : los argumentos del comando

Devoluciones
long	El id de invocación del comando programado.

Lanza
ConfigurationException	si el comando no es válido
NoDeviceException	si no hay ningún dispositivo para usar

comandoejecutivo

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

Ejecute directamente el comando en los dispositivos ya asignados.

Parámetros
listener	ICommandScheduler.IScheduledInvocationListener : el ICommandScheduler.IScheduledInvocationListener para ser informado
devices	: el ERROR(/List ) ERROR(/List ) para usar
args	String : los argumentos del comando

Devoluciones
long	El id de invocación del comando programado.

Lanza
ConfigurationException	si el comando no es válido

getCommandFileWatcher

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

obtenerInvocaciónInformación

public abstract String getInvocationInfo (int invocationId)

Devuelve la información sobre un bu de invocación especificando el id de invocación.

Parámetros
invocationId	int : el id de seguimiento de la invocación.

Devoluciones
String	Una String que contiene información sobre la invocación.

getLastInvocationExitCode

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ó. Retorna nulo, si no hay disponible un arrojable.

Devoluciones
Throwable

getReadyCommandCount

public abstract int getReadyCommandCount ()

Devuelve el número de Comandos en estado listo en la cola.

Devoluciones
int

isDeviceInInvocationThread

public abstract boolean isDeviceInInvocationThread (ITestDevice device)

Devuelve verdadero si el dispositivo es utilizado por un subproceso de invocación activo.

Parámetros
device	ITestDevice

Devoluciones
boolean

unirse

public abstract void join ()

Espera a que se complete el programador.

Ver también:

• Thread.join()

unirse

public abstract void join (long millis)

Espera a que se complete el programador o se agote el tiempo de espera después de la duración especificada en milisegundos.

Parámetros
millis	long

Ver también:

• Thread.join(long)

removeAllCommands

public abstract void removeAllCommands ()

Eliminar todos los comandos del programador

establecerClearcutClient

public abstract void setClearcutClient (ClearcutClient client)

Configurar el cliente para informar datos de arnés

Parámetros
client	ClearcutClient

deberíaShutdownOnCmdfileError

public abstract boolean shouldShutdownOnCmdfileError ()

Devuelve verdadero si necesitamos apagar el programador en un error de comando

Devoluciones
boolean

cerrar

public void shutdown ()

Intente cerrar correctamente el programador de comandos.

Borra los comandos que esperan 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.

cerrar

public abstract void shutdown (boolean notifyStop)

Intente cerrar correctamente el programador de comandos.

Parámetros
notifyStop	boolean : si es verdadero, notifica las invocaciones del apagado de TF.

apagar duro

public abstract void shutdownHard (boolean killAdb)

Intente apagar a la fuerza el programador de comandos.

Similar a shutdown() , pero opcionalmente también eliminará la conexión adb, en un intento de 'inspirar' las invocaciones en curso para que se completen más rápido.

Parámetros
killAdb	boolean

apagar duro

public abstract void shutdownHard ()

Intente apagar a la fuerza el programador de comandos. Igual que shutdownHard (verdadero).

apagado en vacío

public abstract void shutdownOnEmpty ()

Similar a shutdown() , pero esperará a que se ejecuten todos los comandos antes de salir.

Tenga en cuenta que si algún comando está en modo de bucle, el planificador nunca se cerrará.

comenzar

public abstract void start ()

Inicie ICommandScheduler .

Debe llamarse antes de llamar a otros métodos.

Se ejecutará hasta que se llame shutdown() . ver Thread.start() .

detenerInvocación

public abstract boolean stopInvocation (int invocationId, 
                String cause)

Detenga una invocación en ejecución especificando su id.

Parámetros
invocationId	int : el id de seguimiento de la invocación.
cause	String : la causa para detener la invocación.

Devoluciones
boolean	verdadero si se detuvo la invocación, falso de lo contrario

Lanza
UnsupportedOperationException	si la implementación no es compatible con esto

detenerInvocación

public boolean stopInvocation (int invocationId)

Detenga una invocación en ejecución especificando su id.

Parámetros
invocationId	int

Devoluciones
boolean	verdadero si se detuvo la invocación, falso de lo contrario

Lanza
UnsupportedOperationException	si la implementación no es compatible con 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 de lo contrario

Lanza
UnsupportedOperationException	si la implementación no es compatible con esto