Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: TYBLE16_simple_data_logger TYBLE16_MP3_Air
thread_bbr_api.h File Reference
Thread backbone border router (BBR) application interface. More...
Go to the source code of this file.
Functions | |
| int | thread_bbr_start (int8_t interface_id, int8_t backbone_interface_id) |
| Start backbone border router service. | |
| int | thread_bbr_timeout_set (int8_t interface_id, uint32_t timeout_a, uint32_t timeout_b, uint32_t delay) |
| Set the bbr timeout values. | |
| int | thread_bbr_prefix_set (int8_t interface_id, uint8_t *prefix) |
| Set prefix to be used as combining multiple thread networks on backbone. | |
| int | thread_bbr_sequence_number_set (int8_t interface_id, uint8_t sequence_number) |
| Set sequence number to be used by bbr. | |
| int | thread_bbr_validation_interface_address_set (int8_t interface_id, const uint8_t *addr_ptr, uint16_t port) |
| Set the Thread validation interface destination address. | |
| void | thread_bbr_stop (int8_t interface_id) |
| Stop backbone Border router. | |
Detailed Description
Thread backbone border router (BBR) application interface.
This is Thread backbone Border router service. When started the module takes care of starting the components that enables default border router functionality in Thread mesh network.
Definition in file thread_bbr_api.h.
Function Documentation
| int thread_bbr_prefix_set | ( | int8_t | interface_id, |
| uint8_t * | prefix | ||
| ) |
Set prefix to be used as combining multiple thread networks on backbone.
update prefix value
- Parameters:
-
interface_id interface ID of the Thread network. prefix value must be buffer at the size of 8 bytes
- Returns:
- 0 on success
- <0 in case of errors
Definition at line 1176 of file thread_bbr_api.c.
| int thread_bbr_sequence_number_set | ( | int8_t | interface_id, |
| uint8_t | sequence_number | ||
| ) |
Set sequence number to be used by bbr.
update sequence number value
- Parameters:
-
interface_id interface ID of the Thread network. sequence_number value that needs to be set on bbr
- Returns:
- 0 on success
- <0 in case of errors
Definition at line 1187 of file thread_bbr_api.c.
| int thread_bbr_start | ( | int8_t | interface_id, |
| int8_t | backbone_interface_id | ||
| ) |
Start backbone border router service.
Enables the mDNS responder with default service name. <rand>-ARM-<Network name> if backbone interface is enabled and allows routing. Publishes Default route with DHCP addressing Enables ND proxy
- Parameters:
-
interface_id Thread network interface id. backbone_interface_id backbone interface id.
- Returns:
- 0 on success
- <0 in case of errors
Definition at line 1112 of file thread_bbr_api.c.
| void thread_bbr_stop | ( | int8_t | interface_id ) |
Stop backbone Border router.
- Parameters:
-
interface_id interface ID of the Thread network
- Returns:
- 0 on success
- <0 in case of errors
Definition at line 1210 of file thread_bbr_api.c.
| int thread_bbr_timeout_set | ( | int8_t | interface_id, |
| uint32_t | timeout_a, | ||
| uint32_t | timeout_b, | ||
| uint32_t | delay | ||
| ) |
Set the bbr timeout values.
Default timeout values are used if not called.
If this function is called it will trigger the modification to thread network causing' refreshing of registrations.
- Parameters:
-
interface_id interface ID of the Thread network. timeout_a timeout a set. 0 = do not change. timeout_b timeout_b set. 0 = do not change delay Jitter delay value. 0 do not change
- Returns:
- 0 on success
- <0 in case of errors
Definition at line 1161 of file thread_bbr_api.c.
| int thread_bbr_validation_interface_address_set | ( | int8_t | interface_id, |
| const uint8_t * | addr_ptr, | ||
| uint16_t | port | ||
| ) |
Set the Thread validation interface destination address.
- Parameters:
-
interface_id interface ID of the Thread network. addr_ptr IPv6 address. port UDP port.
- Returns:
- 0 on success
- <0 in case of errors
Definition at line 1198 of file thread_bbr_api.c.
Generated on Tue Jul 12 2022 13:55:19 by
1.7.2