Added GATT status code to a BleDisconnectException

rxandroidble/src/main/java/com/polidea/rxandroidble2/exceptions/BleAdapterDisabledException.java

@@ -0,0 +1,5 @@
+package com.polidea.rxandroidble2.exceptions;
+
+public class BleAdapterDisabledException extends BleException {
+    // Disconnection related to disabled Bluetooth adapter
+}

rxandroidble/src/main/java/com/polidea/rxandroidble2/exceptions/BleDisconnectedException.java

@@ -2,6 +2,9 @@
 
 import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
+import android.support.annotation.RestrictTo;
+
+import com.polidea.rxandroidble2.utils.GattStatusParser;
 
 /**
  * Exception emitted when the BLE link has been disconnected either when the connection was already established
@@ -12,26 +15,63 @@
  */
 public class BleDisconnectedException extends BleException {
 
+    /**
+     * Set when the state is not available, for example when the adapter has been switched off.
+     */
+    public static final int UNKNOWN_STATUS = -1;
+
     @SuppressWarnings("WeakerAccess")
     @NonNull
     public final String bluetoothDeviceAddress;
+    public final int state;
+
+    public static BleDisconnectedException adapterDisabled(String macAddress) {
+        return new BleDisconnectedException(new BleAdapterDisabledException(), macAddress, UNKNOWN_STATUS);
+    }
 
+    /**
+     * @deprecated In general, there's no place in a public API that requires you to instantiate this exception directly.
+     * If you use it anyway, please switch to {@link #BleDisconnectedException(String, int)}
+     */
     @Deprecated
     public BleDisconnectedException() {
-        bluetoothDeviceAddress = "";
+        this("", UNKNOWN_STATUS);
     }
 
+    /**
+     * @deprecated In general, there's no place in a public API that requires you to instantiate this exception directly.
+     * If you use it anyway, please switch to {@link #BleDisconnectedException(Throwable, String, int)}
+     */
+    @Deprecated
     public BleDisconnectedException(Throwable throwable, @NonNull String bluetoothDeviceAddress) {
-        super(createMessage(bluetoothDeviceAddress), throwable);
-        this.bluetoothDeviceAddress = bluetoothDeviceAddress;
+        this(throwable, bluetoothDeviceAddress, UNKNOWN_STATUS);
     }
 
+    /**
+     * @deprecated In general, there's no place in a public API that requires you to instantiate this exception directly.
+     * If you use it anyway, please switch to {@link #BleDisconnectedException(String, int)} or don't use it.
+     */
+    @Deprecated
     public BleDisconnectedException(@NonNull String bluetoothDeviceAddress) {
-        super(createMessage(bluetoothDeviceAddress));
+        this(bluetoothDeviceAddress, UNKNOWN_STATUS);
+    }
+
+    @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+    public BleDisconnectedException(Throwable throwable, @NonNull String bluetoothDeviceAddress, int status) {
+        super(createMessage(bluetoothDeviceAddress, status), throwable);
+        this.bluetoothDeviceAddress = bluetoothDeviceAddress;
+        this.state = status;
+    }
+
+    @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+    public BleDisconnectedException(@NonNull String bluetoothDeviceAddress, int status) {
+        super(createMessage(bluetoothDeviceAddress, status));
         this.bluetoothDeviceAddress = bluetoothDeviceAddress;
+        this.state = status;
     }
 
-    private static String createMessage(@Nullable String bluetoothDeviceAddress) {
-        return "Disconnected from " + bluetoothDeviceAddress;
+    private static String createMessage(@Nullable String bluetoothDeviceAddress, int status) {
+        final String gattCallbackStatusDescription = GattStatusParser.getGattCallbackStatusDescription(status);
+        return "Disconnected from " + bluetoothDeviceAddress + " with status " + status + " (" + gattCallbackStatusDescription + ")";
     }
 }

rxandroidble/src/main/java/com/polidea/rxandroidble2/exceptions/BleGattException.java

@@ -5,6 +5,8 @@
 import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
 
+import com.polidea.rxandroidble2.utils.GattStatusParser;
+
 /**
  * Exception emitted when the BLE link has been interrupted as a result of an error. The exception contains
  * detailed explanation of the error source (type of operation) and the code proxied from
@@ -65,9 +67,10 @@ private static String createMessage(@Nullable BluetoothGatt gatt, int status, Bl
                     getMacAddress(gatt), bleGattOperationType);
         }
 
+        final String statusDescription = GattStatusParser.getGattCallbackStatusDescription(status);
         final String link
                 = "https://android.googlesource.com/platform/external/bluetooth/bluedroid/+/android-5.1.0_r1/stack/include/gatt_api.h";
-        return String.format("GATT exception from MAC address %s, status %d, type %s. (Look up status 0x%02x here %s)",
-                getMacAddress(gatt), status, bleGattOperationType, status, link);
+        return String.format("GATT exception from MAC address %s, status %d (%s), type %s. (Look up status 0x%02x here %s)",
+                getMacAddress(gatt), status, statusDescription, bleGattOperationType, status, link);
     }
 }

rxandroidble/src/main/java/com/polidea/rxandroidble2/internal/SingleResponseOperation.java

@@ -93,6 +93,7 @@ protected Single<T> timeoutFallbackProcedure(
 
     @Override
     protected BleException provideException(DeadObjectException deadObjectException) {
-        return new BleDisconnectedException(deadObjectException, bluetoothGatt.getDevice().getAddress());
+        return new BleDisconnectedException(deadObjectException, bluetoothGatt.getDevice().getAddress(),
+                BleDisconnectedException.UNKNOWN_STATUS);
     }
 }

rxandroidble/src/main/java/com/polidea/rxandroidble2/internal/connection/DisconnectionRouter.java

@@ -54,7 +54,7 @@ One of those events must happen eventually. Then the adapterStateObservable (whi
                 .map(new Function<Boolean, BleException>() {
                     @Override
                     public BleException apply(Boolean isAdapterUsable) {
-                        return new BleDisconnectedException(macAddress); // TODO: Introduce BleDisabledException?
+                        return BleDisconnectedException.adapterDisabled(macAddress);
                     }
                 })
                 .firstElement()

rxandroidble/src/main/java/com/polidea/rxandroidble2/internal/connection/RxBleConnectionImpl.java

@@ -354,7 +354,8 @@ public void run() {
 
             @Override
             protected BleException provideException(DeadObjectException deadObjectException) {
-                return new BleDisconnectedException(deadObjectException, bluetoothGatt.getDevice().getAddress());
+                return new BleDisconnectedException(deadObjectException, bluetoothGatt.getDevice().getAddress(),
+                        BleDisconnectedException.UNKNOWN_STATUS);
             }
 
             @Override

rxandroidble/src/main/java/com/polidea/rxandroidble2/internal/connection/RxBleGattCallback.java

@@ -74,7 +74,7 @@ public void onConnectionStateChange(BluetoothGatt gatt, int status, int newState
             bluetoothGattProvider.updateBluetoothGatt(gatt);
 
             if (isDisconnectedOrDisconnecting(newState)) {
-                disconnectionRouter.onDisconnectedException(new BleDisconnectedException(gatt.getDevice().getAddress()));
+                disconnectionRouter.onDisconnectedException(new BleDisconnectedException(gatt.getDevice().getAddress(), status));
             } else if (status != BluetoothGatt.GATT_SUCCESS) {
                 disconnectionRouter.onGattConnectionStateException(
                         new BleGattException(gatt, status, BleGattOperationType.CONNECTION_STATE)

rxandroidble/src/main/java/com/polidea/rxandroidble2/internal/operations/CharacteristicLongWriteOperation.java

@@ -127,7 +127,8 @@ public void onComplete() {
 
     @Override
     protected BleException provideException(DeadObjectException deadObjectException) {
-        return new BleDisconnectedException(deadObjectException, bluetoothGatt.getDevice().getAddress());
+        return new BleDisconnectedException(deadObjectException, bluetoothGatt.getDevice().getAddress(),
+                BleDisconnectedException.UNKNOWN_STATUS);
     }
 
     @NonNull

rxandroidble/src/main/java/com/polidea/rxandroidble2/internal/operations/ConnectOperation.java

@@ -176,6 +176,6 @@ public BluetoothGatt call() {
 
     @Override
     protected BleException provideException(DeadObjectException deadObjectException) {
-        return new BleDisconnectedException(deadObjectException, bluetoothDevice.getAddress());
+        return new BleDisconnectedException(deadObjectException, bluetoothDevice.getAddress(), BleDisconnectedException.UNKNOWN_STATUS);
     }
 }

rxandroidble/src/main/java/com/polidea/rxandroidble2/internal/operations/DisconnectOperation.java

@@ -168,6 +168,6 @@ public void run() {
 
     @Override
     protected BleException provideException(DeadObjectException deadObjectException) {
-        return new BleDisconnectedException(deadObjectException, macAddress);
+        return new BleDisconnectedException(deadObjectException, macAddress, BleDisconnectedException.UNKNOWN_STATUS);
     }
 }

rxandroidble/src/main/java/com/polidea/rxandroidble2/internal/serialization/ConnectionOperationQueueImpl.java

@@ -156,6 +156,6 @@ public void onError(Throwable throwable) {
     public void onConnectionUnsubscribed() {
         disconnectionThrowableSubscription.dispose();
         disconnectionThrowableSubscription = null;
-        terminate(new BleDisconnectedException(deviceMacAddress));
+        terminate(new BleDisconnectedException(deviceMacAddress, BleDisconnectedException.UNKNOWN_STATUS));
     }
 }

rxandroidble/src/main/java/com/polidea/rxandroidble2/utils/GattStatusParser.java

@@ -0,0 +1,95 @@
+/**
+ * Parsing thanks to
+ * https://github.com/adafruit/Bluefruit_LE_Connect_Android/blob/
+ * master/app/src/main/java/com/adafruit/bluefruit/le/connect/ble/StandardUUIDs.java
+ * Bluefruit LE Connect for Android
+ * <p>
+ * <p>
+ * The MIT License (MIT)
+ * <p>
+ * Copyright (c) 2015 Adafruit Industries
+ * <p>
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * <p>
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * <p>
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.polidea.rxandroidble2.utils;
+
+import android.annotation.SuppressLint;
+
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+
+public class GattStatusParser {
+
+    private static final Map<Integer, String> GATT_STATUS;
+
+    static {
+        @SuppressLint("UseSparseArrays") Map<Integer, String> aMap = new HashMap<>();
+        aMap.put(0x00, "GATT_SUCCESS");
+        aMap.put(0x01, "GATT_INVALID_HANDLE");
+        aMap.put(0x02, "GATT_READ_NOT_PERMIT");
+        aMap.put(0x03, "GATT_WRITE_NOT_PERMIT");
+        aMap.put(0x04, "GATT_INVALID_PDU");
+        aMap.put(0x05, "GATT_INSUF_AUTHENTICATION");
+        aMap.put(0x06, "GATT_REQ_NOT_SUPPORTED");
+        aMap.put(0x07, "GATT_INVALID_OFFSET");
+        aMap.put(0x08, "GATT_INSUF_AUTHORIZATION");
+        aMap.put(0x09, "GATT_PREPARE_Q_FULL");
+        aMap.put(0x0a, "GATT_NOT_FOUND");
+        aMap.put(0x0b, "GATT_NOT_LONG");
+        aMap.put(0x0c, "GATT_INSUF_KEY_SIZE");
+        aMap.put(0x0d, "GATT_INVALID_ATTR_LEN");
+        aMap.put(0x0e, "GATT_ERR_UNLIKELY");
+        aMap.put(0x0f, "GATT_INSUF_ENCRYPTION");
+        aMap.put(0x10, "GATT_UNSUPPORT_GRP_TYPE");
+        aMap.put(0x11, "GATT_INSUF_RESOURCE");
+
+        aMap.put(0x87, "GATT_ILLEGAL_PARAMETER");
+        aMap.put(0x80, "GATT_NO_RESOURCES");
+        aMap.put(0x81, "GATT_INTERNAL_ERROR");
+        aMap.put(0x82, "GATT_WRONG_STATE");
+        aMap.put(0x83, "GATT_DB_FULL");
+        aMap.put(0x84, "GATT_BUSY");
+        aMap.put(0x85, "GATT_ERROR");
+        aMap.put(0x86, "GATT_CMD_STARTED");
+        aMap.put(0x88, "GATT_PENDING");
+        aMap.put(0x89, "GATT_AUTH_FAIL");
+        aMap.put(0x8a, "GATT_MORE");
+        aMap.put(0x8b, "GATT_INVALID_CFG");
+        aMap.put(0x8c, "GATT_SERVICE_STARTED");
+        aMap.put(0x00, "GATT_SUCCESS");
+        aMap.put(0x8d, "GATT_ENCRYPED_NO_MITM");
+        aMap.put(0x8e, "GATT_NOT_ENCRYPTED");
+        aMap.put(0x8f, "GATT_CONGESTED");
+
+        aMap.put(0xfd, "GATT_CCC_CFG_ERR");
+        aMap.put(0xfe, "GATT_PRC_IN_PROGRESS");
+        aMap.put(0xff, "GATT_OUT_OF_RANGE");
+        GATT_STATUS = Collections.unmodifiableMap(aMap);
+    }
+
+    private GattStatusParser() {
+        // utility class
+    }
+
+    public static String getGattCallbackStatusDescription(int status) {
+        final String description = GATT_STATUS.get(status);
+        return description == null ? "UNKNOWN" : description;
+    }
+}

rxandroidble/src/test/groovy/com/polidea/rxandroidble2/exceptions/BleDisconnectedExceptionTest.groovy

@@ -9,13 +9,25 @@ class BleDisconnectedExceptionTest extends Specification {
 
     BleDisconnectedException objectUnderTest
 
-    def "toString should include message"() {
+    def "toString should include message with unknown status"() {
 
         when:
         objectUnderTest = new BleDisconnectedException("myBluetoothAddress")
 
         then:
         assert objectUnderTest.toString() ==
-                "com.polidea.rxandroidble2.exceptions.BleDisconnectedException: Disconnected from myBluetoothAddress"
+                "com.polidea.rxandroidble2.exceptions.BleDisconnectedException: Disconnected from myBluetoothAddress with status -1 (UNKNOWN)"
+    }
+
+    def "toString should include message with status"() {
+        given:
+        def expectedStatus = 0x81
+
+        when:
+        objectUnderTest = new BleDisconnectedException("myBluetoothAddress", expectedStatus)
+
+        then:
+        assert objectUnderTest.toString() ==
+                "com.polidea.rxandroidble2.exceptions.BleDisconnectedException: Disconnected from myBluetoothAddress with status $expectedStatus (GATT_INTERNAL_ERROR)"
     }
 }

rxandroidble/src/test/groovy/com/polidea/rxandroidble2/exceptions/BleGattExceptionTest.groovy

@@ -16,7 +16,7 @@ class BleGattExceptionTest extends Specification {
 
         then:
         assert objectUnderTest.toString() ==
-                "com.polidea.rxandroidble2.exceptions.BleGattException: GATT exception from MAC address null, status 10, " +
+                "com.polidea.rxandroidble2.exceptions.BleGattException: GATT exception from MAC address null, status 10 (GATT_NOT_FOUND), " +
                 "type BleGattOperation{description='CONNECTION_STATE'}. " +
                 "(Look up status 0x0a here " +
                 "https://android.googlesource.com/platform/external/bluetooth/bluedroid/+/android-5.1.0_r1/stack/include/gatt_api.h)"