Lines Matching full:a
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
70 * Represents a Thread device role.
75 OT_DEVICE_ROLE_DETACHED = 1, ///< Not currently participating in a Thread network/partition.
92 * Holds diagnostic information for a neighboring Thread node
112 bool mIsChild : 1; ///< Is the neighbor a child
132 * Holds diagnostic information for a Thread Router
178 … uint16_t mBetterPartitionAttachAttempts; ///< Number of attempts to attach to a better partition.
179 …uint16_t mBetterParentAttachAttempts; ///< Number of attempts to attach to find a better parent…
196 …* A parent change can happen if device detaches from its current parent and attaches to a differen…
221 * @param[in] aContext A pointer to application-specific context.
226 * Informs the application about the result of waking a Wake-up End Device.
228 …* @param[in] aError OT_ERROR_NONE Indicates that the Wake-up End Device has been added as a n…
229 …* OT_ERROR_FAILED Indicates that the Wake-up End Device has not received a wa…
231 * @param[in] aContext A pointer to application-specific context.
243 * @param[in] aInstance A pointer to an OpenThread instance.
261 * Indicates whether a node is the only router on the network.
263 * @param[in] aInstance A pointer to an OpenThread instance.
266 * @retval FALSE It is a child or is not a single router in the network.
271 * Starts a Thread Discovery scan.
273 …* @note A successful call to this function enables the rx-on-when-idle mode for the entire scan pr…
275 * @param[in] aInstance A pointer to an OpenThread instance.
276 …* @param[in] aScanChannels A bit vector indicating which channels to scan (e.g. OT_CHANN…
280 …* @param[in] aCallback A pointer to a function called on receiving an MLE Discovery …
282 * @param[in] aCallbackContext A pointer to application-specific context.
284 * @retval OT_ERROR_NONE Successfully started a Thread Discovery Scan.
300 * @param[in] aInstance A pointer to an OpenThread instance.
307 …* Thread Joiner Advertisement is used to allow a Joiner to advertise its own application-specific …
308 …* (such as Vendor ID, Product ID, Discriminator, etc.) via a newly-proposed Joiner Advertisement T…
311 * @param[in] aInstance A pointer to an OpenThread instance.
314 …* @param[in] aAdvData A pointer to the AdvData that will be included in the Joiner Advert…
330 * @param[in] aInstance A pointer to an OpenThread instance.
341 * @param[in] aInstance A pointer to an OpenThread instance.
351 * @param[in] aInstance A pointer to an OpenThread instance.
353 * @returns A pointer to the IEEE 802.15.4 Extended PAN ID.
362 * @note Can only be called while Thread protocols are disabled. A successful
366 * @param[in] aInstance A pointer to an OpenThread instance.
367 * @param[in] aExtendedPanId A pointer to the IEEE 802.15.4 Extended PAN ID.
377 * Returns a pointer to the Leader's RLOC.
379 * @param[in] aInstance A pointer to an OpenThread instance.
380 * @param[out] aLeaderRloc A pointer to the Leader's RLOC.
384 * @retval OT_ERROR_DETACHED Not currently attached to a Thread Partition.
391 * @param[in] aInstance A pointer to an OpenThread instance.
402 * @param[in] aInstance A pointer to an OpenThread instance.
403 * @param[in] aConfig A pointer to the Link Mode configuration.
414 * @param[in] aInstance A pointer to an OpenThread instance.
415 * @param[out] aNetworkKey A pointer to an `otNetworkKey` to return the Thread Network Key.
426 * @param[in] aInstance A pointer to an OpenThread instance.
437 * Succeeds only when Thread protocols are disabled. A successful
441 * @param[in] aInstance A pointer to an OpenThread instance.
442 * @param[in] aKey A pointer to a buffer containing the Thread Network Key.
452 * Set the Thread Network Key as a `otNetworkKeyRef`.
454 * Succeeds only when Thread protocols are disabled. A successful
460 * @param[in] aInstance A pointer to an OpenThread instance.
473 * @param[in] aInstance A pointer to an OpenThread instance.
475 * @returns A pointer to the Thread Routing Locator (RLOC) address.
482 * @param[in] aInstance A pointer to an OpenThread instance.
484 * @returns A pointer to the Mesh Local EID address.
489 * Returns a pointer to the Mesh Local Prefix.
491 * @param[in] aInstance A pointer to an OpenThread instance.
493 * @returns A pointer to the Mesh Local Prefix.
500 * Succeeds only when Thread protocols are disabled. A successful
504 * @param[in] aInstance A pointer to an OpenThread instance.
505 * @param[in] aMeshLocalPrefix A pointer to the Mesh Local Prefix.
517 * @param[in] aInstance A pointer to an OpenThread instance.
519 * @returns A pointer to Thread link-local IPv6 address.
526 * The address is a link-local Unicast Prefix-Based Multicast Address [RFC 3306], with:
533 * @param[in] aInstance A pointer to an OpenThread instance.
535 * @returns A pointer to Thread Link-Local All Thread Nodes multicast address.
542 * The address is a realm-local Unicast Prefix-Based Multicast Address [RFC 3306], with:
549 * @param[in] aInstance A pointer to an OpenThread instance.
551 * @returns A pointer to Thread Realm-Local All Thread Nodes multicast address.
558 * @param[in] aInstance A pointer to an OpenThread instance.
560 * @param[out] aServiceAloc A pointer to output the Service ALOC. MUST NOT BE NULL.
563 * @retval OT_ERROR_DETACHED The Thread interface is not currently attached to a Thread Partition.
570 * @param[in] aInstance A pointer to an OpenThread instance.
572 * @returns A pointer to the Thread Network Name.
581 * Succeeds only when Thread protocols are disabled. A successful
585 * @param[in] aInstance A pointer to an OpenThread instance.
586 * @param[in] aNetworkName A pointer to the Thread Network Name.
600 * @param[in] aInstance A pointer to an OpenThread instance.
602 * @returns A pointer to the Thread Domain Name.
613 * @param[in] aInstance A pointer to an OpenThread instance.
614 * @param[in] aDomainName A pointer to the Thread Domain Name.
630 * @param[in] aInstance A pointer to an OpenThread instance.
631 * @param[in] aIid A pointer to the Interface Identifier to set or NULL to clear.
647 * @param[in] aInstance A pointer to an OpenThread instance.
649 * @returns A pointer to the Interface Identifier which was set manually, or NULL if none was set.
658 * @param[in] aInstance A pointer to an OpenThread instance.
670 * this API will render a production application non-compliant with the Thread Specification.
672 * @param[in] aInstance A pointer to an OpenThread instance.
682 * @param[in] aInstance A pointer to an OpenThread instance.
694 * this API will render a production application non-compliant with the Thread Specification.
696 * @param[in] aInstance A pointer to an OpenThread instance.
706 * @param[in] aInstance A pointer to an OpenThread instance.
714 * Attempt to reattach as a child.
717 * this API will render a production application non-compliant with the Thread Specification.
719 * @param[in] aInstance A pointer to an OpenThread instance.
721 * @retval OT_ERROR_NONE Successfully begin attempt to become a child.
730 * @param[in] aInstance A pointer to an OpenThread instance.
731 * @param[in,out] aIterator A pointer to the iterator context. To get the first neighbor entry
733 * @param[out] aInfo A pointer to the neighbor information.
744 * @param[in] aInstance A pointer to an OpenThread instance.
747 …* @retval OT_DEVICE_ROLE_DETACHED The device is not currently participating in a Thread network/p…
748 * @retval OT_DEVICE_ROLE_CHILD The device is currently operating as a Thread Child.
749 * @retval OT_DEVICE_ROLE_ROUTER The device is currently operating as a Thread Router.
750 * @retval OT_DEVICE_ROLE_LEADER The device is currently operating as a Thread Leader.
759 * @returns A string representing @p aRole.
766 * @param[in] aInstance A pointer to an OpenThread instance.
767 * @param[out] aLeaderData A pointer to where the leader data is placed.
777 * @param[in] aInstance A pointer to an OpenThread instance.
786 * @param[in] aInstance A pointer to an OpenThread instance.
795 * @param[in] aInstance A pointer to an OpenThread instance.
804 * @param[in] aInstance A pointer to an OpenThread instance.
811 * The function retrieves diagnostic information for a Thread Router as parent.
813 * @param[in] aInstance A pointer to an OpenThread instance.
814 * @param[out] aParentInfo A pointer to where the parent router information is placed.
821 * @param[in] aInstance A pointer to an OpenThread instance.
822 * @param[out] aParentRssi A pointer to where the parent RSSI should be placed.
829 * @param[in] aInstance A pointer to an OpenThread instance.
830 * @param[out] aLastRssi A pointer to where the last RSSI should be placed.
839 …* Starts the process for child to search for a better parent while staying attached to its current…
841 * Must be used when device is attached as a child.
843 * @retval OT_ERROR_NONE Successfully started the process to search for a better parent.
851 * @param[in] aInstance A pointer to an OpenThread instance.
853 * @returns A pointer to the IPv6 counters.
860 * @param[in] aInstance A pointer to an OpenThread instance.
870 …* direct transmissions only and is measured as the duration from when a message is added to the tr…
874 …* (at index 0) represents the number of messages with a time-in-queue less than `aBinInterval`. Th…
875 …* represents the number of messages with a time-in-queue greater than or equal to `aBinInterval`, …
885 * @param[in] aInstance A pointer to an OpenThread instance.
889 * @returns A pointer to an array of @p aNumBins entries representing the collected histogram info.
898 …eue is tracked for direct transmissions only and is measured as the duration from when a message is
903 * @param[in] aInstance A pointer to an OpenThread instance.
914 * @param[in] aInstance A pointer to an OpenThread instance.
921 * @param[in] aInstance A pointer to an OpenThread instance.
923 * @returns A pointer to the Thread MLE counters.
930 * @param[in] aInstance A pointer to an OpenThread instance.
943 …* connected to the Thread mesh (regardless of its role, whether acting as a child, router, or lead…
945 * @param[in] aInstance A pointer to an OpenThread instance.
956 * @param[in] aInfo A pointer to a location on stack holding the stats data.
957 * @param[in] aContext A pointer to callback client-specific context.
962 * Registers a callback to receive MLE Parent Response data.
966 * @param[in] aInstance A pointer to an OpenThread instance.
967 …* @param[in] aCallback A pointer to a function that is called upon receiving an MLE Parent Respo…
968 * @param[in] aContext A pointer to callback client-specific context.
987 * @param[in] aInfo A pointer to the Discovery Request info data.
988 * @param[in] aContext A pointer to callback application-specific context.
993 * Sets a callback to receive MLE Discovery Request data.
995 * @param[in] aInstance A pointer to an OpenThread instance.
996 …* @param[in] aCallback A pointer to a function that is called upon receiving an MLE Discovery Re…
997 * @param[in] aContext A pointer to callback application-specific context.
1004 * Pointer type defines the callback to notify the outcome of a `otThreadLocateAnycastDestination()`
1007 …* @param[in] aContext A pointer to an arbitrary context (provided when callback is regi…
1009 …* OT_ERROR_RESPONSE_TIMEOUT indicates a destination could not be fo…
1011 …* @param[in] aMeshLocalAddress A pointer to the mesh-local EID of the closest destination of the…
1021 * Requests the closest destination of a given anycast address to be located.
1025 …* If a previous request is ongoing, a subsequent call to this function will cancel and replace the…
1027 * @param[in] aInstance A pointer to an OpenThread instance.
1033 …* @retval OT_ERROR_INVALID_ARGS The @p aAnycastAddress is not a valid anycast address or @p aCall…
1046 * @param[in] aInstance A pointer to an OpenThread instance.
1053 * Sends a Proactive Address Notification (ADDR_NTF.ntf) message.
1057 * @param[in] aInstance A pointer to an OpenThread instance.
1068 * Sends a Proactive Backbone Notification (PRO_BB.ntf) message on the Backbone link.
1072 * @param[in] aInstance A pointer to an OpenThread instance.
1088 * It sends an Address Release if it's a router, or sets its child timeout to 0 if it's a child.
1090 * @param[in] aInstance A pointer to an OpenThread instance.
1091 * @param[in] aCallback A pointer to a function that is called upon finishing detaching.
1092 * @param[in] aContext A pointer to callback application-specific context.
1102 * Converts an `uint32_t` duration (in seconds) to a human-readable string.
1107 * "<dd>d.<hh>:<mm>:<ss>" (if longer than a day).
1114 * @param[in] aDuration A duration interval in seconds.
1115 * @param[out] aBuffer A pointer to a char array to output the string.
1129 * @param[in] aInstance A pointer to an OpenThread instance.
1139 * @param[in] aInstance A pointer to an OpenThread instance.
1146 * Attempts to wake a Wake-up End Device.
1150 * The wake-up starts with transmitting a wake-up frame sequence to the Wake-up End Device.
1151 …* During the wake-up sequence, and for a short time after the last wake-up frame is sent, the Wake…
1157 * @param[in] aInstance A pointer to an OpenThread instance.
1161 …* @param[in] aCallback A pointer to function that is called when the wake-up succeeds or f…
1162 * @param[in] aCallbackContext A pointer to callback application-specific context.