no.nordicsemi.android.ble

Class ReadRequest

java.lang.Object

no.nordicsemi.android.ble.Request

no.nordicsemi.android.ble.SimpleRequest

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

no.nordicsemi.android.ble.ReadRequest

All Implemented Interfaces:

Operation

public final class ReadRequest
extends SimpleValueRequest<DataReceivedCallback>
implements Operation

Field Summary

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

handler, requestHandler

Method Summary

Modifier and Type	Method and Description
<E extends ProfileReadResponse> E	awaitValid(java.lang.Class<E> responseClass) Same as SimpleValueRequest.await(Class), but if the response class extends ProfileReadResponse and the received response is not valid (ProfileReadResponse.isValid() returns false), this method will throw an exception.
<E extends ProfileReadResponse> E	awaitValid(E response) Same as SimpleValueRequest.await(Object), but if the response class extends ProfileReadResponse and the received response is not valid (ProfileReadResponse.isValid() returns false), this method will throw an exception.
ReadRequest	before(BeforeCallback callback) Sets a callback that will be executed before the execution of this operation starts.
ReadRequest	done(SuccessCallback callback) Use to set a completion callback.
ReadRequest	fail(FailCallback callback) Use to set a callback that will be called in case the request has failed.
ReadRequest	filter(DataFilter filter) Sets a filter which allows to skip some incoming data.
ReadRequest	invalid(InvalidRequestCallback callback) Use to set a callback that will be called in case the request was invalid, for example called before the device was connected.
ReadRequest	merge(DataMerger merger) Adds a merger that will be used to merge multiple packets into a single Data.
ReadRequest	merge(DataMerger merger, ReadProgressCallback callback) Adds a merger that will be used to merge multiple packets into a single Data.
ReadRequest	setHandler(android.os.Handler handler) Sets the handler that will be used to invoke callbacks.
ReadRequest	with(DataReceivedCallback callback) Sets the value callback.

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

await, await

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

await

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

createBond, enqueue, 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

setHandler

@NonNull
public ReadRequest 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.

done

@NonNull
public ReadRequest done(@NonNull
                                  SuccessCallback callback)

Description copied from class: Request

Use to set a completion callback. The callback will be invoked when the operation has finished successfully unless the request was executed synchronously, in which case this callback will be ignored.

Overrides:

done in class Request

Parameters:

callback - the callback.

Returns:

The request.

fail

@NonNull
public ReadRequest fail(@NonNull
                                  FailCallback callback)

Description copied from class: Request

Use to set a callback that will be called in case the request has failed. If the target device wasn't set before executing this request (BleManager.connect(BluetoothDevice) was never called), the Request.invalid(InvalidRequestCallback) will be used instead, as the BluetoothDevice is not known.

This callback will be ignored if request was executed synchronously, in which case the error will be returned as an exception.

Overrides:

fail in class Request

Parameters:

callback - the callback.

Returns:

The request.

invalid

@NonNull
public ReadRequest invalid(@NonNull
                                     InvalidRequestCallback callback)

Description copied from class: Request

Use to set a callback that will be called in case the request was invalid, for example called before the device was connected. This callback will be ignored if request was executed synchronously, in which case the error will be returned as an exception.

Overrides:

invalid in class Request

Parameters:

callback - the callback.

Returns:

The request.

before

@NonNull
public ReadRequest before(@NonNull
                                    BeforeCallback callback)

Description copied from class: Request

Sets a callback that will be executed before the execution of this operation starts.

Overrides:

before in class Request

Parameters:

callback - the callback.

Returns:

The request.

with

@NonNull
public ReadRequest with(@NonNull
                                  DataReceivedCallback callback)

Description copied from class: SimpleValueRequest

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;

Overrides:

with in class SimpleValueRequest<DataReceivedCallback>

Parameters:

callback - the callback.

Returns:

The request.

filter

@NonNull
public ReadRequest filter(@NonNull
                                    DataFilter filter)

Sets a filter which allows to skip some incoming data.

Parameters:

filter - the data filter.

Returns:

The request.

merge

@NonNull
public ReadRequest merge(@NonNull
                                   DataMerger merger)

Adds a merger that will be used to merge multiple packets into a single Data. The merger may modify each packet if necessary.

Returns:

The request.

merge

@NonNull
public ReadRequest merge(@NonNull
                                   DataMerger merger,
                                   @NonNull
                                   ReadProgressCallback callback)

Adds a merger that will be used to merge multiple packets into a single Data. The merger may modify each packet if necessary.

Returns:

The request.

awaitValid

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

Same as SimpleValueRequest.await(Class), but if the response class extends ProfileReadResponse and the received response is not valid (ProfileReadResponse.isValid() returns false), this method will throw an exception.

Parameters:

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

Returns:

The object with the 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 has been disabled.

InvalidDataException - thrown when the received data were not valid (that is when ReadResponse.onDataReceived(BluetoothDevice, Data) failed to parse the data correctly and called ProfileReadResponse.onInvalidDataReceived(BluetoothDevice, Data)).

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

awaitValid

@NonNull
public <E extends ProfileReadResponse> E awaitValid(@NonNull
                                                              E response)
                                                       throws RequestFailedException,
                                                              InvalidDataException,
                                                              DeviceDisconnectedException,
                                                              BluetoothDisabledException,
                                                              InvalidRequestException

Same as SimpleValueRequest.await(Object), but if the response class extends ProfileReadResponse and the received response is not valid (ProfileReadResponse.isValid() returns false), this method will throw an exception.

Parameters:

response - the response object.

Returns:

The object with the 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 has been disabled.

InvalidDataException - thrown when the received data were not valid (that is when ReadResponse.onDataReceived(BluetoothDevice, Data) failed to parse the data correctly and called ProfileReadResponse.onInvalidDataReceived(BluetoothDevice, Data)).

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