Make IDevice#getSyncService() throws an IOException.

This lets callers differentiate between errors when connecting to adb and
errors because adb couldn't talk to the device.
This commit is contained in:
Xavier Ducrohet
2009-05-14 15:18:56 -07:00
parent dda76aac46
commit 2d83a425c2
6 changed files with 177 additions and 171 deletions

View File

@@ -37,7 +37,7 @@ import java.util.regex.Pattern;
* <p/><b>{@link #init(boolean)} must be called before anything is done.</b>
*/
public final class AndroidDebugBridge {
/*
* Minimum and maximum version of adb supported. This correspond to
* ADB_SERVER_VERSION found in //device/tools/adb/adb.h
@@ -48,7 +48,7 @@ public final class AndroidDebugBridge {
private final static Pattern sAdbVersion = Pattern.compile(
"^.*(\\d+)\\.(\\d+)\\.(\\d+)$"); //$NON-NLS-1$
private final static String ADB = "adb"; //$NON-NLS-1$
private final static String DDMS = "ddms"; //$NON-NLS-1$
@@ -212,7 +212,7 @@ public final class AndroidDebugBridge {
monitorThread.quit();
}
}
/**
* Returns whether the ddmlib is setup to support monitoring and interacting with
* {@link Client}s running on the {@link Device}s.
@@ -220,7 +220,7 @@ public final class AndroidDebugBridge {
static boolean getClientSupport() {
return sClientSupport;
}
/**
* Creates a {@link AndroidDebugBridge} that is not linked to any particular executable.
* <p/>This bridge will expect adb to be running. It will not be able to start/stop/restart
@@ -325,6 +325,7 @@ public final class AndroidDebugBridge {
/**
* Disconnects the current debug bridge, and destroy the object.
* <p/>This also stops the current adb host server.
* <p/>
* A new object will have to be created with {@link #createBridge(String, boolean)}.
*/
@@ -454,21 +455,21 @@ public final class AndroidDebugBridge {
return new Device[0];
}
/**
* Returns whether the bridge has acquired the initial list from adb after being created.
* <p/>Calling {@link #getDevices()} right after {@link #createBridge(String, boolean)} will
* generally result in an empty list. This is due to the internal asynchronous communication
* mechanism with <code>adb</code> that does not guarantee that the {@link Device} list has been
* built before the call to {@link #getDevices()}.
* <p/>The recommended way to get the list of {@link Device} objects is to create a
* <p/>The recommended way to get the list of {@link Device} objects is to create a
* {@link IDeviceChangeListener} object.
*/
public boolean hasInitialDeviceList() {
if (mDeviceMonitor != null) {
return mDeviceMonitor.hasInitialDeviceList();
}
return false;
}
@@ -515,7 +516,7 @@ public final class AndroidDebugBridge {
}
return -1;
}
/**
* Creates a new bridge.
* @param osLocation the location of the command line tool
@@ -529,7 +530,7 @@ public final class AndroidDebugBridge {
checkAdbVersion();
}
/**
* Creates a new bridge not linked to any particular adb executable.
*/
@@ -591,7 +592,7 @@ public final class AndroidDebugBridge {
Log.logAndDisplay(LogLevel.ERROR, ADB,
"Failed to parse the output of 'adb version'"); //$NON-NLS-1$
}
} catch (IOException e) {
Log.logAndDisplay(LogLevel.ERROR, ADB,
"Failed to get the adb version: " + e.getMessage()); //$NON-NLS-1$
@@ -609,7 +610,7 @@ public final class AndroidDebugBridge {
* <p/>
* Returns true when a version number has been found so that we can stop scanning,
* whether the version number is in the acceptable range or not.
*
*
* @param line The line to scan.
* @return True if a version number was found (whether it is acceptable or not).
*/
@@ -666,7 +667,7 @@ public final class AndroidDebugBridge {
}
/**
* Kills the debug bridge.
* Kills the debug bridge, and the adb host server.
* @return true if success
*/
boolean stop() {
@@ -740,7 +741,7 @@ public final class AndroidDebugBridge {
listenersCopy = sDeviceListeners.toArray(
new IDeviceChangeListener[sDeviceListeners.size()]);
}
// Notify the listeners
for (IDeviceChangeListener listener : listenersCopy) {
// we attempt to catch any exception so that a bad listener doesn't kill our
@@ -776,7 +777,7 @@ public final class AndroidDebugBridge {
listenersCopy = sDeviceListeners.toArray(
new IDeviceChangeListener[sDeviceListeners.size()]);
}
// Notify the listeners
for (IDeviceChangeListener listener : listenersCopy) {
// we attempt to catch any exception so that a bad listener doesn't kill our
@@ -812,7 +813,7 @@ public final class AndroidDebugBridge {
listenersCopy = sDeviceListeners.toArray(
new IDeviceChangeListener[sDeviceListeners.size()]);
}
// Notify the listeners
for (IDeviceChangeListener listener : listenersCopy) {
// we attempt to catch any exception so that a bad listener doesn't kill our
@@ -848,7 +849,7 @@ public final class AndroidDebugBridge {
synchronized (sLock) {
listenersCopy = sClientListeners.toArray(
new IClientChangeListener[sClientListeners.size()]);
}
// Notify the listeners
@@ -962,7 +963,7 @@ public final class AndroidDebugBridge {
* @param errorOutput The array to store the stderr output. cannot be null.
* @param stdOutput The array to store the stdout output. cannot be null.
* @param displayStdOut If true this will display stdout as well
* @param waitforReaders if true, this will wait for the reader threads.
* @param waitforReaders if true, this will wait for the reader threads.
* @return the process return code.
* @throws InterruptedException
*/

View File

@@ -208,7 +208,7 @@ public final class Device implements IDevice {
* (non-Javadoc)
* @see com.android.ddmlib.IDevice#getSyncService()
*/
public SyncService getSyncService() {
public SyncService getSyncService() throws IOException {
SyncService syncService = new SyncService(AndroidDebugBridge.sSocketAddr, this);
if (syncService.openSync()) {
return syncService;

View File

@@ -118,9 +118,11 @@ public interface IDevice {
/**
* Returns a {@link SyncService} object to push / pull files to and from the device.
* @return <code>null</code> if the SyncService couldn't be created.
* @return <code>null</code> if the SyncService couldn't be created. This can happen if abd
* refuse to open the connection because the {@link IDevice} is invalid (or got disconnected).
* @throws IOException if the connection with adb failed.
*/
public SyncService getSyncService();
public SyncService getSyncService() throws IOException;
/**
* Returns a {@link FileListingService} for this device.

View File

@@ -209,9 +209,11 @@ public final class SyncService {
/**
* Opens the sync connection. This must be called before any calls to push[File] / pull[File].
* @return true if the connection opened, false otherwise.
* @return true if the connection opened, false if adb refuse the connection. This can happen
* if the {@link Device} is invalid.
* @throws IOException If the connection to adb failed.
*/
boolean openSync() {
boolean openSync() throws IOException {
try {
mChannel = SocketChannel.open(mAddress);
mChannel.configureBlocking(false);
@@ -236,13 +238,15 @@ public final class SyncService {
if (mChannel != null) {
try {
mChannel.close();
} catch (IOException e1) {
// we do nothing, since we'll return false just below
} catch (IOException e2) {
// we want to throw the original exception, so we ignore this one.
}
mChannel = null;
return false;
}
throw e;
}
return true;
}