ICommandScheduler

public interface ICommandScheduler

com.android.tradefed.command.ICommandScheduler

已知的间接子类 ClusterCommandScheduler、CommandScheduler ClusterCommandScheduler 一个 ICommandScheduler，用于支持 TFC (Tradefed Cluster)。  CommandScheduler 在所有可用设备上运行 TradeFederation 命令的调度器。

---

用于运行 TradeFederation 命令的调度器。

摘要

嵌套类
interface	ICommandScheduler.IScheduledInvocationListener 在调用完成时监听调用事件。

公共方法
abstract Pair<Boolean, Integer>	addCommand(String[] args) 向调度器添加命令。
abstract void	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) 在已分配的设备上直接执行命令。
abstract CommandFileWatcher	getCommandFileWatcher() 为此调度器获取适当的 CommandFileWatcher
abstract int	getExecutingCommandCount() 返回处于执行状态的命令数量。
abstract String	getInvocationInfo(int invocationId) 返回指定调用 ID 的调用相关信息。
abstract CommandRunner.ExitCode	getLastInvocationExitCode() 返回上次运行的调用的错误代码。
abstract Throwable	getLastInvocationThrowable() 返回上次运行的调用中的 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) 通过指定其 ID 来停止正在运行的调用。
default boolean	stopInvocation(int invocationId) 通过指定其 ID 来停止正在运行的调用。
abstract boolean	stopInvocation(ITestInvocation invocation) 停止正在运行的调用。
default void	stopScheduling() 停止调度并接受新测试，但不会停止 Tradefed。

公共方法

addCommand

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

向调度器添加命令。

命令本质上是要运行的配置的实例，以及 参数。

如果为“--help”参数后，该配置的帮助文本将输出到 stdout。 否则，该配置将添加到队列中以运行。

参数
args	String：配置参数。

返回
Pair<Boolean, Integer>	一对值，如果添加了命令，则第一个值是布尔值 true 成功。如果 命令已成功添加，当为所有设备添加命令时返回 0，否则返回 0 -1。

抛出
ConfigurationException	如果无法解析命令

另见：

• IConfigurationFactory.createConfigurationFromArgs(String[])

addCommandFile

public abstract void addCommandFile (String cmdFile, 
                 extraArgs)

将给定文件中的所有命令添加到调度器

参数
cmdFile	String：命令文件的文件系统路径
extraArgs	：要附加到解析的每个命令的 ERROR(/List)（包含 String 个参数） 来自文件。可以为空，但不得为 null。

抛出
ConfigurationException	如果无法解析命令文件

另见：

• CommandFileParser

等待

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)。

dumpCommandsXml

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	if 命令无效
NoDeviceException	如果没有设备可供使用

execCommand

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

直接分配设备并执行命令，无需将其添加到命令队列。

参数
listener	ICommandScheduler.IScheduledInvocationListener：要通知的 ICommandScheduler.IScheduledInvocationListener
args	String：命令参数

返回
long	已安排的命令的调用 ID。

抛出
ConfigurationException	if 命令无效
NoDeviceException	如果没有设备可供使用

execCommand

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

在已分配的设备上直接执行命令。

参数
listener	ICommandScheduler.IScheduledInvocationListener：要通知的 ICommandScheduler.IScheduledInvocationListener
devices	：要使用的 ERROR(/List)
args	String：命令参数

返回
long	已安排的命令的调用 ID。

抛出
ConfigurationException	if 命令无效

getCommandFileWatcher

public abstract CommandFileWatcher getCommandFileWatcher ()

为此调度器获取适当的 CommandFileWatcher

返回
CommandFileWatcher

getExecutingCommandCount

public abstract int getExecutingCommandCount ()

返回处于执行状态的命令数量。

返回
int

getInvocationInfo

public abstract String getInvocationInfo (int invocationId)

返回指定调用 ID 的调用相关信息。

参数
invocationId	int：调用的跟踪 ID。

返回
String	包含调用相关信息的 String。

getLastInvocationExitCode

public abstract CommandRunner.ExitCode getLastInvocationExitCode ()

返回上次运行的调用的错误代码。 如果还没有运行任何调用，则返回 0（无错误）。

返回
CommandRunner.ExitCode

getLastInvocationThrowable

public abstract Throwable getLastInvocationThrowable ()

返回上次运行的调用中的 Throwable。 如果没有可抛出对象，则返回 null。

返回
Throwable

getReadyCommandCount

public abstract int getReadyCommandCount ()

返回队列中处于就绪状态的命令数量。

返回
int

isDeviceInvocationThread

public abstract boolean isDeviceInInvocationThread (ITestDevice device)

如果设备由处于活动状态的调用线程使用，则返回 true。

参数
device	ITestDevice

返回
boolean

join

public abstract void join ()

等待调度器完成。

另见：

• Thread.join()

join

public abstract void join (long millis)

等待调度程序在达到指定的持续时间（以毫秒为单位）后完成或超时。

参数
millis	long

另见：

• Thread.join(long)

removeAllCommands

public abstract void removeAllCommands ()

从调度器中移除所有命令

setClearcutClient

public abstract void setClearcutClient (ClearcutClient client)

将客户端设置为报告自动化测试框架数据

参数
client	ClearcutClient

shouldShutdownOnCmdfileError

public abstract boolean shouldShutdownOnCmdfileError ()

如果由于命令错误而需要关闭调度器，则返回 true

返回
boolean

关停

public void shutdown ()

尝试正常关闭命令调度器。

清除等待测试的命令，并请求关闭所有正在进行的调用 优雅地向下

调用关停后，调度器主循环将等待 在完全退出之前必须完成的进度。

关停

public abstract void shutdown (boolean notifyStop)

尝试正常关闭命令调度器。

参数
notifyStop	boolean：如果为 true，则通知调用 TF 关停。

关停硬

public abstract void shutdownHard (boolean killAdb)

尝试强制关闭命令调度程序。

与 shutdown() 类似，但也可以选择性地终止 adb 连接， 试图“启发”更快地完成。

参数
killAdb	boolean

关停硬

public abstract void shutdownHard ()

尝试强制关闭命令调度程序。与 closeHard(true) 相同。

关闭在空白处

public abstract void shutdownOnEmpty ()

与 shutdown() 类似，但会等待所有命令都执行完毕 然后下车。

请注意，如果任何命令处于循环模式，则调度器将永远不会退出。

start

public abstract void start ()

启动 ICommandScheduler。

必须在调用其他方法之前调用。

将一直运行到 shutdown() 被调用。 请参阅 Thread.start()。

stopInvocation

public abstract boolean stopInvocation (int invocationId, 
                String cause)

通过指定其 ID 来停止正在运行的调用。

参数
invocationId	int：调用的跟踪 ID。
cause	String：停止调用的原因。

返回
boolean	如果调用已停止，则为 true，否则为 false

抛出
UnsupportedOperationException	如果实现不支持

stopInvocation

public boolean stopInvocation (int invocationId)

通过指定其 ID 来停止正在运行的调用。

参数
invocationId	int

返回
boolean	如果调用已停止，则为 true，否则为 false

抛出
UnsupportedOperationException	如果实现不支持

stopInvocation

public abstract boolean stopInvocation (ITestInvocation invocation)

停止正在运行的调用。

参数
invocation	ITestInvocation

返回
boolean	如果调用已停止，则为 true，否则为 false

抛出
UnsupportedOperationException	如果实现不支持

stopScheduling

public void stopScheduling ()

停止调度并接受新测试，但不会停止 Tradefed。这是为了让 两步关闭，首先排空所有正在运行的测试，然后终止 Tradefed 过程。