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.
Dependencies: MAX44000 PWM_Tone_Library nexpaq_mdk
Fork of
LED_Demo
by 
Maxim nexpaq
multicast_api.h File Reference
Multicast Trickle Forwarding API. More...
Go to the source code of this file.
Functions | |
| void | multicast_set_parameters (uint8_t i_min, uint8_t i_max, uint8_t k, uint8_t timer_expirations, uint16_t window_expiration) |
| Set new parameters for trickle multicast. | |
| uint8_t | multicast_add_address (const uint8_t *address_ptr, uint8_t use_trickle) |
| Add new address to multicast group. | |
| uint8_t | multicast_free_address (uint8_t *address_ptr) |
| Free address from multicast group. | |
Detailed Description
Multicast Trickle Forwarding API.
Init API:
- multicast_set_parameters(), Set trickle parameters.
Configure API:
- multicast_add_address(), Add new address to a multicast group and control trickle forwarding.
- multicast_free_address(), Remove supported multicast address from list.
Trickle Setups for Multicast Init
| Parameter | VALUE | | :---------------: | :---: | | imin | 10 | | imax | 0 | | k | 20 | | timer_expirations | 3 | | window_expiration | 75 |
Definition in file multicast_api.h.
Function Documentation
| uint8_t multicast_add_address | ( | const uint8_t * | address_ptr, |
| uint8_t | use_trickle | ||
| ) |
Add new address to multicast group.
- Parameters:
-
address_ptr Pointer to a 16-byte array that includes the address to be added. use_trickle 0 = no trickle multicast forwarding, all other values = trickle multicast forwarding will be used with this address.
- Returns:
- 0 General error.
- 1 Address updated.
- 2 Address added.
- 255 Link local not allowed when using multicast.
| uint8_t multicast_free_address | ( | uint8_t * | address_ptr ) |
Free address from multicast group.
- Parameters:
-
address_ptr Pointer to a 16-byte array that includes the address to be removed.
- Returns:
- 0 will be returned on successful execution, other values indicate an error on removing the address.
| void multicast_set_parameters | ( | uint8_t | i_min, |
| uint8_t | i_max, | ||
| uint8_t | k, | ||
| uint8_t | timer_expirations, | ||
| uint16_t | window_expiration | ||
| ) |
Set new parameters for trickle multicast.
- Parameters:
-
i_min Minimum trickle timer interval in 50ms resolution: Imin = i_min * 50ms. i_max Maximum trickle timer interval as a number if doubling the minimum interval. k Redundancy constant. timer_expirations Number of trickle timer expirations before terminating the trickle process. window_expiration The time window for keeping the state after the end of trickle process in 50ms resolution. NOTE: If window_expiration value is set too small an infinite retransmission loop may occur when using the trickle multicast.
Generated on Tue Jul 12 2022 12:29:02 by
1.7.2