Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 563a057b authored by Nathan Harold's avatar Nathan Harold
Browse files

Add docs for setSignalStrengthReportingCriteria

Because setSignalStrengthReportingCriteria only
supports a single measurement quantity, provide
further clarification on the applicability of the
API and how it may be used in various situations.

Bug: 110121199
Test: compilation - docstring-only change
Change-Id: If4236070fbc03368e5a78b0cf502cdc4a529a6ed
parent 43f2c3e5
Loading
Loading
Loading
Loading
+1 −0
Original line number Diff line number Diff line
@@ -385,3 +385,4 @@ cd4330c3196bda1d642a32abfe23a7d64ebfbda721940643af6867af3b3f0aa9 android.hardwar
574e8f1499436fb4075894dcae0b36682427956ecb114f17f1fe22d116a83c6b android.hardware.neuralnetworks@1.0::IPreparedModel
1a5ae9793223658174258b523763c557abad6fb917df0b8e3cc097fc89035811 android.hardware.neuralnetworks@1.0::types
4310eb8272f085914952f3bfb73a8f8bb477a80e8b93596f0ea5acb58546b66d android.hardware.neuralnetworks@1.1::types
1d19720d4fd38b1095f0f555a4bd92b3b12c9b1d0f560b0e9a474cd6dcc20db6 android.hardware.radio@1.2::IRadio
+17 −6
Original line number Diff line number Diff line
@@ -59,19 +59,30 @@ interface IRadio extends @1.1::IRadio {
    /**
     * Sets the signal strength reporting criteria.
     *
     * The resulting reporting criteria are the AND of all the supplied criteria.
     * The resulting reporting rules are the AND of all the supplied criteria. For each RAN
     * The thresholdsDbm and hysteresisDb apply to only the following measured quantities:
     * -GERAN    - RSSI
     * -CDMA2000 - RSSI
     * -UTRAN    - RSCP
     * -EUTRAN   - RSRP
     *
     * Note: Reporting criteria must be individually set for each RAN. If unset, reporting criteria
     * for that RAN are implementation-defined.
     * Note: Reporting criteria must be individually set for each RAN. For any unset reporting
     * criteria, the value is implementation-defined.
     *
     * Response callback is IRadioResponse.setSignalStrengthReportingCriteriaResponse().
     * Note: As this mechanism generally only constrains reports based on one measured quantity per
     * RAN, if multiple measured quantities must be used to trigger a report for a given RAN, the
     * only valid field may be hysteresisMs: hysteresisDb and thresholdsDbm must be set to zero and
     * length zero respectively. If either hysteresisDb or thresholdsDbm is set, then reports shall
     * only be triggered by the respective measured quantity, subject to the applied constraints.
     *
     * Response callback is IRadioResponse.setSignalStrengthReportingCriteriaResponse()
     *
     * @param serial Serial number of request.
     * @param hysteresisMs A hysteresis time in milliseconds to prevent flapping. A value of 0
     *     disables hysteresis.
     * @param hysteresisDb An interval in dB defining the required magnitude change between reports.
     *     hysteresisDb must be smaller than the smallest threshold delta. An
     *     interval value of 0 disables hysteresis.
     *     hysteresisDb must be smaller than the smallest threshold delta. An interval value of 0
     *     disables hysteresis.
     * @param thresholdsDbm A vector of trigger thresholds in dBm. A vector size of 0 disables the
     *     use of thresholds for reporting.
     * @param accessNetwork The type of network for which to apply these thresholds.