no.nordicsemi.android.ble

Class ConnectionPriorityRequest

java.lang.Object

no.nordicsemi.android.ble.Request

no.nordicsemi.android.ble.SimpleRequest

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

no.nordicsemi.android.ble.ConnectionPriorityRequest

All Implemented Interfaces:

Operation

public final class ConnectionPriorityRequest
extends SimpleValueRequest<ConnectionPriorityCallback>
implements Operation

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONNECTION_PRIORITY_BALANCED Connection parameter update - Use the connection parameters recommended by the Bluetooth SIG.
static int	CONNECTION_PRIORITY_HIGH Connection parameter update - Request a high priority, low latency connection.
static int	CONNECTION_PRIORITY_LOW_POWER Connection parameter update - Request low power, reduced data rate connection parameters.

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

handler, requestHandler

Method Summary

Modifier and Type	Method and Description
<E extends ConnectionPriorityCallback> E	await(java.lang.Class<E> responseClass) Synchronously waits until the request is done.
<E extends ConnectionPriorityCallback> E	await(E response) Synchronously waits until the request is done.
ConnectionPriorityRequest	before(BeforeCallback callback) Sets a callback that will be executed before the execution of this operation starts.
ConnectionPriorityRequest	done(SuccessCallback callback) Use to set a completion callback.
ConnectionPriorityRequest	fail(FailCallback callback) Use to set a callback that will be called in case the request has failed.
ConnectionPriorityRequest	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.
ConnectionPriorityRequest	setHandler(android.os.Handler handler) Sets the handler that will be used to invoke callbacks.
ConnectionPriorityRequest	with(ConnectionPriorityCallback callback) Sets the value callback.

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

Field Detail

CONNECTION_PRIORITY_BALANCED

public static final int CONNECTION_PRIORITY_BALANCED

Connection parameter update - Use the connection parameters recommended by the Bluetooth SIG. This is the default value if no connection parameter update is requested.

Interval: 30 - 50 ms, latency: 0, supervision timeout: 20 sec.

See Also:

Constant Field Values

CONNECTION_PRIORITY_HIGH

public static final int CONNECTION_PRIORITY_HIGH

Connection parameter update - Request a high priority, low latency connection. An application should only request high priority connection parameters to transfer large amounts of data over LE quickly. Once the transfer is complete, the application should request CONNECTION_PRIORITY_BALANCED connection parameters to reduce energy use.

Interval: 11.25 - 15 ms (Android 6+) or 7.5 - 10 ms (Android 4.3 - 5.1), latency: 0, supervision timeout: 20 sec.

See Also:

Constant Field Values

CONNECTION_PRIORITY_LOW_POWER

public static final int CONNECTION_PRIORITY_LOW_POWER

Connection parameter update - Request low power, reduced data rate connection parameters.

Interval: 100 - 125 ms, latency: 2, supervision timeout: 20 sec.

See Also:

Constant Field Values

Method Detail

setHandler

@NonNull
public ConnectionPriorityRequest 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 ConnectionPriorityRequest 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 ConnectionPriorityRequest 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 ConnectionPriorityRequest 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 ConnectionPriorityRequest 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 ConnectionPriorityRequest with(@NonNull
                                                ConnectionPriorityCallback 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<ConnectionPriorityCallback>

Parameters:

callback - the callback.

Returns:

The request.

await

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

Description copied from class: SimpleValueRequest

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.

Overrides:

await in class SimpleValueRequest<ConnectionPriorityCallback>

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.

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:

SimpleValueRequest.await(Object)

await

@NonNull
public <E extends ConnectionPriorityCallback> E await(@NonNull
                                                                E response)
                                                         throws RequestFailedException,
                                                                DeviceDisconnectedException,
                                                                BluetoothDisabledException,
                                                                InvalidRequestException

Description copied from class: SimpleValueRequest

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.

Overrides:

await in class SimpleValueRequest<ConnectionPriorityCallback>

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.

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:

SimpleValueRequest.await(Class)