no.nordicsemi.android.ble

Class ReliableWriteRequest

java.lang.Object

no.nordicsemi.android.ble.Request

no.nordicsemi.android.ble.RequestQueue

no.nordicsemi.android.ble.ReliableWriteRequest

public final class ReliableWriteRequest
extends RequestQueue

Field Summary

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

handler, requestHandler

Constructor Summary

Constructors

Constructor and Description
ReliableWriteRequest()

Method Summary

Modifier and Type	Method and Description
void	abort() Alias for cancelQueue().
ReliableWriteRequest	add(Operation operation) Enqueues a new operation.
ReliableWriteRequest	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.
ReliableWriteRequest	done(SuccessCallback callback) Use to set a completion callback.
ReliableWriteRequest	fail(FailCallback callback) Use to set a callback that will be called in case the request has failed.
ReliableWriteRequest	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.
ReliableWriteRequest	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.RequestQueue

await, isEmpty

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

Constructor Detail

ReliableWriteRequest

public ReliableWriteRequest()

Method Detail

setHandler

@NonNull
public ReliableWriteRequest 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 RequestQueue

Parameters:

handler - The handler to invoke callbacks for this request.

Returns:

The request.

done

@NonNull
public ReliableWriteRequest 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 RequestQueue

Parameters:

callback - the callback.

Returns:

The request.

fail

@NonNull
public ReliableWriteRequest 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 RequestQueue

Parameters:

callback - the callback.

Returns:

The request.

invalid

@NonNull
public ReliableWriteRequest 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 RequestQueue

Parameters:

callback - the callback.

Returns:

The request.

before

@NonNull
public ReliableWriteRequest 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 RequestQueue

Parameters:

callback - the callback.

Returns:

The request.

add

@NonNull
public ReliableWriteRequest add(@NonNull
                                          Operation operation)

Description copied from class: RequestQueue

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

Overrides:

add in class RequestQueue

Parameters:

operation - the new operation to be enqueued.

cancelQueue

public void cancelQueue()

Description copied from class: RequestQueue

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;

Overrides:

cancelQueue in class RequestQueue

abort

public void abort()

Alias for cancelQueue().

size

public int size()

Description copied from class: RequestQueue

Returns number of enqueued operations.

Overrides:

size in class RequestQueue

Returns:

the size of the internal operations list.