no.nordicsemi.android.ble

Class RequestQueue

java.lang.Object

no.nordicsemi.android.ble.Request

no.nordicsemi.android.ble.RequestQueue

Direct Known Subclasses:

ReliableWriteRequest

public class RequestQueue
extends Request

Field Summary

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

handler, requestHandler

Method Summary

Modifier and Type	Method and Description
RequestQueue	add(Operation operation) Enqueues a new operation.
void	await() Synchronously waits until all enqueued requests are done.
RequestQueue	before(BeforeCallback callback) Sets a callback that will be executed before the execution of this operation starts.
void	cancelQueue() Cancels all the enqueued operations that were not executed yet.
RequestQueue	done(SuccessCallback callback) Use to set a completion callback.
RequestQueue	fail(FailCallback callback) Use to set a callback that will be called in case the request has failed.
RequestQueue	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.
boolean	isEmpty() Returns whether the set is empty, or not.
RequestQueue	setHandler(android.os.Handler handler) Sets the handler that will be used to invoke callbacks.
int	size() Returns number of enqueued operations.

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

add

@NonNull
public RequestQueue add(@NonNull
                                  Operation operation)

Enqueues a new operation. All operations will be executed sequentially in order they were added.

Parameters:

operation - the new operation to be enqueued.

Throws:

java.lang.IllegalStateException - if the operation was enqueued before.

java.lang.IllegalArgumentException - if the operation is not a Request.

size

public int size()

Returns number of enqueued operations.

Returns:

the size of the internal operations list.

isEmpty

public boolean isEmpty()

Returns whether the set is empty, or not.

Returns:

true if the set is empty. Set gets emptied while it all enqueued operations are being executed.

cancelQueue

public void cancelQueue()

Cancels all the enqueued operations that were not executed yet. The one currently executed will be finished.

It is safe to call this method in Request.done(SuccessCallback) or Request.fail(FailCallback) callback;

await

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

Synchronously waits until all enqueued requests are done. The queue will fail if any of the enqueued requests fails. All following requests will be ignored.

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

java.lang.InterruptedException - thrown when one of the request has failed with a timeout.