no.nordicsemi.android.ble

Class AwaitingRequest<T>

java.lang.Object

no.nordicsemi.android.ble.Request

no.nordicsemi.android.ble.TimeoutableRequest

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

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

Direct Known Subclasses:

ConditionalWaitRequest, WaitForReadRequest, WaitForValueChangedRequest

public abstract class AwaitingRequest<T>
extends TimeoutableValueRequest<T>

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(E response) Synchronously waits until the request is done.
AwaitingRequest<T>	trigger(Operation trigger) Sets an optional request that is suppose to trigger the notification or indication.

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

await, await, await, timeout, with

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

trigger

@NonNull
public AwaitingRequest<T> trigger(@NonNull
                                            Operation trigger)

Sets an optional request that is suppose to trigger the notification or indication. This is to ensure that the characteristic value won't change before the callback was set.

Parameters:

trigger - the operation that triggers the notification, usually a write characteristic request that write some OP CODE.

Returns:

The request.

await

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

Description copied from class: TimeoutableValueRequest

Synchronously waits until the request is done.

When the timeout, set with TimeoutableValueRequest.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.

Overrides:

await in class TimeoutableValueRequest<T>

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.

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).

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