libbeacon/fr.maxcom.beacon.configuration/LossSettings

LossSettings

class LossSettings(val graceMillis: Long, val tickMillis: Long, val timeoutMillis: Long)

The model of the parameter to give to the method IContextConfigurator.lossSettings.

Example:

resume    ┌─────────────────────…──┐     ┌────────────────…
pause  …──┘                        └──…──┘
          |<-grace->|tick|               |<-grace->|tick|
check  …────────────┴────┴────┴─…─────…────────────┴────┴─…
                           |<------ timeout ------>|
device …─┴────────┴────────┴────…─────…───────────────────…
         ^missed  ^catch   ^last                   ^lost

Constructors

LossSettings

constructor(graceMillis: Long, tickMillis: Long, timeoutMillis: Long)

Types

Companion

object Companion

Default values.

Properties

graceMillis

val graceMillis: Long

The delay, in milliseconds, before to start checking for lost devices. In a ScanFrequency mode that alternates between phases, this leaves time at the beginning of the resume step to catch again devices that otherwise would be declared lost too soon because of the length of the pause step.

tickMillis

val tickMillis: Long

The interval of time, in milliseconds, between two checks for devices lost.

timeoutMillis

val timeoutMillis: Long

The amount of time, in milliseconds, above which a no more seen device is considered as lost.