IDeviceManager

public interface IDeviceManager

com.android.tradefed.device.IDeviceManager
Known Indirect Subclasses


Interface for managing the set of available devices for testing.

Summary

Nested classes

interface IDeviceManager.IFastbootListener

A listener for fastboot state changes. 

Public methods

abstract void addDeviceMonitor(IDeviceMonitor mon)

Adds a IDeviceMonitor

abstract void addFastbootListener(IDeviceManager.IFastbootListener listener)

Informs the manager that a listener is interested in fastboot state changes.

abstract ITestDevice allocateDevice(IDeviceSelection options)

Request a device for testing that meets certain criteria.

abstract ITestDevice allocateDevice()

Request a physical device for testing

abstract ITestDevice connectToTcpDevice(String ipAndPort)

Connect to a device with adb-over-tcp

This method allocates a new device, which should eventually be freed via disconnectFromTcpDevice(ITestDevice)

The returned ITestDevice will be online, but may not be responsive.

abstract boolean disconnectFromTcpDevice(ITestDevice tcpDevice)

Disconnect from an adb-over-tcp connected device.

abstract void displayDevicesInfo(PrintWriter printWriter)

Output a user-friendly description containing list of known devices, their state, and values for commonly used IDeviceSelection options.

abstract ITestDevice forceAllocateDevice(String serial)

Rudely allocate a device, even if its not currently available.

abstract void freeDevice(ITestDevice device, FreeDeviceState state)

Return a device to the pool

Attempts to return a device that hasn't been previously allocated will be ignored.

abstract String getFastbootPath()

Returns the path to the fastboot binary path to use.

abstract void init(IDeviceSelection globalDeviceFilter, List<IDeviceMonitor> deviceMonitors)

Initialize the device manager with a device filter.

abstract void init()

Initialize the device manager.

abstract boolean isEmulator(String serial)

Determine if given serial represents a emulator

abstract boolean isNullDevice(String serial)

Determine if given serial represents a null device

abstract void killEmulator(ITestDevice device)

Shut down the given emulator.

abstract void launchEmulator(ITestDevice device, long bootTimeout, IRunUtil runUtil, List<String> emulatorArgs)

Helper method to launch emulator.

abstract List<DeviceDescriptor> listAllDevices()

Returns a map of all known devices and their state

abstract ITestDevice reconnectDeviceToTcp(ITestDevice usbDevice)

A helper method that switches the given usb device to adb-over-tcp mode, and then connects to it via connectToTcpDevice(String).

abstract void removeDeviceMonitor(IDeviceMonitor mon)

Removes a previously added IDeviceMonitor.

abstract void removeFastbootListener(IDeviceManager.IFastbootListener listener)

Informs the manager that a listener is no longer interested in fastboot state changes.

abstract void terminate()

Stops device monitoring services, and terminates the ddm library.

abstract void terminateDeviceRecovery()

Stops the device recovery thread.

abstract void terminateHard()

Like terminate(), but attempts to forcefully shut down adb as well.

abstract boolean waitForFirstDeviceAdded(long timeout)

Wait until a first physical device is connected.

Public methods

addDeviceMonitor

void addDeviceMonitor (IDeviceMonitor mon)

Adds a IDeviceMonitor

Parameters
mon IDeviceMonitor

addFastbootListener

void addFastbootListener (IDeviceManager.IFastbootListener listener)

Informs the manager that a listener is interested in fastboot state changes.

Currently a IDeviceManager will only monitor devices in fastboot if there are one or more active listeners.

TODO: this is a bit of a hack - find a better solution

allocateDevice

ITestDevice allocateDevice (IDeviceSelection options)

Request a device for testing that meets certain criteria.

Parameters
options IDeviceSelection: the IDeviceSelection the device should meet.
Returns
ITestDevice a ITestDevice for testing, or null if one is not available

allocateDevice

ITestDevice allocateDevice ()

Request a physical device for testing

Returns
ITestDevice a ITestDevice for testing, or null if one is not available

connectToTcpDevice

ITestDevice connectToTcpDevice (String ipAndPort)

Connect to a device with adb-over-tcp

This method allocates a new device, which should eventually be freed via disconnectFromTcpDevice(ITestDevice)

The returned ITestDevice will be online, but may not be responsive.

Note that performing action such as a reboot on a tcp connected device, will sever the tcp connection to the device, and result in a DeviceNotAvailableException

Parameters
ipAndPort String: the original ip address and port of the device to connect to
Returns
ITestDevice the ITestDevice or null if a tcp connection could not be formed

disconnectFromTcpDevice

boolean disconnectFromTcpDevice (ITestDevice tcpDevice)

Disconnect from an adb-over-tcp connected device.

Switches the device back to usb mode, and frees it.

Parameters
tcpDevice ITestDevice: the device currently in tcp mode, previously allocated via connectToTcpDevice(String)
Returns
boolean true if switch to usb mode was successful

displayDevicesInfo

void displayDevicesInfo (PrintWriter printWriter)

Output a user-friendly description containing list of known devices, their state, and values for commonly used IDeviceSelection options.

Parameters
printWriter PrintWriter: the PrintWriter to output the description to

forceAllocateDevice

ITestDevice forceAllocateDevice (String serial)

Rudely allocate a device, even if its not currently available.

Will have no effect if device is already allocated.

Parameters
serial String: the device serial to allocate
Returns
ITestDevice the ITestDevice, or null if it could not be allocated

freeDevice

void freeDevice (ITestDevice device, 
                FreeDeviceState state)

Return a device to the pool

Attempts to return a device that hasn't been previously allocated will be ignored.

Parameters
device ITestDevice: the ITestDevice to free
state FreeDeviceState: the FreeDeviceState. Used to control if device is returned to available device pool.

getFastbootPath

String getFastbootPath ()

Returns the path to the fastboot binary path to use.

Returns
String

init

void init (IDeviceSelection globalDeviceFilter, 
                List<IDeviceMonitor> deviceMonitors)

Initialize the device manager with a device filter. This filter can be used to instruct the DeviceManager to ignore certain connected devices.

Parameters
globalDeviceFilter IDeviceSelection: the device filter
deviceMonitors List

init

void init ()

Initialize the device manager. This must be called once and only once before any other methods are called.

isEmulator

boolean isEmulator (String serial)

Determine if given serial represents a emulator

Parameters
serial String
Returns
boolean

isNullDevice

boolean isNullDevice (String serial)

Determine if given serial represents a null device

Parameters
serial String
Returns
boolean

killEmulator

void killEmulator (ITestDevice device)

Shut down the given emulator.

Blocks until emulator disappears from adb. Will have no effect if emulator is already not available.

Parameters
device ITestDevice: the ITestDevice representing emulator to shut down
Throws
DeviceNotAvailableException if emulator fails to shut down

launchEmulator

void launchEmulator (ITestDevice device, 
                long bootTimeout, 
                IRunUtil runUtil, 
                List<String> emulatorArgs)

Helper method to launch emulator.

Will launch the emulator as specified by the caller

Parameters
device ITestDevice: the placeholder ITestDevice representing allocated emulator device
bootTimeout long: the time in ms to wait for the emulator to boot
emulatorArgs List: command line arguments to launch the emulator
Throws
DeviceNotAvailableException if emulator fails to boot or come online

listAllDevices

List<DeviceDescriptor> listAllDevices ()

Returns a map of all known devices and their state

Returns
List<DeviceDescriptor> a list of device serials and their DeviceAllocationState

reconnectDeviceToTcp

ITestDevice reconnectDeviceToTcp (ITestDevice usbDevice)

A helper method that switches the given usb device to adb-over-tcp mode, and then connects to it via connectToTcpDevice(String).

Parameters
usbDevice ITestDevice: the device currently in usb mode
Returns
ITestDevice the newly allocated ITestDevice in tcp mode or null if a tcp connection could not be formed
Throws
DeviceNotAvailableException if the connection with usbDevice was lost and could not be recovered

removeDeviceMonitor

void removeDeviceMonitor (IDeviceMonitor mon)

Removes a previously added IDeviceMonitor. Has no effect if mon has not been added.

Parameters
mon IDeviceMonitor

removeFastbootListener

void removeFastbootListener (IDeviceManager.IFastbootListener listener)

Informs the manager that a listener is no longer interested in fastboot state changes.

terminate

void terminate ()

Stops device monitoring services, and terminates the ddm library.

This must be called upon application termination.

See also:

terminateDeviceRecovery

void terminateDeviceRecovery ()

Stops the device recovery thread.

terminateHard

void terminateHard ()

Like terminate(), but attempts to forcefully shut down adb as well.

waitForFirstDeviceAdded

boolean waitForFirstDeviceAdded (long timeout)

Wait until a first physical device is connected. If a device was connected before, it returns directly True. If no device was added, it returns false after timeout.

Parameters
timeout long: time to wait in millisecond before returning false.
Returns
boolean