Package com.facebook.openwifi.rrm.optimizers.clientsteering

Class ClientSteeringState

java.lang.Object

com.facebook.openwifi.rrm.optimizers.clientsteering.ClientSteeringState

public class ClientSteeringState
extends Object

Class to manage global client steering state

Constructor Summary

Constructors

Constructor	Description
ClientSteeringState()

Method Summary

Modifier and Type	Method	Description
boolean	registerIfBackoffExpired(String apSerialNumber, String station, long currentTimeNs, long backoffTimeNs, boolean dryRun)	Register a client steering attempt for the given AP and station at the given time if there is no previous registered attempt or more than the given backoff time has passed since the registration time of the last attempt and the current time.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientSteeringState

public ClientSteeringState()

Method Detail

registerIfBackoffExpired

public boolean registerIfBackoffExpired(String apSerialNumber,
                                        String station,
                                        long currentTimeNs,
                                        long backoffTimeNs,
                                        boolean dryRun)

Register a client steering attempt for the given AP and station at the given time if there is no previous registered attempt or more than the given backoff time has passed since the registration time of the last attempt and the current time. Note that only registration times are checked and/or entered, and nothing is executed here. Return true if the attempt was registered; false otherwise. The attempt is not registered if this run is specified as a dry run.

The backoff time must be non-negative. The backoff time window is "exclusive" - e.g., if the backoff time is X ns, and the current time is exactly X ns after the last attempt, the backoff is considered expired.

Note that if there was a previous attempt for the given AP and station, the current time must not be before the last attempt.

Parameters:

apSerialNumber - AP serial number

station - client MAC

currentTimeNs - JVM monotonic time in ns

backoffTimeNs - non-negative backoff time (ns)

dryRun - if set, do not apply changes

Returns:

true if client steering attempt was registered; false otherwise