public final class RangingSession

Object
RangingSession

One ranging conversation with one peer or accessory, obtained from Ranging.prepareSession.

A prepared session has a getLocalToken() to publish and is not yet using the radio. It starts measuring when start or startAccessory is called and keeps going until stop(), until the platform invalidates it, or until the app exits.

Sessions are not reusable: once stopped or invalidated, prepare another.

Methods

`public` `RangingToken getLocalToken()`	The token to publish so the peer can range against this device.
`public` `RangingRole getRole()`	Which end of the session this device is.
`public boolean isRunning()`	`true` while the radio is measuring.
`public` `AsyncResource<RangingSession> start(RangingToken peerToken)`	Starts ranging against a peer whose token arrived out of band.
`public` `AsyncResource<byte[]> startAccessory(byte[] accessoryConfigurationData)`	Starts ranging against a third-party UWB accessory.
`public void stop()`	Stops measuring and releases the radio.
`public void addRangingListener(RangingListener l)`	Registers a listener.
`public void removeRangingListener(RangingListener l)`	Removes a listener added by `addRangingListener`.

Inherited methods

From Object

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

Method details

getLocalToken

public RangingToken getLocalToken()

The token to publish so the peer can range against this device. Never null, and available as soon as the session is prepared.

Returns

this device’s token for this session

getRole

public RangingRole getRole()

Which end of the session this device is.

Returns

the role this session was prepared with

isRunning

public boolean isRunning()

true while the radio is measuring. False before start and after stop(), and false while the session is suspended.

start

public AsyncResource<RangingSession> start(RangingToken peerToken)

Starts ranging against a peer whose token arrived out of band.

Parameters

peerToken RangingToken: the peer’s token, decoded from the bytes they published

Returns

resolves with this session once the radio is measuring, or fails with a NearbyException

startAccessory

public AsyncResource<byte[]> startAccessory(byte[] accessoryConfigurationData)

Starts ranging against a third-party UWB accessory.

The accessory publishes a blob of configuration data over its own channel – in practice a GATT characteristic. Hand those bytes here, and send whatever this resolves with back to the accessory: Apple’s Nearby Interaction Accessory Protocol needs that second half of the handshake before the accessory begins ranging.

Android has no equivalent protocol. There, an accessory simply names the channel and session to join, so build a token with RangingToken.forUwbAddress and call start instead; this method fails with NearbyError.NOT_SUPPORTED.

Parameters

accessoryConfigurationData byte[]: what the accessory published

Returns

resolves with the bytes to send back to the accessory, empty where the platform needs no handshake

stop

public void stop()

Stops measuring and releases the radio. Idempotent, and safe to call on a session that never started. No further listener callback arrives afterwards.

addRangingListener

public void addRangingListener(RangingListener l)

Registers a listener. Callbacks arrive on the EDT.

Parameters

l RangingListener: the listener to add

removeRangingListener

public void removeRangingListener(RangingListener l)

Removes a listener added by addRangingListener.

Parameters

l RangingListener: the listener to remove