BT Mesh Configuration Job aggregates group of configuration tasks which targets the same configuration server model on a remote node.
Public Attributes#
List element (node) to support placement of jobs in singly-linked list.
Unique job identifier generated by btmesh_conf_job_id_generator.
Configuration tasks which shall be executed in the specified order.
Active configuration task.
Network key used to encrypt the config requests on the network layer.
Destination node primary element address.
Result of configuration job.
Configuration job status notification callback which is called when the status of the job changes at the end of the job.
Job status param can be set by the application to differentiate config jobs if the same callback function is used in multiple jobs.
Auto destroy deallocates the configuration job and its tasks automatically after the job status notification callback returns. If btmesh_conf_submit_job operation fails and the definition SL_BTMESH_CONF_JOB_AUTO_DESTROY_ON_SUBMIT_FAILURE_CFG_VAL is turned on then the job is deallocated automatically on submit failure.
Public Attribute Documentation#
list_elem#
sl_slist_node_t btmesh_conf_job_t::list_elem
List element (node) to support placement of jobs in singly-linked list.
job_id#
uint32_t btmesh_conf_job_t::job_id
Unique job identifier generated by btmesh_conf_job_id_generator.
task_tree#
btmesh_conf_task_t* btmesh_conf_job_t::task_tree
Configuration tasks which shall be executed in the specified order.
enc_netkey_index#
uint16_t btmesh_conf_job_t::enc_netkey_index
Network key used to encrypt the config requests on the network layer.
on_job_notification#
void(* btmesh_conf_job_t::on_job_notification) (const btmesh_conf_job_t *job)
Configuration job status notification callback which is called when the status of the job changes at the end of the job.
job_status_param#
btmesh_conf_varg_t btmesh_conf_job_t::job_status_param
Job status param can be set by the application to differentiate config jobs if the same callback function is used in multiple jobs.
auto_destroy#
bool btmesh_conf_job_t::auto_destroy
Auto destroy deallocates the configuration job and its tasks automatically after the job status notification callback returns. If btmesh_conf_submit_job operation fails and the definition SL_BTMESH_CONF_JOB_AUTO_DESTROY_ON_SUBMIT_FAILURE_CFG_VAL is turned on then the job is deallocated automatically on submit failure.