no.nordicsemi.android.ble

Class PhyRequest

java.lang.Object

no.nordicsemi.android.ble.Request

no.nordicsemi.android.ble.SimpleRequest

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

no.nordicsemi.android.ble.PhyRequest

All Implemented Interfaces:

Operation

public final class PhyRequest
extends SimpleValueRequest<PhyCallback>
implements Operation

Field Summary

Fields

Modifier and Type	Field and Description
static int	PHY_LE_1M_MASK Bluetooth LE 1M PHY mask.
static int	PHY_LE_2M_MASK Bluetooth LE 2M PHY mask.
static int	PHY_LE_CODED_MASK Bluetooth LE Coded PHY mask.
static int	PHY_OPTION_NO_PREFERRED No preferred coding when transmitting on the LE Coded PHY.
static int	PHY_OPTION_S2 Prefer the S=2 coding to be used when transmitting on the LE Coded PHY.
static int	PHY_OPTION_S8 Prefer the S=8 coding to be used when transmitting on the LE Coded PHY.

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

handler, requestHandler

Method Summary

Modifier and Type	Method and Description
PhyRequest	before(BeforeCallback callback) Sets a callback that will be executed before the execution of this operation starts.
PhyRequest	done(SuccessCallback callback) Use to set a completion callback.
PhyRequest	fail(FailCallback callback) Use to set a callback that will be called in case the request has failed.
PhyRequest	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.
PhyRequest	setHandler(android.os.Handler handler) Sets the handler that will be used to invoke callbacks.
PhyRequest	with(PhyCallback 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

Field Detail

PHY_LE_1M_MASK

public static final int PHY_LE_1M_MASK

Bluetooth LE 1M PHY mask. Used to specify LE 1M Physical Channel as one of many available options in a bitmask.

See Also:

Constant Field Values

PHY_LE_2M_MASK

public static final int PHY_LE_2M_MASK

Bluetooth LE 2M PHY mask. Used to specify LE 2M Physical Channel as one of many available options in a bitmask.

See Also:

Constant Field Values

PHY_LE_CODED_MASK

public static final int PHY_LE_CODED_MASK

Bluetooth LE Coded PHY mask. Used to specify LE Coded Physical Channel as one of many available options in a bitmask.

See Also:

Constant Field Values

PHY_OPTION_NO_PREFERRED

public static final int PHY_OPTION_NO_PREFERRED

No preferred coding when transmitting on the LE Coded PHY.

See Also:

Constant Field Values

PHY_OPTION_S2

public static final int PHY_OPTION_S2

Prefer the S=2 coding to be used when transmitting on the LE Coded PHY.

See Also:

Constant Field Values

PHY_OPTION_S8

public static final int PHY_OPTION_S8

Prefer the S=8 coding to be used when transmitting on the LE Coded PHY.

See Also:

Constant Field Values

Method Detail

setHandler

@NonNull
public PhyRequest 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 PhyRequest 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 PhyRequest 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 PhyRequest 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 PhyRequest 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 PhyRequest with(@NonNull
                                 PhyCallback 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<PhyCallback>

Parameters:

callback - the callback.

Returns:

The request.