Diff: inc/net/multicast_api.h

Revision:

4:c449bead5cf3

Child:

11:1b7aaf37a131

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/inc/net/multicast_api.h	Tue Jun 24 16:48:01 2014 +0300
@@ -0,0 +1,64 @@
+#ifndef MULTICAST_API_H_
+#define MULTICAST_API_H_
+/**
+ * \file multicast_api.h
+ * \brief Multicast Trickle Forwarding API.
+ * \section multi-init Init API:
+ * - multicast_set_parameters(), Set Trickle Parameters
+ * \section multi-cnf Configure API:
+ * - multicast_add_address(), Add new address to multicast group and control Trickle forwarding
+ * - multicast_free_address(), Remove supported Multicast address from List
+ *
+ * \section ZigBeeIP Trickle Setups for Multicast Init
+ *
+ * | Parameter         | VALUE |
+ * | :---------------: | :---: |
+ * | imin      		   | 10    |
+ * | imax      		   | 0     |
+ * | k         		   | 20    |
+ * | timer_expirations | 3     |
+ * | window_expiration | 75    |
+ *
+ */
+
+
+
+
+/**
+ * \brief Set new parameters for Trickle Multicast.
+ *
+ * \param i_min Minimum Trickle timer interval in 50ms resolution: Imin = i_min * 50ms.
+ * \param i_max Maximum Trickle timer interval as number if doubling of minimum interval.
+ * \param k Redundancy constant.
+ * \param timer_expirations Number if Trickle timer expirations before terminating Trickle process.
+ * \param window_expiration Time window state is kept after Trickle process has ended in 50ms resolution.
+ * 	      NOTE: If window_expiration value is set too small an infinite retransmission loop may occur when using the trickle multicast.
+ */
+extern void multicast_set_parameters(uint8_t i_min, uint8_t i_max, uint8_t k, uint8_t timer_expirations, uint8_t window_expiration);
+
+
+/**
+ * \brief Add new address to multicast group.
+ *
+ * \param address_ptr Pointer to a 16-byte array that includes the address to be added.
+ * \param use_trickle 0 = no trickle multicast forwarding, all other values = trickle multicast forwarding will be used with this address.
+ *
+ * \return 0 general error.
+ * \return 1 address updated.
+ * \return 2 address added.
+ * \return 255 link local not allowed when using multicast.
+*
+ */
+extern uint8_t multicast_add_address(uint8_t *address_ptr, uint8_t use_trickle);
+
+
+
+/**
+ * \brief Free address from multicast group.
+ *
+ * \param address_ptr Pointer to a 16-byte array that includes the address to be removed.
+ *
+ * \return 0 will be returned on successful execution, other values indicate an error on removing the address.
+ */
+extern uint8_t multicast_free_address(uint8_t *address_ptr);
+#endif /* MULTICAST_API_H_ */