Defines the generic (downstream) interface any provisioning bearer should expose. More...
Data Structures | |
| struct | prov_bearer_interface_t |
| Struct used to provide an interface to provisioning bearers. More... | |
Typedefs | |
| typedef uint32_t(* | prov_bearer_if_tx_t) (prov_bearer_t *p_bearer, const uint8_t *p_data, uint16_t length) |
| Function used for transmitting a provisioning packet. More... | |
| typedef uint32_t(* | prov_bearer_if_listen_start_t) (prov_bearer_t *p_bearer, const char *p_uri, uint16_t oob_info, uint32_t link_timeout_us) |
| Function used to start listening for incoming provisioning links. More... | |
| typedef uint32_t(* | prov_bearer_if_listen_stop_t) (prov_bearer_t *p_bearer) |
| Function used to stop listening for incoming provisioning links. More... | |
| typedef uint32_t(* | prov_bearer_if_link_open_t) (prov_bearer_t *p_bearer, const uint8_t *p_uuid, uint32_t link_timeout_us) |
| Function used for opening a new provisioning link. More... | |
| typedef void(* | prov_bearer_if_link_close_t) (prov_bearer_t *p_bearer, nrf_mesh_prov_link_close_reason_t close_reason) |
| Function used for closing a provisioning link. More... | |
Defines the generic (downstream) interface any provisioning bearer should expose.
| typedef uint32_t(* prov_bearer_if_tx_t) (prov_bearer_t *p_bearer, const uint8_t *p_data, uint16_t length) |
Function used for transmitting a provisioning packet.
| [in,out] | p_bearer | Pointer to the bearer context structure. |
| [in] | p_data | Data to be transmitted. |
| [in] | length | Length of the data to be transmitted. |
NRF_SUCCESS on success or an error code otherwise. Any error will cause the provisioning procedure to fail. Definition at line 82 of file nrf_mesh_prov_bearer.h.
| typedef uint32_t(* prov_bearer_if_listen_start_t) (prov_bearer_t *p_bearer, const char *p_uri, uint16_t oob_info, uint32_t link_timeout_us) |
Function used to start listening for incoming provisioning links.
| [in,out] | p_bearer | Pointer to the bearer context structure. |
| [in] | p_data | An optional URI used for the unprovisioned beacon. Set to NULL to not include a URI in the beacon. |
| [in] | oob_info | OOB authentication information. |
| [in] | link_timeout_us | Duration of time the link can be idle before timing out. |
NRF_SUCCESS on success or an error code otherwise. Definition at line 93 of file nrf_mesh_prov_bearer.h.
| typedef uint32_t(* prov_bearer_if_listen_stop_t) (prov_bearer_t *p_bearer) |
Function used to stop listening for incoming provisioning links.
| [in,out] | p_bearer | Pointer to the bearer context structure. |
NRF_SUCCESS on success or an error code otherwise. Definition at line 103 of file nrf_mesh_prov_bearer.h.
| typedef uint32_t(* prov_bearer_if_link_open_t) (prov_bearer_t *p_bearer, const uint8_t *p_uuid, uint32_t link_timeout_us) |
Function used for opening a new provisioning link.
| [in,out] | p_bearer | Pointer to the bearer context structure. |
| [in] | p_uuid | UUID of the device to establish a link to. |
| [in] | link_timeout_us | Duration of time the link can be idle before timing out. |
NRF_SUCCESS on success or an error code otherwise. Any error will cause the provisioning procedure to fail. Definition at line 115 of file nrf_mesh_prov_bearer.h.
| typedef void(* prov_bearer_if_link_close_t) (prov_bearer_t *p_bearer, nrf_mesh_prov_link_close_reason_t close_reason) |
Function used for closing a provisioning link.
| [in,out] | p_bearer | Pointer to the bearer context structure. |
| [in] | close_reason | Reason for why the link is being closed. This is included in the close PDU. |
Definition at line 126 of file nrf_mesh_prov_bearer.h.