ICommandScheduler

public interface ICommandScheduler

com.android.tradefed.command.ICommandScheduler

Subclasses indiretas conhecidas ClusterCommandScheduler , CommandScheduler ClusterCommandScheduler Um ICommandScheduler para dar suporte a TFC (Cluster Tradefed). CommandScheduler Um agendador para executar comandos TradeFederation em todos os dispositivos disponíveis.

---

Um planejador para executar comandos TradeFederation.

Resumo

Classes aninhadas
interface	ICommandScheduler.IScheduledInvocationListener Ouvinte para eventos de invocação quando a invocação é concluída.

Métodos públicos
abstract Pair <Boolean, Integer>	addCommand (String[] args) Adiciona um comando ao agendador.
abstract void	addCommandFile (String cmdFile, extraArgs) addCommandFile (String cmdFile, extraArgs) Adiciona todos os comandos de determinado arquivo ao agendador
abstract void	await () Aguarda o início da execução do agendador, incluindo a conclusão da transferência do TF antigo, se aplicável.
abstract void	displayCommandQueue (PrintWriter printWriter) Saída de informações de depuração detalhadas sobre o estado da fila de execução do comando.
abstract void	displayCommandsInfo (PrintWriter printWriter, String regex) Saída de uma lista de comandos atuais.
abstract void	displayInvocationsInfo (PrintWriter printWriter) Exibe uma lista de invocações atuais.
abstract void	dumpCommandsXml (PrintWriter printWriter, String regex) Despeje o arquivo xml expandido para o comando com todos os valores Option especificados para todos os comandos atuais.
abstract long	execCommand ( IInvocationContext context, ICommandScheduler.IScheduledInvocationListener listener, String[] args) Aloca diretamente um dispositivo e executa um comando sem adicioná-lo à fila de comandos usando um IInvocationContext já existente.
abstract long	execCommand ( ICommandScheduler.IScheduledInvocationListener listener, String[] args) Aloca diretamente um dispositivo e executa um comando sem adicioná-lo à fila de comandos.
abstract long	execCommand ( ICommandScheduler.IScheduledInvocationListener listener, devices, String[] args) execCommand ( ICommandScheduler.IScheduledInvocationListener listener, devices, String[] args) Execute o comando diretamente em dispositivos já alocados.
abstract CommandFileWatcher	getCommandFileWatcher () Obtenha o CommandFileWatcher apropriado para este agendador
abstract int	getExecutingCommandCount () Retorna o número de Comandos em estado de execução.
abstract String	getInvocationInfo (int invocationId) Retorne as informações sobre uma invocação especificando o ID da invocação.
abstract CommandRunner.ExitCode	getLastInvocationExitCode () Retorna o código de erro da última chamada executada.
abstract Throwable	getLastInvocationThrowable () Retorne o Throwable da última invocação executada.
abstract int	getReadyCommandCount () Retorna o número de Comandos em estado pronto na fila.
abstract boolean	isDeviceInInvocationThread ( ITestDevice device) Retorna true se o dispositivo for usado por um thread de invocação ativo.
abstract void	join () Aguarda a conclusão do agendador.
abstract void	join (long millis) Aguarda a conclusão do agendador ou o tempo limite após a duração especificada em milissegundos.
abstract void	removeAllCommands () Remova todos os comandos do agendador
abstract void	setClearcutClient (ClearcutClient client) Defina o cliente para relatar dados de chicote
abstract boolean	shouldShutdownOnCmdfileError () Retorne verdadeiro se precisarmos desligar o agendador em um erro de comando
default void	shutdown () Tente desligar normalmente o agendador de comandos.
abstract void	shutdown (boolean notifyStop) Tente desligar normalmente o agendador de comandos.
abstract void	shutdownHard (boolean killAdb) Tente encerrar à força o agendador de comandos.
abstract void	shutdownHard () Tente encerrar à força o agendador de comandos.
abstract void	shutdownOnEmpty () Semelhante a shutdown() , mas, em vez disso, aguardará que todos os comandos sejam executados antes de sair.
abstract void	start () Inicie o ICommandScheduler .
abstract boolean	stopInvocation (int invocationId, String cause) Interrompa uma chamada em execução especificando seu id.
default boolean	stopInvocation (int invocationId) Interrompa uma chamada em execução especificando seu id.
abstract boolean	stopInvocation ( ITestInvocation invocation) Interrompa uma chamada em execução.

Métodos públicos

addCommand

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

Adiciona um comando ao agendador.

Um comando é essencialmente uma instância de uma configuração a ser executada e seus argumentos associados.

Se o argumento "--help" for especificado, o texto de ajuda para a configuração será enviado para stdout. Caso contrário, a configuração será adicionada à fila para execução.

Parâmetros
args	String : os argumentos de configuração.

devoluções
Pair <Boolean, Integer>	Um par de valores, o primeiro valor é um Booleano true se o comando foi adicionado com sucesso. O segundo valor é o ID do rastreador de comando conhecido (valor não negativo) se o comando foi adicionado com sucesso, retorne 0 quando o comando for adicionado para todos os dispositivos, caso contrário -1.

lances
ConfigurationException	se o comando não puder ser analisado

Veja também:

• IConfigurationFactory.createConfigurationFromArgs(String[])

addCommandFile

public abstract void addCommandFile (String cmdFile, 
                 extraArgs)

Adiciona todos os comandos de determinado arquivo ao agendador

Parâmetros
cmdFile	String : o caminho do sistema de arquivos do arquivo de comando
extraArgs	: um ERROR(/List) de argumentos String para anexar a cada comando analisado do arquivo. Pode estar vazio, mas não deve ser nulo.

lances
ConfigurationException	se o arquivo de comando não puder ser analisado

Veja também:

• CommandFileParser

aguardam

public abstract void await ()

Aguarda o início da execução do agendador, incluindo a conclusão da transferência do TF antigo, se aplicável.

displayCommandQueue

public abstract void displayCommandQueue (PrintWriter printWriter)

Saída de informações de depuração detalhadas sobre o estado da fila de execução do comando.

displayCommandsInfo

public abstract void displayCommandsInfo (PrintWriter printWriter, 
                String regex)

Saída de uma lista de comandos atuais.

Parâmetros
printWriter	PrintWriter : o ERROR(/PrintWriter) para o qual enviar.
regex	String : a expressão regular com a qual os comandos devem corresponder para serem impressos. Se nulo, todos os comandos serão impressos.

displayInvocationsInfo

public abstract void displayInvocationsInfo (PrintWriter printWriter)

Exibe uma lista de invocações atuais.

Parâmetros
printWriter	PrintWriter : o ERROR(/PrintWriter) para o qual enviar.

dumpCommandsXml

public abstract void dumpCommandsXml (PrintWriter printWriter, 
                String regex)

Despeje o arquivo xml expandido para o comando com todos os valores Option especificados para todos os comandos atuais.

Parâmetros
printWriter	PrintWriter : o ERROR(/PrintWriter) para o qual enviar o status.
regex	String : a expressão regular com a qual os comandos devem corresponder para que o arquivo xml seja despejado. Se nulo, todos os comandos serão despejados.

comandoexec

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

Aloca diretamente um dispositivo e executa um comando sem adicioná-lo à fila de comandos usando um IInvocationContext já existente.

Parâmetros
context	IInvocationContext : um IInvocationContext existente.
listener	ICommandScheduler.IScheduledInvocationListener : o ICommandScheduler.IScheduledInvocationListener a ser informado
args	String : os argumentos do comando

devoluções
long

lances
ConfigurationException	se o comando for inválido
NoDeviceException	se não houver nenhum dispositivo para usar

comandoexec

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

Aloca diretamente um dispositivo e executa um comando sem adicioná-lo à fila de comandos.

Parâmetros
listener	ICommandScheduler.IScheduledInvocationListener : o ICommandScheduler.IScheduledInvocationListener a ser informado
args	String : os argumentos do comando

devoluções
long	O ID de invocação do comando agendado.

lances
ConfigurationException	se o comando for inválido
NoDeviceException	se não houver nenhum dispositivo para usar

comandoexec

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

Execute o comando diretamente em dispositivos já alocados.

Parâmetros
listener	ICommandScheduler.IScheduledInvocationListener : o ICommandScheduler.IScheduledInvocationListener a ser informado
devices	: o ERROR(/List ) ERROR(/List ) para usar
args	String : os argumentos do comando

devoluções
long	O ID de invocação do comando agendado.

lances
ConfigurationException	se o comando for inválido

getCommandFileWatcher

public abstract CommandFileWatcher getCommandFileWatcher ()

Obtenha o CommandFileWatcher apropriado para este agendador

devoluções
CommandFileWatcher

getExecutingCommandCount

public abstract int getExecutingCommandCount ()

Retorna o número de Comandos em estado de execução.

devoluções
int

getInvocationInfo

public abstract String getInvocationInfo (int invocationId)

Retorne as informações sobre uma invocação especificando o id da invocação.

Parâmetros
invocationId	int : o ID de rastreamento da invocação.

devoluções
String	Uma String contendo informações sobre a invocação.

getLastInvocationExitCode

public abstract CommandRunner.ExitCode getLastInvocationExitCode ()

Retorna o código de erro da última chamada executada. Retorne 0 (sem erro), se nenhuma chamada foi executada ainda.

devoluções
CommandRunner.ExitCode

getLastInvocationThrowable

public abstract Throwable getLastInvocationThrowable ()

Retorne o Throwable da última invocação executada. Retorne null, se nenhum throwable estiver disponível.

devoluções
Throwable

getReadyCommandCount

public abstract int getReadyCommandCount ()

Retorna o número de Comandos em estado pronto na fila.

devoluções
int

isDeviceInInvocationThread

public abstract boolean isDeviceInInvocationThread (ITestDevice device)

Retorna true se o dispositivo for usado por um thread de invocação ativo.

Parâmetros
device	ITestDevice

devoluções
boolean

juntar

public abstract void join ()

Aguarda a conclusão do agendador.

Veja também:

• Thread.join()

juntar

public abstract void join (long millis)

Aguarda a conclusão do agendador ou o tempo limite após a duração especificada em milissegundos.

Parâmetros
millis	long

Veja também:

• Thread.join(long)

removeAllCommands

public abstract void removeAllCommands ()

Remova todos os comandos do agendador

setClearcutClient

public abstract void setClearcutClient (ClearcutClient client)

Defina o cliente para relatar dados de chicote

Parâmetros
client	ClearcutClient

shouldShutdownOnCmdfileError

public abstract boolean shouldShutdownOnCmdfileError ()

Retorne verdadeiro se precisarmos desligar o agendador em um erro de comando

devoluções
boolean

desligar

public void shutdown ()

Tente desligar normalmente o agendador de comandos.

Limpa os comandos que estão esperando para serem testados e solicita que todas as invocações em andamento sejam encerradas normalmente.

Depois que o desligamento é chamado, o loop principal do agendador aguardará a conclusão de todas as invocações em andamento antes de sair completamente.

desligar

public abstract void shutdown (boolean notifyStop)

Tente desligar normalmente o agendador de comandos.

Parâmetros
notifyStop	boolean : se true, notifica invocações de desligamento do TF.

desligamentoDifícil

public abstract void shutdownHard (boolean killAdb)

Tente encerrar à força o agendador de comandos.

Semelhante a shutdown() , mas também matará opcionalmente a conexão adb, em uma tentativa de 'inspirar' as invocações em andamento para serem concluídas mais rapidamente.

Parâmetros
killAdb	boolean

desligamentoDifícil

public abstract void shutdownHard ()

Tente encerrar à força o agendador de comandos. O mesmo que shutdownHard(true).

shutdownOnEmpty

public abstract void shutdownOnEmpty ()

Semelhante a shutdown() , mas, em vez disso, aguardará que todos os comandos sejam executados antes de sair.

Observe que, se algum comando estiver no modo loop, o agendador nunca será encerrado.

começar

public abstract void start ()

Inicie o ICommandScheduler .

Deve ser chamado antes de chamar outros métodos.

Será executado até que shutdown() seja chamado. veja Thread.start() .

stopInvocation

public abstract boolean stopInvocation (int invocationId, 
                String cause)

Interrompa uma chamada em execução especificando seu id.

Parâmetros
invocationId	int : o ID de rastreamento da invocação.
cause	String : a causa para interromper a invocação.

devoluções
boolean	true se a invocação foi interrompida, false caso contrário

lances
UnsupportedOperationException	se a implementação não suportar isso

stopInvocation

public boolean stopInvocation (int invocationId)

Interrompa uma chamada em execução especificando seu id.

Parâmetros
invocationId	int

devoluções
boolean	true se a invocação foi interrompida, false caso contrário

lances
UnsupportedOperationException	se a implementação não suportar isso

stopInvocation

public abstract boolean stopInvocation (ITestInvocation invocation)

Interrompa uma chamada em execução.

Parâmetros
invocation	ITestInvocation

devoluções
boolean	true se a invocação foi interrompida, false caso contrário

lances
UnsupportedOperationException	se a implementação não suportar isso