Package com.amazonaws.services.iot.client.core

Class AwsIotCompletion

java.lang.Object

com.amazonaws.services.iot.client.AWSIotMessage

com.amazonaws.services.iot.client.core.AwsIotCompletion

All Implemented Interfaces:

AwsIotMessageCallback

Direct Known Subclasses:

AwsIotDeviceCommand

public class AwsIotCompletion
extends AWSIotMessage

This is a helper class that can be used to manage the request execution and return either synchronously or asynchronously the result, e.g. success, failure, or timeout. It's used by most of the APIs to implement blocking and non-blocking calls with timeout support.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	hasFailure	Indicates whether the request has completed with failure.
protected boolean	hasSuccess	Indicates whether the request has completed successfully.
protected boolean	hasTimeout	Indicates whether the request has timed out.
protected boolean	isAsync	whether the request is asynchronous or not.
protected AWSIotMessage	request	The request containing the callback functions.
protected long	timeout	The timeout associated with the request.
protected Future<?>	timeoutTask	The future object of the timeout task.

Fields inherited from class com.amazonaws.services.iot.client.AWSIotMessage

errorCode, errorMessage, payload, qos, topic

Constructor Summary

Constructors

Constructor	Description
AwsIotCompletion(long timeout, boolean isAsync)	Instantiates a new completion object either synchronous or asynchronous request based on the isAsync argument.
AwsIotCompletion(AWSIotMessage req, long timeout, boolean isAsync)	Instantiates a new completion object either synchronous or asynchronous request based on the isAsync argument.
AwsIotCompletion(String topic, AWSIotQos qos, byte[] payload, long timeout)	Instantiates a new completion object with a synchronous request.
AwsIotCompletion(String topic, AWSIotQos qos, long timeout)	Instantiates a new completion object with a synchronous request.
AwsIotCompletion(String topic, AWSIotQos qos, String payload, long timeout)	Instantiates a new completion object with a synchronous request.

Method Summary

Modifier and Type	Method	Description
void	get(AbstractAwsIotClient client)	The user of the completion object is expected to call this function to either block until the request is completed or timed out in the case of synchronous calls, or to schedule a timeout handler in the case of asynchronous calls.
void	onFailure()	Callback function to be invoked a non-block API has completed unsuccessfully.
void	onSuccess()	Callback function to be invoked a non-block API has completed successfully.
void	onTimeout()	Callback function to be invoked a non-block API has timed out.

Methods inherited from class com.amazonaws.services.iot.client.AWSIotMessage

getErrorCode, getErrorMessage, getPayload, getQos, getStringPayload, getTopic, setErrorCode, setErrorMessage, setPayload, setQos, setStringPayload, setTopic

Methods inherited from class java.lang.Object

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

Field Detail

request

protected final AWSIotMessage request

The request containing the callback functions.

timeout

protected final long timeout

The timeout associated with the request.

isAsync

protected final boolean isAsync

whether the request is asynchronous or not.

timeoutTask

protected Future<?> timeoutTask

The future object of the timeout task.

hasSuccess

protected boolean hasSuccess

Indicates whether the request has completed successfully.

hasFailure

protected boolean hasFailure

Indicates whether the request has completed with failure.

hasTimeout

protected boolean hasTimeout

Indicates whether the request has timed out.

Constructor Detail

AwsIotCompletion

public AwsIotCompletion(String topic,
                        AWSIotQos qos,
                        long timeout)

Instantiates a new completion object with a synchronous request.

Parameters:

topic - the topic of the request

qos - the QoS of the request

timeout - the timeout in milliseconds for the request. If timeout is 0 or less, the request will never be timed out.

AwsIotCompletion

public AwsIotCompletion(String topic,
                        AWSIotQos qos,
                        String payload,
                        long timeout)

Instantiates a new completion object with a synchronous request.

Parameters:

topic - the topic of the request

qos - the QoS of the request

payload - the string payload of the request

timeout - the timeout in milliseconds for the request. If timeout is 0 or less, the request will never be timed out.

AwsIotCompletion

public AwsIotCompletion(String topic,
                        AWSIotQos qos,
                        byte[] payload,
                        long timeout)

Instantiates a new completion object with a synchronous request.

Parameters:

topic - the topic of the request

qos - the QoS of the request

payload - the byte array payload of the request

timeout - the timeout in milliseconds for the request. If timeout is 0 or less, the request will never be timed out.

AwsIotCompletion

public AwsIotCompletion(long timeout,
                        boolean isAsync)

Instantiates a new completion object either synchronous or asynchronous request based on the isAsync argument.

Parameters:

timeout - the timeout in milliseconds for the request. If timeout is 0 or less, the request will never be timed out.

isAsync - whether or not the request is asynchronous

AwsIotCompletion

public AwsIotCompletion(AWSIotMessage req,
                        long timeout,
                        boolean isAsync)

Instantiates a new completion object either synchronous or asynchronous request based on the isAsync argument. Callback functions are provided through the req argument.

Parameters:

req - the request containing request topic, QoS, payload, and callback functions for asynchronous requests.

timeout - the timeout in milliseconds for the request. If timeout is 0 or less, the request will never be timed out.

isAsync - whether or not the request is asynchronous

Method Detail

get

public void get(AbstractAwsIotClient client)
         throws AWSIotException,
                AWSIotTimeoutException

The user of the completion object is expected to call this function to either block until the request is completed or timed out in the case of synchronous calls, or to schedule a timeout handler in the case of asynchronous calls.

Parameters:

client - the client object that provides the execution thread pool for the timeout handler.

Throws:

AWSIotException - For synchronous calls, this exception may be thrown if the request has failed.

AWSIotTimeoutException - For synchronous calls, this exception may be thrown if the request has timed out.

onSuccess

public void onSuccess()

Description copied from class: AWSIotMessage

Callback function to be invoked a non-block API has completed successfully.

Specified by:

onSuccess in interface AwsIotMessageCallback

Overrides:

onSuccess in class AWSIotMessage

onFailure

public void onFailure()

Description copied from class: AWSIotMessage

Callback function to be invoked a non-block API has completed unsuccessfully.

Specified by:

onFailure in interface AwsIotMessageCallback

Overrides:

onFailure in class AWSIotMessage

onTimeout

public void onTimeout()

Description copied from class: AWSIotMessage

Callback function to be invoked a non-block API has timed out.

Specified by:

onTimeout in interface AwsIotMessageCallback

Overrides:

onTimeout in class AWSIotMessage