no.nordicsemi.android.ble

Class TimeoutableValueRequest<T>

java.lang.Object

no.nordicsemi.android.ble.Request

no.nordicsemi.android.ble.TimeoutableRequest

no.nordicsemi.android.ble.TimeoutableValueRequest<T>

Direct Known Subclasses:

AwaitingRequest

public abstract class TimeoutableValueRequest<T>
extends TimeoutableRequest

A value request that requires a callback or can't have timeout for any other reason. This class defines the TimeoutableRequest.await() methods.

Field Summary

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

timeout

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

handler, requestHandler

Method Summary

Modifier and Type	Method and Description
<E extends T> E	await(java.lang.Class<E> responseClass) Synchronously waits until the request is done.
<E extends T> E	await(java.lang.Class<E> responseClass, long timeout) Deprecated. Use timeout(long) and await(Class) instead.
<E extends T> E	await(E response) Synchronously waits until the request is done.
<E extends T> E	await(E response, long timeout) Deprecated. Use timeout(long) and #await(E) instead.
TimeoutableValueRequest<T>	timeout(long timeout) Sets the operation timeout.
TimeoutableValueRequest<T>	with(T callback) Sets the value callback.

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

await, await, enqueue, enqueue, setHandler

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

Method Detail

timeout

@NonNull
public TimeoutableValueRequest<T> timeout(long timeout)

Description copied from class: TimeoutableRequest

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

Overrides:

timeout in class TimeoutableRequest

Parameters:

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

Returns:

the callback.

with

@NonNull
public TimeoutableValueRequest<T> with(@NonNull
                                                 T callback)

Sets the value callback. When the request is invoked synchronously, this callback will be ignored and the received value will be returned by the await(...) method;

Parameters:

callback - the callback.

Returns:

The request.

await

@NonNull
public <E extends T> E await(@NonNull
                                       E response)
                                throws RequestFailedException,
                                       DeviceDisconnectedException,
                                       BluetoothDisabledException,
                                       InvalidRequestException,
                                       java.lang.InterruptedException

Synchronously waits until the request is done.

When the timeout, set with timeout(long) occurs, the InterruptedException will be thrown.

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

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

Type Parameters:

E - a response class.

Parameters:

response - the response object.

Returns:

The response with a response.

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, or when the trigger was already enqueued.

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

BluetoothDisabledException - thrown when the Bluetooth adapter is disabled.

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

await

@NonNull
public <E extends T> E await(@NonNull
                                       java.lang.Class<E> responseClass)
                                throws RequestFailedException,
                                       DeviceDisconnectedException,
                                       BluetoothDisabledException,
                                       InvalidRequestException,
                                       java.lang.InterruptedException

Synchronously waits until the request is done.

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

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

Parameters:

responseClass - the response class. This class will be instantiate, therefore it has to have a default constructor.

Returns:

The response with a response.

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.

java.lang.IllegalArgumentException - thrown when the response class could not be instantiated.

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

BluetoothDisabledException - thrown when the Bluetooth adapter is disabled.

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

See Also:

await(Object)

await

@NonNull
 @Deprecated
public <E extends T> E await(@NonNull
                                                     java.lang.Class<E> responseClass,
                                                     long timeout)
                                              throws RequestFailedException,
                                                     java.lang.InterruptedException,
                                                     DeviceDisconnectedException,
                                                     BluetoothDisabledException,
                                                     InvalidRequestException

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

Synchronously waits until the request is done, for at most given number of milliseconds after which the InterruptedException will be thrown.

Callbacks set using Request.done(SuccessCallback), Request.fail(FailCallback) and #with(E) will be ignored.

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

Type Parameters:

E - a response class that extends T.

Parameters:

responseClass - the response class. This class will be instantiate, therefore it has to have a default constructor.

timeout - optional timeout in milliseconds. This value will override one set in timeout(long).

Returns:

The object with a response.

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.

java.lang.IllegalArgumentException - thrown when the response class could not be instantiated.

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

BluetoothDisabledException - thrown when the Bluetooth adapter is disabled.

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

await

@NonNull
 @Deprecated
public <E extends T> E await(@NonNull
                                                     E response,
                                                     long timeout)
                                              throws RequestFailedException,
                                                     java.lang.InterruptedException,
                                                     DeviceDisconnectedException,
                                                     BluetoothDisabledException,
                                                     InvalidRequestException

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

Synchronously waits until the request is done, for at most given number of milliseconds after which the InterruptedException will be thrown.

Callbacks set using Request.done(SuccessCallback), Request.fail(FailCallback) and #with(E) will be ignored.

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

Type Parameters:

E - a response class that extends T.

Parameters:

response - the response object.

timeout - optional timeout in milliseconds.

Returns:

The object with a response.

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 is disabled.

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