no.nordicsemi.android.ble.response

Class ConnectionPriorityResponse

java.lang.Object

no.nordicsemi.android.ble.response.ConnectionPriorityResponse

All Implemented Interfaces:

android.os.Parcelable, ConnectionPriorityCallback

public class ConnectionPriorityResponse
extends java.lang.Object
implements ConnectionPriorityCallback, android.os.Parcelable

The synchronous response type for connection priority requests.

See Also:

ConnectionPriorityCallback

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<ConnectionPriorityResponse>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConnectionPriorityResponse(android.os.Parcel in)

Method Summary

Modifier and Type	Method and Description
int	describeContents()
android.bluetooth.BluetoothDevice	getBluetoothDevice()
int	getConnectionInterval() The connection interval determines how often the Central will ask for data from the Peripheral.
int	getSlaveLatency() By setting a non-zero slave latency, the Peripheral can choose to not answer when the Central asks for data up to the slave latency number of times.
int	getSupervisionTimeout() This timeout determines the timeout from the last data exchange till a link is considered lost.
void	onConnectionUpdated(android.bluetooth.BluetoothDevice device, int interval, int latency, int timeout) Callback indicating the connection parameters were updated.
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<ConnectionPriorityResponse> CREATOR

Constructor Detail

ConnectionPriorityResponse

protected ConnectionPriorityResponse(android.os.Parcel in)

Method Detail

onConnectionUpdated

public void onConnectionUpdated(@NonNull
                                android.bluetooth.BluetoothDevice device,
                                int interval,
                                int latency,
                                int timeout)

Description copied from interface: ConnectionPriorityCallback

Callback indicating the connection parameters were updated. Works on Android 8.0 Oreo or newer.

Specified by:

onConnectionUpdated in interface ConnectionPriorityCallback

Parameters:

device - the target device.

interval - Connection interval used on this connection, 1.25ms unit. Valid range is from 6 (7.5ms) to 3200 (4000ms).

latency - Slave latency for the connection in number of connection events. Valid range is from 0 to 499.

timeout - Supervision timeout for this connection, in 10ms unit. Valid range is from 10 (100 ms = 0.1s) to 3200 (32s).

getBluetoothDevice

@Nullable
public android.bluetooth.BluetoothDevice getBluetoothDevice()

getConnectionInterval

public int getConnectionInterval()

The connection interval determines how often the Central will ask for data from the Peripheral. When the Peripheral requests an update, it supplies a maximum and a minimum wanted interval. The connection interval must be between 7.5 ms and 4 s.

Returns:

Connection interval used on this connection, 1.25ms unit. Valid range is from 6 (7.5ms) to 3200 (4000ms).

getSlaveLatency

public int getSlaveLatency()

By setting a non-zero slave latency, the Peripheral can choose to not answer when the Central asks for data up to the slave latency number of times. However, if the Peripheral has data to send, it can choose to send data at any time. This enables a peripheral to stay sleeping for a longer time, if it doesn't have data to send, but still send data fast if needed. The text book example of such device is for example keyboard and mice, which want to be sleeping for as long as possible when there is no data to send, but still have low latency (and for the mouse: low connection interval) when needed.

Returns:

Slave latency for the connection in number of connection events. Valid range is from 0 to 499.

getSupervisionTimeout

public int getSupervisionTimeout()

This timeout determines the timeout from the last data exchange till a link is considered lost. A Central will not start trying to reconnect before the timeout has passed, so if you have a device which goes in and out of range often, and you need to notice when that happens, it might make sense to have a short timeout.

Returns:

Supervision timeout for this connection, in 10ms unit. Valid range is from 10 (100 ms = 0.1s) to 3200 (32s).

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable