no.nordicsemi.android.ble

Class SimpleValueRequest<T>

java.lang.Object

no.nordicsemi.android.ble.Request

no.nordicsemi.android.ble.SimpleRequest

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

Direct Known Subclasses:

ConnectionPriorityRequest, MtuRequest, PhyRequest, ReadRequest, ReadRssiRequest, WriteRequest

public abstract class SimpleValueRequest<T>
extends SimpleRequest

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

Field Summary

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(E response) Synchronously waits until the request is done.
SimpleValueRequest<T>	with(T callback) Sets the value callback.

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

await

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

before, createBond, done, enqueue, 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, setHandler

Methods inherited from class java.lang.Object

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

Method Detail

with

@NonNull
public SimpleValueRequest<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

Synchronously waits until the request is done. The given response object will be filled with the request response.

Callbacks set using Request.before(BeforeCallback), Request.done(SuccessCallback) and Request.fail(FailCallback) 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.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).

See Also:

await(Class)

await

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

Synchronously waits until the request is done.

Callbacks set using Request.before(BeforeCallback), Request.done(SuccessCallback) and Request.fail(FailCallback) 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.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)