no.nordicsemi.android.ble

Class ConditionalWaitRequest<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>

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

All Implemented Interfaces:

Operation

public final class ConditionalWaitRequest<T>
extends AwaitingRequest<T>
implements Operation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ConditionalWaitRequest.Condition<T> The condition object.

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
ConditionalWaitRequest<T>	before(BeforeCallback callback) Sets a callback that will be executed before the execution of this operation starts.
ConditionalWaitRequest<T>	done(SuccessCallback callback) Use to set a completion callback.
ConditionalWaitRequest<T>	fail(FailCallback callback) Use to set a callback that will be called in case the request has failed.
ConditionalWaitRequest<T>	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.
ConditionalWaitRequest<T>	negate() Negates the expected value of the predicate.
ConditionalWaitRequest<T>	setHandler(android.os.Handler handler) Sets the handler that will be used to invoke callbacks.

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

await, trigger

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

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

createBond, 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 ConditionalWaitRequest<T> 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 TimeoutableRequest

Parameters:

handler - The handler to invoke callbacks for this request.

Returns:

The request.

done

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

negate

@NonNull
public ConditionalWaitRequest<T> negate()

Negates the expected value of the predicate.

Returns:

The request.