IDeviceManager

public interface IDeviceManager

com.android.tradefed.device.IDeviceManager

用于管理可用于测试的设备集的接口。

摘要

嵌套类

interface IDeviceManager.IFastbootListener

用于监听 fastboot 状态变化的监听器。 

公共方法

abstract void addDeviceMonitor(IDeviceMonitor mon)

添加了 IDeviceMonitor

abstract void addFastbootListener(IDeviceManager.IFastbootListener listener)

通知管理器，监听器对快速启动状态变化感兴趣。

abstract void addMonitoringTcpFastbootDevice(String serial, String fastboot_serial)

向 fastboot 监控器添加设备。

abstract ITestDevice allocateDevice(IDeviceSelection options, boolean isTemporary)

请求满足特定条件的设备以进行测试。

abstract ITestDevice allocateDevice(IDeviceSelection options)

请求满足特定条件的设备以进行测试。

abstract ITestDevice allocateDevice()

申请实体设备以进行测试

abstract ITestDevice connectToTcpDevice(String ipAndPort)

通过 adb-over-tcp 连接到设备

此方法会分配一个新设备，该设备最终应通过 disconnectFromTcpDevice(com.android.tradefed.device.ITestDevice) 释放

返回的 ITestDevice 将处于在线状态，但可能无响应。

abstract boolean disconnectFromTcpDevice(ITestDevice tcpDevice)

断开与通过 adb-over-tcp 连接的设备的连接。

abstract void displayDevicesInfo(PrintWriter printWriter, boolean includeStub)

输出包含已知设备列表、设备状态和常用 IDeviceSelection 选项值的用户友好型说明。

abstract CommandResult executeCmdOnAvailableDevice(String serial, String command, long timeout, TimeUnit timeUnit)

一种在可用设备上执行 shell 命令的辅助方法。

abstract ITestDevice forceAllocateDevice(String serial)

粗略地分配设备，即使该设备目前不可用。

abstract void freeDevice(ITestDevice device, FreeDeviceState state)

将设备返回到池中

尝试返回之前未分配的设备将被忽略。

abstract String getAdbPath()

返回要使用的 adb 二进制文件的路径。

abstract String getAdbVersion()

获取设备管理器当前使用的 adb 版本。

abstract DeviceDescriptor getDeviceDescriptor(String serial)

返回具有指定序列号的 DeviceDescriptor。

abstract String getFastbootPath()

返回要使用的 fastboot 二进制文件的路径。

abstract void init(IDeviceSelection globalDeviceFilter, deviceMonitors)

使用设备过滤条件初始化设备管理器。

abstract void init()

初始化设备管理器。

abstract boolean isEmulator(String serial)

确定给定的序列号是否表示模拟器

default boolean isFileSystemMountCheckEnabled()

返回是否应检查 NativeDeviceStateMonitor 文件系统是否已正确装载。

abstract boolean isNullDevice(String serial)

确定给定的序列是否表示空设备

abstract void killEmulator(ITestDevice device)

关闭指定的模拟器。

abstract void launchEmulator(ITestDevice device, long bootTimeout, IRunUtil runUtil, emulatorArgs)

用于启动模拟器的辅助方法。

abstract listAllDevices(boolean shortDescriptor)

返回所有已知设备的 DeviceDescriptor 列表

abstract listAllDevices()

返回所有已知设备的 DeviceDescriptor 列表

abstract ITestDevice reconnectDeviceToTcp(ITestDevice usbDevice)

一种辅助方法，用于将给定的 USB 设备切换到 adb-over-tcp 模式，然后通过 connectToTcpDevice(String) 连接到该设备。

abstract void removeDeviceMonitor(IDeviceMonitor mon)

移除之前添加的 IDeviceMonitor。

abstract void removeFastbootListener(IDeviceManager.IFastbootListener listener)

通知管理器，监听器不再关注 fastboot 状态变化。

default void removeMonitoringTcpFastbootDevice(String serial)
abstract void restartAdbBridge()

重启（如果调用了 stopAdbBridge()）adb 桥接和依赖于 adb 连接的服务。

abstract void stopAdbBridge()

停止 adb 网桥和依赖于 adb 连接的服务。

abstract void terminate()

停止设备监控服务，并终止 ddm 库。

abstract void terminateDeviceMonitor()

停止设备监控器。

abstract void terminateDeviceRecovery()

停止设备恢复线程。

default void terminateHard(String reason)

与 terminateHard() 类似。

abstract void terminateHard()

与 terminate() 类似，但也会尝试强制关闭 adb。

abstract boolean waitForFirstDeviceAdded(long timeout)

等待直到第一个实体设备连接成功。

公共方法

addDeviceMonitor

public abstract void addDeviceMonitor (IDeviceMonitor mon)

添加了 IDeviceMonitor

参数
mon IDeviceMonitor

addFastbootListener

public abstract void addFastbootListener (IDeviceManager.IFastbootListener listener)

通知管理器，监听器对 fastboot 状态变化感兴趣。

目前，如果有一个或多个活跃的监听器，IDeviceManager 将仅监控 fastboot 中的设备。

TODO：这有点像是一种临时解决方案 - 找到更好的解决方案

addMonitoringTcpFastbootDevice

public abstract void addMonitoringTcpFastbootDevice (String serial, 
                String fastboot_serial)

向 fastboot 监控器添加设备。fastboot 监控器将使用“fastboot_serial”与设备通信。

参数
serial String：设备的序列号。
fastboot_serial String：设备的 fastboot 模式序列号。

allocateDevice

public abstract ITestDevice allocateDevice (IDeviceSelection options, 
                boolean isTemporary)

请求满足特定条件的设备以进行测试。

参数
options IDeviceSelection：设备应满足的 IDeviceSelection。
isTemporary boolean：是否应创建临时 NullDevice。
返回
ITestDevice 用于测试的 ITestDevice，如果没有，则为 null

allocateDevice

public abstract ITestDevice allocateDevice (IDeviceSelection options)

请求满足特定条件的设备以进行测试。

参数
options IDeviceSelection：设备应满足的 IDeviceSelection。
返回
ITestDevice 用于测试的 ITestDevice，如果没有，则为 null

allocateDevice

public abstract ITestDevice allocateDevice ()

申请实体设备以进行测试

返回
ITestDevice 用于测试的 ITestDevice，如果没有，则为 null

connectToTcpDevice

public abstract ITestDevice connectToTcpDevice (String ipAndPort)

通过 adb-over-tcp 连接到设备

此方法会分配一个新设备，该设备最终应通过 disconnectFromTcpDevice(com.android.tradefed.device.ITestDevice) 释放

返回的 ITestDevice 将处于在线状态，但可能无响应。

请注意，对已连接 tcp 的设备执行重启等操作会断开与该设备的 tcp 连接，并导致 DeviceNotAvailableException

参数
ipAndPort String：要连接的设备的原始 IP 地址和端口
返回
ITestDevice 如果无法建立 TCP 连接，则为 ITestDevice 或 null

disconnectFromTcpDevice

public abstract boolean disconnectFromTcpDevice (ITestDevice tcpDevice)

断开与通过 adb-over-tcp 连接的设备的连接。

将设备切换回 USB 模式，并释放设备。

参数
tcpDevice ITestDevice：当前处于 TCP 模式的设备，之前通过 connectToTcpDevice(String) 分配
返回
boolean 如果切换到 USB 模式成功，则为 true

displayDevicesInfo

public abstract void displayDevicesInfo (PrintWriter printWriter, 
                boolean includeStub)

输出包含已知设备列表、设备状态以及常用 IDeviceSelection 选项值的用户友好型说明。

参数
printWriter PrintWriter：用于输出说明的 ERROR(/PrintWriter)
includeStub boolean：是否也显示桩设备。

executeCmdOnAvailableDevice

public abstract CommandResult executeCmdOnAvailableDevice (String serial, 
                String command, 
                long timeout, 
                TimeUnit timeUnit)

用于在可用设备上执行 shell 命令的辅助方法。

参数
serial String：设备序列号。
command String：shell 命令。
timeout long：命令完成所需的时间。
timeUnit TimeUnit：超时时间的单位。
返回
CommandResult CommandResult。

forceAllocateDevice

public abstract ITestDevice forceAllocateDevice (String serial)

粗略地分配设备，即使设备目前不可用。

如果设备已分配，则不会有任何效果。

参数
serial String：要分配的设备序列号
返回
ITestDevice ITestDevice；如果无法分配，则为 null

freeDevice

public abstract void freeDevice (ITestDevice device, 
                FreeDeviceState state)

将设备返回到池中

尝试返回之前未分配的设备将被忽略。

参数
device ITestDevice：要释放的 ITestDevice
state FreeDeviceState：FreeDeviceState。用于控制设备是否返回到可用设备池。

getAdbPath

public abstract String getAdbPath ()

返回要使用的 adb 二进制文件的路径。

返回
String

getAdbVersion

public abstract String getAdbVersion ()

获取设备管理器当前使用的 adb 版本。

返回
String

getDeviceDescriptor

public abstract DeviceDescriptor getDeviceDescriptor (String serial)

返回具有指定序列号的 DeviceDescriptor。

参数
serial String：要获取的设备的序列号
返回
DeviceDescriptor 所选设备的 DeviceDescriptor，如果序列号与已知设备不匹配，则为 null。

getFastbootPath

public abstract String getFastbootPath ()

返回要使用的 fastboot 二进制文件的路径。

返回
String

init

public abstract void init (IDeviceSelection globalDeviceFilter, 
                 deviceMonitors)

使用设备过滤器初始化设备管理器。此过滤条件可用于指示 DeviceManager 忽略某些已连接的设备。

参数
globalDeviceFilter IDeviceSelection：设备过滤条件
deviceMonitors

init

public abstract void init ()

初始化设备管理器。必须在调用任何其他方法之前调用此方法一次且仅一次。

isEmulator

public abstract boolean isEmulator (String serial)

确定给定的序列号是否表示模拟器

参数
serial String

返回
boolean

isFileSystemMountCheckEnabled

public boolean isFileSystemMountCheckEnabled ()

返回是否应检查 NativeDeviceStateMonitor 中的文件系统是否已正确装载。

返回
boolean

isNullDevice

public abstract boolean isNullDevice (String serial)

确定给定的序列是否表示 null 设备

参数
serial String

返回
boolean

killEmulator

public abstract void killEmulator (ITestDevice device)

关闭指定的模拟器。

阻塞，直到模拟器从 adb 中消失。如果模拟器已不可用，则不会有任何影响。

参数
device ITestDevice：表示要关闭的模拟器的 ITestDevice
抛出
DeviceNotAvailableException 如果模拟器无法关闭

launchEmulator

public abstract void launchEmulator (ITestDevice device, 
                long bootTimeout, 
                IRunUtil runUtil, 
                 emulatorArgs)

用于启动模拟器的辅助方法。

将按照调用方的指定启动模拟器

参数
device ITestDevice：表示已分配的模拟器设备的占位符 ITestDevice
bootTimeout long：等待模拟器启动的时间（以毫秒为单位）
emulatorArgs ：用于启动模拟器的命令行实参
抛出
DeviceNotAvailableException 如果模拟器无法启动或上线

listAllDevices

public abstract  listAllDevices (boolean shortDescriptor)

返回所有已知设备的 DeviceDescriptor 列表

参数
shortDescriptor boolean：是否将描述符限制为最少信息
返回
所有已知设备的 DeviceDescriptor 列表

listAllDevices

public abstract  listAllDevices ()

返回所有已知设备的 DeviceDescriptor 列表

返回
所有已知设备的 DeviceDescriptor 列表

reconnectDeviceToTcp

public abstract ITestDevice reconnectDeviceToTcp (ITestDevice usbDevice)

一种辅助方法，用于将给定的 USB 设备切换到 adb-over-tcp 模式，然后通过 connectToTcpDevice(String) 连接到该设备。

参数
usbDevice ITestDevice：当前处于 USB 模式的设备
返回
ITestDevice 在 TCP 模式下新分配的 ITestDevice，或者在无法建立 TCP 连接的情况下新分配的 null
抛出
DeviceNotAvailableException 如果与 usbDevice 的连接断开且无法恢复

removeDeviceMonitor

public abstract void removeDeviceMonitor (IDeviceMonitor mon)

移除之前添加的 IDeviceMonitor。如果尚未添加 mon，则此参数无效。

参数
mon IDeviceMonitor

removeFastbootListener

public abstract void removeFastbootListener (IDeviceManager.IFastbootListener listener)

通知管理器，监听器不再关注 fastboot 状态变化。

removeMonitoringTcpFastbootDevice

public void removeMonitoringTcpFastbootDevice (String serial)

参数
serial String

restartAdbBridge

public abstract void restartAdbBridge ()

重启（如果调用了 stopAdbBridge()）adb 网桥和服务取决于 adb 连接。

stopAdbBridge

public abstract void stopAdbBridge ()

停止 adb 桥接和依赖于 adb 连接的服务。

终止

public abstract void terminate ()

停止设备监控服务，并终止 ddm 库。

必须在应用终止时调用此方法。

terminateDeviceMonitor

public abstract void terminateDeviceMonitor ()

停止设备监控器。

terminateDeviceRecovery

public abstract void terminateDeviceRecovery ()

停止设备恢复线程。

terminateHard

public void terminateHard (String reason)

与 terminateHard() 类似。

参数
reason String：终止的可选原因。

terminateHard

public abstract void terminateHard ()

与 terminate() 类似，但也会尝试强制关闭 adb。

waitForFirstDeviceAdded

public abstract boolean waitForFirstDeviceAdded (long timeout)

等待，直到连接上第一个实体设备。如果设备之前已连接，则直接返回 True。如果未添加任何设备，则在超时后返回 false。

参数
timeout long：在返回 false 之前等待的时间（以毫秒为单位）。
返回
boolean