Global

Members

iotcs․oracle․iot․client․controller․asyncRequestTimeout :number

The maximum time (in milliseconds) the enterprise client will wait for a response from any async request made to a device via the cloud service. These include virtual device attribute updates, actions, and resource invocations.
Type:
  • number
Default Value:
  • 60000

iotcs․oracle․iot․client․device․allowDraftDeviceModels :boolean

If this is set, the device client library is allowed to use draft device models when retrieving the models and when activating clients. If this is not set and getDeviceModel method returns a draft devices model, an error will be thrown.
Type:
  • boolean
Default Value:
  • false

iotcs․oracle․iot․client․device․defaultMessagePoolingInterval :number

The actual polling interval (in milliseconds) used by the MessageDispatcher for sending/receiving messages. If this is lower than iotcs․oracle․iot․client․monitor․pollingInterval, then that variable will be used as polling interval.
This is not used for receiving messages when iotcs․oracle․iot․client․device․disableLongPolling is set to false.
Type:
  • number
Default Value:
  • 3000

iotcs․oracle․iot․client․device․disableLongPolling :boolean

If this is set, the long polling feature is disabled and the global monitor is used for receiving messages by the device client library.
Type:
  • boolean
Default Value:
  • false

iotcs․oracle․iot․client․device․longPollingTimeoutOffset :number

Offset time (in milliseconds) added by the framework when using the device client receive method with the timeout parameter set.
Type:
  • number
Default Value:
  • 100

iotcs․oracle․iot․client․device․maximumMessagesPerConnection :number

The maximum number of messages sent by the MessagesDispatcher in one request.
Type:
  • number
Default Value:
  • 100

iotcs․oracle․iot․client․device․maximumMessagesToQueue :number

The MessageDispatcher queue size (in number of messages), for store and forward functionality.
Type:
  • number
Default Value:
  • 1000

iotcs․oracle․iot․client․device․messageDispatcherBackoff :number

Amount of time in milliseconds to backoff if the client receives an HTTP 503 response from the server. This is the initial value used for the amount of time to backoff. The backoff time increases exponentially if the server continues to return an HTTP 503 response.
Type:
  • number
Default Value:
  • 1000

iotcs․oracle․iot․client․device․messageDispatcherBaseNumberOfRetries :number

Controls the number of times a message is retried if the message cannot be sent. A message with a reliability of no-guarantee is retried this number of times. A message with a reliability of best-effort is retried twice this number of times. A message with a reliability of guaranteed-delivery is retried an unlimited number of times. The value must be greater than zero.
Type:
  • number
Default Value:
  • 3

iotcs․oracle․iot․client․device․persistenceDbName :string

Default name of the database used for persisting data.
Type:
  • string
Default Value:
  • msps.sqlite

iotcs․oracle․iot․client․device․persistenceEnabled :boolean

If true, the client library will persist data.
Type:
  • boolean
Default Value:
  • true

iotcs․oracle․iot․client․device․requestBufferSize :number

The size of the buffer (in bytes) used to store received messages by each device client.
Type:
  • number
Default Value:
  • 4192

iotcs․oracle․iot․client․disableStorageObjectPrefix :boolean

Disable prefixing the storage object's name with the device's client ID and a directory separator.
Type:
  • boolean
Default Value:
  • false

iotcs․oracle․iot․client․httpConnectionTimeout :number

Default timeout (in milliseconds) used when doing http/https requests. This can be overridden in certain contexts, like when using the long polling feature.
Type:
  • number
Default Value:
  • 15000

iotcs․oracle․iot․client․maximumStorageObjectsToQueue :number

The StorageDispatcher queue size (in number of storage objects), for store and forward functionality.
Type:
  • number
Default Value:
  • 50

iotcs․oracle․iot․client․maximumStorageObjectsToQueue :number

The StorageDispatcher queue size (in number of storage objects), for store and forward functionality.
Type:
  • number
Default Value:
  • 50

iotcs․oracle․iot․client․monitor․formatLimit :number

The maximum number of alerts/custom formats retrieved by the enterprise client when doing monitoring of virtual devices.
Type:
  • number
Default Value:
  • 10

iotcs․oracle․iot․client․monitor․pollingInterval :number

The time interval (in milliseconds) used by the monitor (JS interval) as the global thread pool of the iotcs client iotcs.ary.
In the enterprise client iotcs.ary, this is the actual polling interval used for virtual device monitoring, message monitoring, and async request response monitoring.
In the device client iotcs.ary, this is the minimum polling interval used by the MessageDispatcher for sending/receiving messages.
Type:
  • number
Default Value:
  • device: 1000, enterprise: 3000

iotcs․oracle․iot․client․pageable․defaultLimit :number

Default limit of items retrieved for each page when using Pageable functionality
Type:
  • number
Default Value:
  • 50

iotcs․oracle․iot․client․serverUrl :string

The configuration variable used by the enterprise iotcs.ary, only in a browser environment, to get the iotcs server host and port instead of the trusted assets manager. If this is not set, the default trusted assets manager is used.
Type:
  • string
Default Value:
  • null

iotcs․oracle․iot․client․storageCloudHost :string

The Storage Cloud server hostname.
Type:
  • string
Default Value:
  • "storage.oraclecloud.com"

iotcs․oracle․iot․client․storageCloudHost :string

The Storage Cloud server hostname.
Type:
  • string
Default Value:
  • "storage.oraclecloud.com"

iotcs․oracle․iot․client․storageCloudPort :number

The Storage Cloud server port.
Type:
  • number
Default Value:
  • 443

iotcs․oracle․iot․client․storageCloudPort :number

The Storage Cloud server port.
Type:
  • number
Default Value:
  • 443

iotcs․oracle․iot․client․storageTokenPeriod :number

The Storage Cloud server token validity period in minutes.
Type:
  • number
Default Value:
  • 30

iotcs․oracle․iot․tam․store :string

The trusted assets store file path, used as a global configuration, when initializing clients without the trusted assets manager-specific parameters. This is required in a browser environment.
Type:
  • string
Default Value:
  • 'trustedAssetsStore.json'

iotcs․oracle․iot․tam․storePassword :string

The trusted assets store password, used as a global configuration, when initializing clients without the trusted assets manager-specific parameters. This is required in a browser environment.
Type:
  • string
Default Value:
  • null

Home