ICommandScheduler
public
interface
ICommandScheduler
com.android.tradefed.command.ICommandScheduler |
Um programador para executar comandos do TradeFederation.
Resumo
Classes aninhadas | |
---|---|
interface |
ICommandScheduler.IScheduledInvocationListener
Listener de 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 programador. |
abstract
void
|
addCommandFile(String cmdFile,
Adiciona todos os comandos de um arquivo fornecido ao programador |
abstract
void
|
await()
Aguarda a execução do programador, inclusive a conclusão da transferência do TF antigo se aplicável. |
abstract
void
|
displayCommandQueue(PrintWriter printWriter)
Informações de depuração detalhadas de saída sobre o estado da fila de execução de comandos. |
abstract
void
|
displayCommandsInfo(PrintWriter printWriter, String regex)
Gera uma lista dos 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 todas as
Valores |
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 |
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,
Executar o comando diretamente em dispositivos já alocados. |
abstract
CommandFileWatcher
|
getCommandFileWatcher()
Conseguir o CommandFileWatcher apropriado para este agendador |
abstract
int
|
getExecutingCommandCount()
Retorna o número de comandos no estado de execução. |
abstract
String
|
getInvocationInfo(int invocationId)
Retorne as informações em uma bu de invocação especificando o ID dela. |
abstract
CommandRunner.ExitCode
|
getLastInvocationExitCode()
Retorne o código de erro da última invocação que foi executada. |
abstract
Throwable
|
getLastInvocationThrowable()
Retorne o |
abstract
int
|
getReadyCommandCount()
Retorna o número de comandos em estado pronto na fila. |
abstract
boolean
|
isDeviceInInvocationThread(ITestDevice device)
Retorna verdadeiro se o dispositivo for usado por uma linha de execução de invocação ativa. |
abstract
void
|
join()
Aguarda a conclusão do programador. |
abstract
void
|
join(long millis)
Aguarda a conclusão do programador ou o tempo limite após a duração especificada em milissegundos. |
abstract
void
|
removeAllCommands()
Remover todos os comandos do programador |
abstract
void
|
setClearcutClient(ClearcutClient client)
Configurar o cliente para relatar os dados do arcabouço |
abstract
boolean
|
shouldShutdownOnCmdfileError()
Retornar verdadeiro se for necessário encerrar o programador em um erro de comando |
default
void
|
shutdown()
Tenta encerrar normalmente o programador de comando. |
abstract
void
|
shutdown(boolean notifyStop)
Tenta encerrar normalmente o programador de comando. |
abstract
void
|
shutdownHard(boolean killAdb)
Tentativa de encerrar à força o programador de comando. |
abstract
void
|
shutdownHard()
Tentativa de encerrar à força o programador de comando. |
abstract
void
|
shutdownOnEmpty()
Semelhante a |
abstract
void
|
start()
Inicie a |
abstract
boolean
|
stopInvocation(int invocationId, String cause)
Especifique o ID de uma invocação em execução para interrompê-la. |
default
boolean
|
stopInvocation(int invocationId)
Especifique o ID de uma invocação em execução para interrompê-la. |
abstract
boolean
|
stopInvocation(ITestInvocation invocation)
Interrompe uma invocação em execução. |
default
void
|
stopScheduling()
Para de programar e aceitar novos testes, mas não para o Tradefed. |
Métodos públicos
addCommand
public abstract Pair<Boolean, Integer> addCommand (String[] args)
Adiciona um comando ao programador.
Um comando é essencialmente uma instância de uma configuração a ser executada e a respectiva .
Se "--ajuda" for especificado, o texto de ajuda da 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. |
Retorna | |
---|---|
Pair<Boolean, Integer> |
Um par de valores. O primeiro valor será um booleano true se o comando tiver sido adicionado.
com sucesso. O segundo valor é o ID do rastreador de comandos conhecido(valor não negativo) se o
O comando foi adicionado, retorne 0 quando o comando for adicionado para todos os dispositivos. Caso contrário,
-1 |
Gera | |
---|---|
ConfigurationException |
se o comando não puder ser analisado |
Confira também:
addCommandFile
public abstract void addCommandFile (String cmdFile,extraArgs)
Adiciona todos os comandos de um arquivo fornecido ao programador
Parâmetros | |
---|---|
cmdFile |
String : o caminho do sistema de arquivos do arquivo de comando |
extraArgs |
: um ERROR(/List) de String argumentos para anexar a cada comando analisado.
do arquivo. Pode estar vazio, mas não deve ser nulo. |
Gera | |
---|---|
ConfigurationException |
se o arquivo de comando não puder ser analisado |
Confira também:
esperam
public abstract void await ()
Aguarda a execução do programador, inclusive a conclusão da transferência do TF antigo se aplicável.
displayCommandQueue
public abstract void displayCommandQueue (PrintWriter printWriter)
Informações de depuração detalhadas de saída sobre o estado da fila de execução de comandos.
displayCommandsInfo
public abstract void displayCommandsInfo (PrintWriter printWriter, String regex)
Gera uma lista dos comandos atuais.
Parâmetros | |
---|---|
printWriter |
PrintWriter : o ERROR(/PrintWriter) de saída. |
regex |
String : a expressão regular que corresponde aos comandos para serem
impresso. Se for nulo, todos os comandos serão mostrados. |
displayInvocationsInfo
public abstract void displayInvocationsInfo (PrintWriter printWriter)
Exibe uma lista de invocações atuais.
Parâmetros | |
---|---|
printWriter |
PrintWriter : o ERROR(/PrintWriter) de saída. |
dumpCommandsXml
public abstract void dumpCommandsXml (PrintWriter printWriter, String regex)
Despeje o arquivo XML expandido para o comando com todas as
Valores Option
especificados para todos os comandos atuais.
Parâmetros | |
---|---|
printWriter |
PrintWriter : o ERROR(/PrintWriter) que vai receber o status. |
regex |
String : a expressão regular a que os comandos precisam ser correspondentes para que o
XML a ser despejado. Se for nulo, todos os comandos serão despejados. |
"execCommand"
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. |
Retorna | |
---|---|
long |
Gera | |
---|---|
ConfigurationException |
se o comando for inválido. |
NoDeviceException |
se não houver dispositivo para usar |
"execCommand"
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. |
Retorna | |
---|---|
long |
O código de invocação do comando programado. |
Gera | |
---|---|
ConfigurationException |
se o comando for inválido. |
NoDeviceException |
se não houver dispositivo para usar |
"execCommand"
public abstract long execCommand (ICommandScheduler.IScheduledInvocationListener listener,devices, String[] args)
Executar o comando diretamente em dispositivos já alocados.
Parâmetros | |
---|---|
listener |
ICommandScheduler.IScheduledInvocationListener : o ICommandScheduler.IScheduledInvocationListener a ser informado |
devices |
: o ERROR(/List a ser usado. |
args |
String : os argumentos do comando. |
Retorna | |
---|---|
long |
O código de invocação do comando programado. |
Gera | |
---|---|
ConfigurationException |
se o comando for inválido. |
getCommandFileWatcher
public abstract CommandFileWatcher getCommandFileWatcher ()
Conseguir o CommandFileWatcher apropriado para este agendador
Retorna | |
---|---|
CommandFileWatcher |
getExecutingCommandCount
public abstract int getExecutingCommandCount ()
Retorna o número de comandos no estado de execução.
Retorna | |
---|---|
int |
getInvocationInfo
public abstract String getInvocationInfo (int invocationId)
Retorne as informações em uma bu de invocação especificando o ID dela.
Parâmetros | |
---|---|
invocationId |
int : o ID de acompanhamento da invocação. |
Retorna | |
---|---|
String |
Um String contendo informações sobre a invocação. |
getLastInvocationExitCode
public abstract CommandRunner.ExitCode getLastInvocationExitCode ()
Retorne o código de erro da última invocação que foi executada. Retorne 0 (sem erro) se nenhuma invocação tiver sido executada ainda.
Retorna | |
---|---|
CommandRunner.ExitCode |
getLastInvocationThrowable
public abstract Throwable getLastInvocationThrowable ()
Retorne o Throwable
da última invocação que foi executada.
Retorna nulo, se nenhum throwable estiver disponível.
Retorna | |
---|---|
Throwable |
getReadyCommandCount
public abstract int getReadyCommandCount ()
Retorna o número de comandos em estado pronto na fila.
Retorna | |
---|---|
int |
isDeviceInvocationThread
public abstract boolean isDeviceInInvocationThread (ITestDevice device)
Retorna verdadeiro se o dispositivo for usado por uma linha de execução de invocação ativa.
Parâmetros | |
---|---|
device |
ITestDevice |
Retorna | |
---|---|
boolean |
join
public abstract void join (long millis)
Aguarda a conclusão do programador ou o tempo limite após a duração especificada em milissegundos.
Parâmetros | |
---|---|
millis |
long |
Confira também:
removeAllCommands
public abstract void removeAllCommands ()
Remover todos os comandos do programador
setClearcutClient
public abstract void setClearcutClient (ClearcutClient client)
Configurar o cliente para relatar os dados do arcabouço
Parâmetros | |
---|---|
client |
ClearcutClient |
shouldShutdownOnCmdfileError
public abstract boolean shouldShutdownOnCmdfileError ()
Retornar verdadeiro se for necessário encerrar o programador em um erro de comando
Retorna | |
---|---|
boolean |
encerramento
public void shutdown ()
Tenta encerrar normalmente o programador de comando.
Limpa os comandos que aguardam testes e solicita que todas as invocações em andamento sejam encerradas para baixo graciosamente.
Depois que o encerramento for chamado, o loop principal do programador aguardará todas as invocações da progresso para ser concluído antes de ser totalmente fechado.
encerramento
public abstract void shutdown (boolean notifyStop)
Tenta encerrar normalmente o programador de comando.
Parâmetros | |
---|---|
notifyStop |
boolean : se verdadeiro, notifica as invocações de encerramento do TF. |
desligamentoHard
public abstract void shutdownHard (boolean killAdb)
Tentativa de encerrar à força o programador de comando.
Semelhante a shutdown()
, mas também opcionalmente elimina a conexão adb, em uma
tentar "inspirar" invocações em andamento para que sejam concluídas mais rapidamente.
Parâmetros | |
---|---|
killAdb |
boolean |
desligamentoHard
public abstract void shutdownHard ()
Tentativa de encerrar à força o programador de comando. O mesmo que closeddownHard(true).
launchdownOnEmpty
public abstract void shutdownOnEmpty ()
Semelhante a shutdown()
, mas aguardará todos os comandos serem executados
antes de sair.
Se algum comando estiver em modo de loop, o programador nunca será encerrado.
start
public abstract void start ()
Inicie a ICommandScheduler
.
Precisa ser chamado antes de chamar outros métodos.
Será executado até shutdown()
ser chamado.
consulte Thread.start()
.
stopInvocation
public abstract boolean stopInvocation (int invocationId, String cause)
Especifique o ID de uma invocação em execução para interrompê-la.
Parâmetros | |
---|---|
invocationId |
int : o ID de acompanhamento da invocação. |
cause |
String : a causa da interrupção da invocação. |
Retorna | |
---|---|
boolean |
verdadeiro se a invocação tiver sido interrompida, falso caso contrário |
Gera | |
---|---|
UnsupportedOperationException |
se a implementação não oferecer suporte |
stopInvocation
public boolean stopInvocation (int invocationId)
Especifique o ID de uma invocação em execução para interrompê-la.
Parâmetros | |
---|---|
invocationId |
int |
Retorna | |
---|---|
boolean |
verdadeiro se a invocação tiver sido interrompida, falso caso contrário |
Gera | |
---|---|
UnsupportedOperationException |
se a implementação não oferecer suporte |
stopInvocation
public abstract boolean stopInvocation (ITestInvocation invocation)
Interrompe uma invocação em execução.
Parâmetros | |
---|---|
invocation |
ITestInvocation |
Retorna | |
---|---|
boolean |
verdadeiro se a invocação tiver sido interrompida, falso caso contrário |
Gera | |
---|---|
UnsupportedOperationException |
se a implementação não oferecer suporte |
parar de programar
public void stopScheduling ()
Para de programar e aceitar novos testes, mas não para o Tradefed. Isso serve para ativar um encerramento de duas etapas em que primeiro drenamos todos os testes em execução e depois encerramos o Tradefed de desenvolvimento de software.