com.arm.mbed.cloud.sdk.common.SynchronousMethod 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.common;

import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
import java.util.concurrent.TimeoutException;

import com.arm.mbed.cloud.sdk.annotations.Internal;
import com.arm.mbed.cloud.sdk.annotations.NonNull;
import com.arm.mbed.cloud.sdk.annotations.Nullable;
import com.arm.mbed.cloud.sdk.annotations.Preamble;

@Preamble(description = "Object to wait for an asynchronous method to complete")
@Internal
public class SynchronousMethod {

    private SynchronousMethod() {
        super();
    }

    @Preamble(description = "Asynchronous method")
    public interface AsynchronousMethod {
        /**
         * Gets a future task.
         * 
         * @return future task.
         * @throws MbedCloudException
         *             if an error happens during submission.
         */
        Future submit() throws MbedCloudException;
    }

    /**
     * Waits for the completion of an asynchronous call method.
     * 
     * @see AsynchronousMethod
     * @param module
     *            API module
     * @param function
     *            SDK function called
     * @param asyncMethod
     *            asynchronous method to call.
     * @param timeout
     *            timeout to set. If null, it will wait indefinitely.
     * @param 
     *            type of the result
     * @return call result
     * @throws MbedCloudException
     *             if an error occurred during the call or the wait.
     */

    public static  T waitForCompletion(@Nullable AbstractApi module, @Nullable String function,
            @NonNull AsynchronousMethod asyncMethod, @Nullable TimePeriod timeout) throws MbedCloudException {
        if (asyncMethod == null) {
            throw new MbedCloudException("Asynchronous method is Null");
        }
        final Future future = asyncMethod.submit();
        if (future == null) {
            return null;
        }
        try {
            T returnValue = null;
            if (timeout == null) {
                returnValue = future.get();
            } else {
                returnValue = future.get(timeout.getDuration(), timeout.getUnit());
            }
            if (returnValue instanceof Error) {
                final Error error = (Error) returnValue;
                if (module != null) {
                    CloudCaller.storeApiMetadata(module, ApiMetadata.generateMetaData(function, error));
                }
                throw new MbedCloudException(error.getMessage());
            }
            return returnValue;
        } catch (InterruptedException | ExecutionException | TimeoutException exception) {
            throw new MbedCloudException(exception);
        }

    }

}