no.nordicsemi.android.ble

Class TimeoutableRequest

java.lang.Object

no.nordicsemi.android.ble.Request

no.nordicsemi.android.ble.TimeoutableRequest

Direct Known Subclasses:

ConnectRequest, DisconnectRequest, TimeoutableValueRequest

public abstract class TimeoutableRequest
extends Request

Field Summary

Fields

Modifier and Type	Field and Description
protected long	timeout

Fields inherited from class no.nordicsemi.android.ble.Request

handler, requestHandler

Method Summary

Modifier and Type	Method and Description
void	await() Synchronously waits until the request is done.
void	await(long timeout) Deprecated. Use timeout(long) and await() instead.
void	enqueue() Enqueues the request for asynchronous execution.
void	enqueue(long timeout) Deprecated. Use timeout(long) and enqueue() instead.
TimeoutableRequest	setHandler(android.os.Handler handler) Sets the handler that will be used to invoke callbacks.
TimeoutableRequest	timeout(long timeout) Sets the operation timeout.

Methods inherited from class no.nordicsemi.android.ble.Request

before, createBond, done, fail, invalid, newConnectionPriorityRequest, newDisableBatteryLevelNotificationsRequest, newDisableIndicationsRequest, newDisableNotificationsRequest, newEnableBatteryLevelNotificationsRequest, newEnableIndicationsRequest, newEnableNotificationsRequest, newMtuRequest, newReadBatteryLevelRequest, newReadPhyRequest, newReadRequest, newReadRequest, newReadRssiRequest, newRefreshCacheRequest, newSetPreferredPhyRequest, newSleepRequest, newWaitForIndicationRequest, newWaitForNotificationRequest, newWriteRequest, newWriteRequest, newWriteRequest, newWriteRequest, newWriteRequest, newWriteRequest, removeBond

Methods inherited from class java.lang.Object

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

Field Detail

timeout

protected long timeout

Method Detail

setHandler

@NonNull
public TimeoutableRequest setHandler(@NonNull
                                               android.os.Handler handler)

Description copied from class: Request

Sets the handler that will be used to invoke callbacks. By default, the handler set in BleManager will be used.

Overrides:

setHandler in class Request

Parameters:

handler - The handler to invoke callbacks for this request.

Returns:

The request.

timeout

@NonNull
public TimeoutableRequest timeout(long timeout)

Sets the operation timeout. When the timeout occurs, the request will fail with FailCallback.REASON_TIMEOUT.

Parameters:

timeout - the request timeout in milliseconds, 0 to disable timeout.

Returns:

the callback.

Throws:

java.lang.IllegalStateException - thrown when the request has already been started.

java.lang.UnsupportedOperationException - thrown when the timeout is not allowed for this request, as the callback from the system is required.

enqueue

public final void enqueue()

Enqueues the request for asynchronous execution.

Use timeout(long) to set the maximum time the manager should wait until the device is ready. When the timeout occurs, the request will fail with FailCallback.REASON_TIMEOUT and the device will get disconnected.

Overrides:

enqueue in class Request

enqueue

@Deprecated
public final void enqueue(long timeout)

Deprecated. Use timeout(long) and enqueue() instead.

Enqueues the request for asynchronous execution.

When the timeout occurs, the request will fail with FailCallback.REASON_TIMEOUT and the device will get disconnected.

Parameters:

timeout - the request timeout in milliseconds, 0 to disable timeout. This value will override one set in timeout(long).

await

public final void await()
                 throws RequestFailedException,
                        DeviceDisconnectedException,
                        BluetoothDisabledException,
                        InvalidRequestException,
                        java.lang.InterruptedException

Synchronously waits until the request is done.

Use timeout(long) to set the maximum time the manager should wait until the request is ready. When the timeout occurs, the InterruptedException will be thrown.

Callbacks set using Request.done(SuccessCallback) and Request.fail(FailCallback) will be ignored.

This method may not be called from the main (UI) thread.

Throws:

RequestFailedException - thrown when the BLE request finished with status other than BluetoothGatt.GATT_SUCCESS.

java.lang.InterruptedException - thrown if the timeout occurred before the request has finished.

java.lang.IllegalStateException - thrown when you try to call this method from the main (UI) thread.

DeviceDisconnectedException - thrown when the device disconnected before the request was completed.

BluetoothDisabledException - thrown when the Bluetooth adapter has been disabled.

InvalidRequestException - thrown when the request was called before the device was connected at least once (unknown device).

See Also:

enqueue()

await

@Deprecated
public final void await(long timeout)
                              throws RequestFailedException,
                                     java.lang.InterruptedException,
                                     DeviceDisconnectedException,
                                     BluetoothDisabledException,
                                     InvalidRequestException

Deprecated. Use timeout(long) and await() instead.

Synchronously waits, for as most as the given number of milliseconds, until the request is ready.

When the timeout occurs, the InterruptedException will be thrown.

Callbacks set using Request.done(SuccessCallback) and Request.fail(FailCallback) will be ignored.

This method may not be called from the main (UI) thread.

Parameters:

timeout - optional timeout in milliseconds, 0 to disable timeout. This will override the timeout set using timeout(long).

Throws:

RequestFailedException - thrown when the BLE request finished with status other than BluetoothGatt.GATT_SUCCESS.

java.lang.InterruptedException - thrown if the timeout occurred before the request has finished.

java.lang.IllegalStateException - thrown when you try to call this method from the main (UI) thread.

DeviceDisconnectedException - thrown when the device disconnected before the request was completed.

BluetoothDisabledException - thrown when the Bluetooth adapter has been disabled.

InvalidRequestException - thrown when the request was called before the device was connected at least once (unknown device).