openthread_sys

Function otDatasetUpdaterRequestUpdate

Source
pub unsafe extern "C" fn otDatasetUpdaterRequestUpdate(
    aInstance: *mut otInstance,
    aDataset: *const otOperationalDataset,
    aCallback: otDatasetUpdaterCallback,
    aContext: *mut c_void,
) -> otError
Expand description

Requests an update to Operational Dataset.

Available when OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE is enabled.

@p aDataset should contain the fields to be updated and their new value. It must not contain Active or Pending Timestamp fields. The Delay field is optional, if not provided a default value (1000 ms) would be used.

@param[in] aInstance A pointer to an OpenThread instance. @param[in] aDataset A pointer to the Dataset containing the fields to change. @param[in] aCallback A callback to indicate when Dataset update request finishes. @param[in] aContext An arbitrary context passed to callback.

@retval OT_ERROR_NONE Dataset update started successfully (@p aCallback will be invoked on completion). @retval OT_ERROR_INVALID_STATE Device is disabled (MLE is disabled). @retval OT_ERROR_INVALID_ARGS The @p aDataset is not valid (contains Active or Pending Timestamp). @retval OT_ERROR_BUSY Cannot start update, a previous one is ongoing. @retval OT_ERROR_NO_BUFS Could not allocated buffer to save Dataset.