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 boolean addCommand(String[] args)

Adiciona um comando ao programador.

abstract void addCommandFile(String cmdFile, extraArgs)

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 completeHandover()

Informa o programador de comando que uma sequência de transferência iniciada está totalmente completa e deve reinicializar o gerenciador remoto na porta padrão.

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 Option especificados para todos os comandos atuais.

abstract void 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 void execCommand(ICommandScheduler.IScheduledInvocationListener listener, String[] args)

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

abstract void execCommand(ICommandScheduler.IScheduledInvocationListener listener, ITestDevice device, String[] args)

Executa diretamente o comando em um dispositivo já alocado.

abstract CommandFileWatcher getCommandFileWatcher()

Receber 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 Throwable da última invocação que foi executada.

abstract int getReadyCommandCount()

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

abstract void handoverInitiationComplete()

Informa o programador de comando que a troca inicial de entrega de dispositivos e comandos em uso está concluída e pode começar a programar a operação.

abstract boolean handoverShutdown(int handoverPort)

Inicia um shutdown() e a entrega para outro processo negociado no mesmo host.

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

abstract void shutdown()

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 shutdown(), mas aguardará todos os comandos serem executados antes de sair.

abstract void start()

Inicie a ICommandScheduler.

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.

Métodos públicos

addCommand

public abstract boolean addCommand (String[] args)

Adiciona um comando ao programador.

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

Se "--ajuda" é especificado o texto de ajuda de a configuração será gerada em stdout. Caso contrário, a configuração será adicionada à fila para correr.

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

Retorna
boolean true se o comando tiver sido adicionado

Gera
ConfigurationException se o comando não puder ser analisado

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.

Transição completa

public abstract void completeHandover ()

Informa o programador de comando que uma sequência de transferência iniciada está totalmente completa e deve reinicializar o gerenciador remoto na porta padrão.

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 void 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.

Gera
ConfigurationException se o comando for inválido.
NoDeviceException se não houver dispositivo para usar

"execCommand"

public abstract void 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.

Gera
ConfigurationException se o comando for inválido.
NoDeviceException se não houver dispositivo para usar

"execCommand"

public abstract void execCommand (ICommandScheduler.IScheduledInvocationListener listener, 
                ITestDevice device, 
                String[] args)

Executa diretamente o comando em um dispositivo já alocado.

Parâmetros
listener ICommandScheduler.IScheduledInvocationListener: o ICommandScheduler.IScheduledInvocationListener a ser informado

device ITestDevice: o ITestDevice a ser usado.

args String: os argumentos do comando.

Gera
ConfigurationException se o comando for inválido.

getCommandFileWatcher

public abstract CommandFileWatcher getCommandFileWatcher ()

Receber 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

handoverInitiationComplete

public abstract void handoverInitiationComplete ()

Informa o programador de comando que a troca inicial de entrega de dispositivos e comandos em uso está concluída e pode começar a programar a operação.

handoverShutdown

public abstract boolean handoverShutdown (int handoverPort)

Inicia um shutdown() e a entrega para outro processo negociado no mesmo host.

O programador vai informar ao processo de negociação remota que detecta essa porta de dispositivos liberados conforme eles são disponibilizados.

Parâmetros
handoverPort int

Retorna
boolean true se o início da transição tiver sido bem-sucedido, false caso contrário

join

public abstract void join ()

Aguarda a conclusão do programador.

Confira também:

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 abstract void shutdown ()

Tenta encerrar normalmente o programador de comando.

Limpa os comandos que aguardam testes e solicita que todas as invocações em andamento desligar normalmente.

Depois que o encerramento for chamado, o loop principal do programador aguardará todas as invocações em andamento ser concluída antes de encerrar completamente.

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