Classes
Namespaces
Members
(static) description
Properties:
| Name | Type | Description |
|---|---|---|
iotcs.description |
string | The description of this library. |
(static) device.util.MessageDispatcher.BACKOFF_DELAY
Amount of time in milliseconds to backoff in the face of a 503 from the server.
This is the starting value for the amount of time to backoff.
The backoff time increases exponentially if the server continues to return a 503.
Defaults to 1000 milliseconds. Not less than 100 milliseconds.
(static) version
Properties:
| Name | Type | Description |
|---|---|---|
iotcs.version |
string | The version of this library. |
Methods
(static) createError()
Log and return an error message.
(static) device.util.DirectlyConnectedDevice#_calculateBackoff()
Takes a retry after value as a String and calculates and sets the backoff value.
(static) device.util.DirectlyConnectedDevice#_isBackoff()
Returns {@code true} if this DirectlyConnectedDeviceUtil is in backoff mode.
(static) device.util.DirectlyConnectedDevice#_sendReceiveMessages(messages, sentMsgsCallback, sentMsgsErrCallback, receivedMsgsCallback, longPolling, timeout)
Sends the messages in 'messages' and receives incoming messages and calls sentMessagesCallback
or errorCallback.
Parameters:
| Name | Type | Description |
|---|---|---|
messages |
Array.<message> | |
sentMsgsCallback |
function | Callback for successfully sent messages. |
sentMsgsErrCallback |
function | Callback for errors for sent messages. |
receivedMsgsCallback |
function | Callback for received messages. |
longPolling |
boolean | {@code true} to enable long polling. |
timeout |
number | the number of milliseconds to wait to hear a response from the server before giving up. |
(static) device.util.DirectlyConnectedDevice#_syncStorage(storageObject, deliveryCallback, errorCallback, processCallback)
Synchronizes the storage object by either uploading or downloading the object.
Parameters:
| Name | Type | Description |
|---|---|---|
storageObject |
iotcs.StorageObject | The storage object to sync. |
deliveryCallback |
function | The function to call when |
errorCallback |
function | The function to call when the sync fails. |
processCallback |
function | The function to call when |
(static) enterprise.MessageEnumerator._addMessageMonitor()
ignore
(static) enterprise.MessageEnumerator._handleMessagesResponse()
ignore
(static) enterprise.MessageEnumerator._messagesMonitor()
ignore
(static) enterprise.MessageEnumerator._removeMessageMonitor()
ignore
(static) error()
Throw and log an error message
(static) log()
Log an info message