com.arm.mbed.cloud.sdk.subscribe.model.FirstValue Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mbed-cloud-sdk Show documentation

The Pelion Cloud SDK (formerly known as Mbed Cloud SDK) provides a simplified interface to the Pelion Cloud APIs by exposing functionality using conventions and paradigms familiar to Java developers.

There is a newer version: 2.5.0

Show newest version

package com.arm.mbed.cloud.sdk.subscribe.model;

import com.arm.mbed.cloud.sdk.annotations.Preamble;

@Preamble(description = "Enumerator describing when the first value received should be triggered on")
/**
 * 'First value' refers to how soon after requesting a subscription the first resource value is fetched.
 * 
 * There is a tradeoff in terms of performance/api calls/device power usage.
 *
 */
public enum FirstValue {
    /**
     * Listens to value changes happening after the device registered or re-registed. Therefore, it waits for a device
     * to send re-register message. one api call.
     * 

     * LONG wait.
     */
    ON_REGISTRATION,
    /**
     * Listens to value changes happening as soon as changes happen. Therefore, it sets up subscriptions on existing
     * live resources. many api calls.
     * 
     * MEDIUM wait.
     */
    ON_VALUE_UPDATE,

    IMMEDIATELY;
    // TODO Add LAST_KNOWN, IMMEDIATELY
    // explicitly requests value update from each matching resource. many api calls. immediate.

    public static FirstValue getDefault() {
        return FirstValue.ON_VALUE_UPDATE;
    }
}