ICommandScheduler

public interface ICommandScheduler

com.android.tradefed.command.ICommandScheduler

Планировщик для выполнения команд TradeFederation.

Краткое содержание

Вложенные классы

interface ICommandScheduler.IScheduledInvocationListener

Прослушиватель событий вызова после завершения вызова.

Публичные методы

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

Добавляет команду в планировщик.

abstract void addCommandFile (String cmdFile, extraArgs) addCommandFile (String cmdFile, extraArgs)

Добавляет все команды из данного файла в планировщик

abstract void await ()

Ожидает запуска планировщика, включая ожидание завершения передачи от старого TF, если это применимо.

abstract void displayCommandQueue (PrintWriter printWriter)

Выводить подробную отладочную информацию о состоянии очереди выполнения команд.

abstract void displayCommandsInfo (PrintWriter printWriter, String regex)

Вывести список текущих команд.

abstract void displayInvocationsInfo (PrintWriter printWriter)

Отображает список текущих вызовов.

abstract void dumpCommandsXml (PrintWriter printWriter, String regex)

Создайте дамп расширенного XML-файла для команды со всеми значениями Option , указанными для всех текущих команд.

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

Напрямую выделяет устройство и выполняет команду, не добавляя ее в очередь команд, используя уже существующий IInvocationContext .

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

Непосредственно выделяет устройство и выполняет команду, не добавляя ее в очередь команд.

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

Непосредственно выполнять команду на уже выделенных устройствах.

abstract CommandFileWatcher getCommandFileWatcher ()

Получите соответствующий CommandFileWatcher для этого планировщика

abstract int getExecutingCommandCount ()

Возвращает количество команд в состоянии выполнения.

abstract String getInvocationInfo (int invocationId)

Возвращает информацию о вызове bu с указанием идентификатора вызова.

abstract CommandRunner.ExitCode getLastInvocationExitCode ()

Возвращает код ошибки последнего запущенного вызова.

abstract Throwable getLastInvocationThrowable ()

Возвращает ERROR(/Throwable) из последнего запущенного вызова.

abstract int getReadyCommandCount ()

Возвращает количество Команд в состоянии готовности в очереди.

abstract boolean isDeviceInInvocationThread ( ITestDevice device)

Возвращает true, если устройство используется активным потоком вызова.

abstract void join ()

Ожидает завершения планировщика.

abstract void join (long millis)

Ожидает завершения планировщика или истечения времени ожидания по истечении времени, указанного в миллисекундах.

abstract void removeAllCommands ()

Удалить все команды из планировщика

abstract void setClearcutClient (ClearcutClient client)

Настройте клиент для передачи данных жгута проводов

abstract boolean shouldShutdownOnCmdfileError ()

Верните true, если нам нужно выключить планировщик при ошибках команды.

default void shutdown ()

Попытка корректно завершить работу планировщика команд.

abstract void shutdown (boolean notifyStop)

Попытка корректно завершить работу планировщика команд.

abstract void shutdownHard (boolean killAdb)

Попытка принудительно отключить планировщик команд.

abstract void shutdownHard ()

Попытка принудительно отключить планировщик команд.

abstract void shutdownOnEmpty ()

Подобно shutdown() , но вместо этого будет ждать выполнения всех команд перед выходом.

abstract void start ()

Запустите ICommandScheduler .

abstract boolean stopInvocation (int invocationId, String cause)

Остановите запущенный вызов, указав его идентификатор.

default boolean stopInvocation (int invocationId)

Остановите запущенный вызов, указав его идентификатор.

abstract boolean stopInvocation ( ITestInvocation invocation)

Остановить запущенный вызов.

Публичные методы

добавитькоманду

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

Добавляет команду в планировщик.

Команда, по сути, представляет собой экземпляр конфигурации для запуска и связанные с ней аргументы.

Если указан аргумент "--help", текст справки для конфигурации будет выведен на стандартный вывод. В противном случае конфиг будет добавлен в очередь на запуск.

Параметры
args String : аргументы конфигурации.

Возвращает
Pair <Boolean, Integer> Пара значений, первое значение является логическим значением true , если команда была успешно добавлена. Второе значение — это известный идентификатор средства отслеживания команд (неотрицательное значение), если команда была успешно добавлена, верните 0, если команда добавлена ​​для всех устройств, иначе -1.

Броски
ConfigurationException если команда не может быть проанализирована

добавитьCommandFile

public abstract void addCommandFile (String cmdFile, 
                 extraArgs)

Добавляет все команды из данного файла в планировщик

Параметры
cmdFile String : путь файловой системы к командному файлу.

extraArgs : ERROR(/List) аргументов ERROR(/String) для добавления к каждой команде, проанализированной из файла. Может быть пустым, но не должен быть нулевым.

Броски
ConfigurationException если командный файл не может быть проанализирован

Смотрите также:

Ждите

public abstract void await ()

Ожидает запуска планировщика, включая ожидание завершения передачи от старого TF, если это применимо.

displayCommandQueue

public abstract void displayCommandQueue (PrintWriter printWriter)

Выводить подробную отладочную информацию о состоянии очереди выполнения команд.

displayCommandsInfo

public abstract void displayCommandsInfo (PrintWriter printWriter, 
                String regex)

Вывести список текущих команд.

Параметры
printWriter PrintWriter : ERROR(/PrintWriter) для вывода.

regex String : регулярное выражение, которому должны соответствовать команды для вывода на печать. Если null, то будут напечатаны все команды.

displayInvocationsInfo

public abstract void displayInvocationsInfo (PrintWriter printWriter)

Отображает список текущих вызовов.

Параметры
printWriter PrintWriter : ERROR(/PrintWriter) для вывода.

дампКоммандсксмл

public abstract void dumpCommandsXml (PrintWriter printWriter, 
                String regex)

Создайте дамп расширенного XML-файла для команды со всеми значениями Option , указанными для всех текущих команд.

Параметры
printWriter PrintWriter : ERROR(/PrintWriter) для вывода состояния.

regex String : регулярное выражение, с которым должны сопоставляться команды для создания дампа XML-файла. Если null, то все команды будут сброшены.

execCommand

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

Напрямую выделяет устройство и выполняет команду, не добавляя ее в очередь команд, используя уже существующий IInvocationContext .

Параметры
context IInvocationContext : существующий IInvocationContext .

listener ICommandScheduler.IScheduledInvocationListener : ICommandScheduler.IScheduledInvocationListener должен быть проинформирован

args String : аргументы команды

Возвращает
long

Броски
ConfigurationException если команда недействительна
NoDeviceException если нет устройства для использования

execCommand

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

Непосредственно выделяет устройство и выполняет команду, не добавляя ее в очередь команд.

Параметры
listener ICommandScheduler.IScheduledInvocationListener : ICommandScheduler.IScheduledInvocationListener должен быть проинформирован

args String : аргументы команды

Возвращает
long Идентификатор вызова запланированной команды.

Броски
ConfigurationException если команда недействительна
NoDeviceException если нет устройства для использования

execCommand

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

Непосредственно выполнять команду на уже выделенных устройствах.

Параметры
listener ICommandScheduler.IScheduledInvocationListener : ICommandScheduler.IScheduledInvocationListener должен быть проинформирован

devices : ERROR(/List ) ERROR(/List ) использовать

args String : аргументы команды

Возвращает
long Идентификатор вызова запланированной команды.

Броски
ConfigurationException если команда недействительна

getCommandFileWatcher

public abstract CommandFileWatcher getCommandFileWatcher ()

Получите соответствующий CommandFileWatcher для этого планировщика

Возвращает
CommandFileWatcher

getExecutingCommandCount

public abstract int getExecutingCommandCount ()

Возвращает количество команд в состоянии выполнения.

Возвращает
int

получитьInvocationInfo

public abstract String getInvocationInfo (int invocationId)

Возвращает информацию о вызове bu с указанием идентификатора вызова.

Параметры
invocationId int : идентификатор отслеживания вызова.

Возвращает
String ERROR(/String) , содержащий информацию о вызове.

getLastInvocationExitCode

public abstract CommandRunner.ExitCode getLastInvocationExitCode ()

Возвращает код ошибки последнего запущенного вызова. Возвращает 0 (нет ошибки), если вызов еще не выполнялся.

Возвращает
CommandRunner.ExitCode

getLastInvocationThrowable

public abstract Throwable getLastInvocationThrowable ()

Возвращает ERROR(/Throwable) из последнего запущенного вызова. Возвращает null, если нет доступных бросков.

Возвращает
Throwable

getReadyCommandCount

public abstract int getReadyCommandCount ()

Возвращает количество Команд в состоянии готовности в очереди.

Возвращает
int

isDeviceInInvocationThread

public abstract boolean isDeviceInInvocationThread (ITestDevice device)

Возвращает true, если устройство используется активным потоком вызова.

Параметры
device ITestDevice

Возвращает
boolean

присоединиться

public abstract void join ()

Ожидает завершения планировщика.

Смотрите также:

присоединиться

public abstract void join (long millis)

Ожидает завершения планировщика или истечения времени ожидания по истечении времени, указанного в миллисекундах.

Параметры
millis long

Смотрите также:

удалить все команды

public abstract void removeAllCommands ()

Удалить все команды из планировщика

setClearcutClient

public abstract void setClearcutClient (ClearcutClient client)

Настройте клиент для передачи данных жгута проводов

Параметры
client ClearcutClient

следуетShutdownOnCmdfileError

public abstract boolean shouldShutdownOnCmdfileError ()

Верните true, если нам нужно выключить планировщик при ошибках команды.

Возвращает
boolean

неисправность

public void shutdown ()

Попытка корректно завершить работу планировщика команд.

Очищает команды, ожидающие проверки, и запрашивает корректное завершение всех выполняемых вызовов.

После вызова выключения основной цикл планировщика будет ждать завершения всех выполняемых вызовов, прежде чем полностью выйти.

неисправность

public abstract void shutdown (boolean notifyStop)

Попытка корректно завершить работу планировщика команд.

Параметры
notifyStop boolean : если true, уведомляет о вызовах закрытия TF.

выключениеHard

public abstract void shutdownHard (boolean killAdb)

Попытка принудительно отключить планировщик команд.

Аналогичен shutdown() , но также необязательно отключает соединение adb, пытаясь «вдохновить» выполняемые вызовы на более быстрое завершение.

Параметры
killAdb boolean

выключениеHard

public abstract void shutdownHard ()

Попытка принудительно отключить планировщик команд. То же, что и shutdownHard(true).

выключениеOnEmpty

public abstract void shutdownOnEmpty ()

Подобно shutdown() , но вместо этого будет ждать выполнения всех команд перед выходом.

Обратите внимание, что если какие-либо команды находятся в циклическом режиме, планировщик никогда не выйдет.

начинать

public abstract void start ()

Запустите ICommandScheduler .

Должен вызываться перед вызовом других методов.

Будет работать до тех пор, пока не будет вызван shutdown() . см. ERROR(/Thread#start()) .

стопинвокация

public abstract boolean stopInvocation (int invocationId, 
                String cause)

Остановите запущенный вызов, указав его идентификатор.

Параметры
invocationId int : идентификатор отслеживания вызова.

cause String : причина остановки вызова.

Возвращает
boolean true, если вызов был остановлен, иначе false

Броски
если реализация не поддерживает это

стопинвокация

public boolean stopInvocation (int invocationId)

Остановите запущенный вызов, указав его идентификатор.

Параметры
invocationId int

Возвращает
boolean true, если вызов был остановлен, иначе false

Броски
если реализация не поддерживает это

стопинвокация

public abstract boolean stopInvocation (ITestInvocation invocation)

Остановить запущенный вызов.

Параметры
invocation ITestInvocation

Возвращает
boolean true, если вызов был остановлен, иначе false

Броски
если реализация не поддерживает это