com.polidea.rxandroidble2.exceptions

Class BleScanException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.polidea.rxandroidble2.exceptions.BleException

com.polidea.rxandroidble2.exceptions.BleScanException

All Implemented Interfaces:

java.io.Serializable

public class BleScanException
extends BleException

Exception emitted as a result of faulty scan operation. The reason describes the situation in details.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BleScanException.Reason

Field Summary

Fields

Modifier and Type	Field and Description
static int	BLUETOOTH_CANNOT_START Scan did not start correctly because of unspecified error.
static int	BLUETOOTH_DISABLED Scan did not start correctly because the Bluetooth adapter was disabled.
static int	BLUETOOTH_NOT_AVAILABLE Scan did not start correctly because the device does not support it.
static int	LOCATION_PERMISSION_MISSING Scan did not start correctly because the user did not accept access to location services.
static int	LOCATION_SERVICES_DISABLED Scan did not start because location services are disabled on the device.
static int	SCAN_FAILED_ALREADY_STARTED Fails to start scan as BLE scan with the same settings is already started by the app.
static int	SCAN_FAILED_APPLICATION_REGISTRATION_FAILED Fails to start scan as app cannot be registered.
static int	SCAN_FAILED_FEATURE_UNSUPPORTED Fails to start power optimized scan as this feature is not supported.
static int	SCAN_FAILED_INTERNAL_ERROR Fails to start scan due an internal error.
static int	SCAN_FAILED_OUT_OF_HARDWARE_RESOURCES Fails to start scan as it is out of hardware resources.
static int	UNDOCUMENTED_SCAN_THROTTLE On API >=25 there is an undocumented scan throttling mechanism.
static int	UNKNOWN_ERROR_CODE Unknown error code.

Constructor Summary

Constructors

Constructor and Description
BleScanException(int reason)
BleScanException(int reason, java.util.Date retryDateSuggestion)
BleScanException(int reason, java.lang.Throwable causeException)

Method Summary

Modifier and Type	Method and Description
int	getReason() Returns the reason code of scan failure.
java.util.Date	getRetryDateSuggestion() Returns a Date suggestion when a particular BleScanException.Reason should no longer be valid

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BLUETOOTH_CANNOT_START

public static final int BLUETOOTH_CANNOT_START

Scan did not start correctly because of unspecified error.

See Also:

Constant Field Values

BLUETOOTH_DISABLED

public static final int BLUETOOTH_DISABLED

Scan did not start correctly because the Bluetooth adapter was disabled. Ask the user to turn on Bluetooth or use android.bluetooth.adapter.action.REQUEST_ENABLE

See Also:

Constant Field Values

BLUETOOTH_NOT_AVAILABLE

public static final int BLUETOOTH_NOT_AVAILABLE

Scan did not start correctly because the device does not support it.

See Also:

Constant Field Values

LOCATION_PERMISSION_MISSING

public static final int LOCATION_PERMISSION_MISSING

Scan did not start correctly because the user did not accept access to location services. On Android 6.0 and up you must ask the user about ACCESS_COARSE_LOCATION in runtime.

See Also:

Constant Field Values

LOCATION_SERVICES_DISABLED

public static final int LOCATION_SERVICES_DISABLED

Scan did not start because location services are disabled on the device. On Android 6.0 and up location services must be enabled in order to receive BLE scan results.

See Also:

Constant Field Values

SCAN_FAILED_ALREADY_STARTED

public static final int SCAN_FAILED_ALREADY_STARTED

Fails to start scan as BLE scan with the same settings is already started by the app. Only on API >=21.

See Also:

Constant Field Values

SCAN_FAILED_APPLICATION_REGISTRATION_FAILED

public static final int SCAN_FAILED_APPLICATION_REGISTRATION_FAILED

Fails to start scan as app cannot be registered. Only on API >=21.

See Also:

Constant Field Values

SCAN_FAILED_INTERNAL_ERROR

public static final int SCAN_FAILED_INTERNAL_ERROR

Fails to start scan due an internal error. Only on API >=21.

See Also:

Constant Field Values

SCAN_FAILED_FEATURE_UNSUPPORTED

public static final int SCAN_FAILED_FEATURE_UNSUPPORTED

Fails to start power optimized scan as this feature is not supported. Only on API >=21.

See Also:

Constant Field Values

SCAN_FAILED_OUT_OF_HARDWARE_RESOURCES

public static final int SCAN_FAILED_OUT_OF_HARDWARE_RESOURCES

Fails to start scan as it is out of hardware resources. Only on API >=21.

See Also:

Constant Field Values

UNDOCUMENTED_SCAN_THROTTLE

public static final int UNDOCUMENTED_SCAN_THROTTLE

On API >=25 there is an undocumented scan throttling mechanism. If 5 scans were started by the app during a 30 second window the next scan in that window will be silently skipped with only a log warning. In this situation there should be a retryDateSuggestion Date set with a time when the scan should work again.

See Also:

Constant Field Values

UNKNOWN_ERROR_CODE

public static final int UNKNOWN_ERROR_CODE

Unknown error code. Only on API >=21.

See Also:

Constant Field Values

Constructor Detail

BleScanException

public BleScanException(int reason)

BleScanException

public BleScanException(int reason,
                        java.util.Date retryDateSuggestion)

BleScanException

public BleScanException(int reason,
                        java.lang.Throwable causeException)

Method Detail

getReason

public int getReason()

Returns the reason code of scan failure.

Returns:

One of the BleScanException.Reason codes.

getRetryDateSuggestion

public java.util.Date getRetryDateSuggestion()

Returns a Date suggestion when a particular BleScanException.Reason should no longer be valid

Returns:

the date suggestion or null if no suggestion available