espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-08-13 06:07:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

[docs] remove redundant "This method" and "This function" (#9096)

Browse Source 
- "This method "
- "This static method "
- "This function "
- "This structure "
- "This enumeration "
- "This class "
- "This methods "
- "This constructor "
- "This struct "
- "This type "
- "This template method "
- "This template class "
- "This const method "
- "This macro "
This commit is contained in:
Jonathan Hui
2023-05-29 10:11:10 -07:00
committed by GitHub
parent 77d4b78a69
commit 73ce42c6e6
336 changed files with 6677 additions and 6677 deletions
Download Patch File Download Diff File Expand all files Collapse all files
examples/apps/cli/main.c
+1 -1
View File
@@ -42,7 +42,7 @@
#include "lib/platform/reset_util.h"
/**
* This function initializes the CLI app.
* Initializes the CLI app.
*
* @param[in] aInstance The OpenThread instance structure.
*
examples/apps/ncp/main.c
+1 -1
View File
@@ -38,7 +38,7 @@
#include "lib/platform/reset_util.h"
/**
* This function initializes the NCP app.
* Initializes the NCP app.
*
* @param[in] aInstance The OpenThread instance structure.
*
examples/platforms/openthread-system.h
+5 -5
View File
@@ -42,7 +42,7 @@ extern "C" {
#endif
/**
* This function performs all platform-specific initialization of OpenThread's drivers.
* Performs all platform-specific initialization of OpenThread's drivers.
*
* @note This function is not called by the OpenThread library. Instead, the system/RTOS should call this function
* when initialization of OpenThread's drivers is most appropriate.
@@ -54,7 +54,7 @@ extern "C" {
void otSysInit(int argc, char *argv[]);
/**
* This function performs all platform-specific deinitialization for OpenThread's drivers.
* Performs all platform-specific deinitialization for OpenThread's drivers.
*
* @note This function is not called by the OpenThread library. Instead, the system/RTOS should call this function
* when deinitialization of OpenThread's drivers is most appropriate.
@@ -63,7 +63,7 @@ void otSysInit(int argc, char *argv[]);
void otSysDeinit(void);
/**
* This function returns true if a pseudo-reset was requested.
* Returns true if a pseudo-reset was requested.
*
* In such a case, the main loop should shut down and re-initialize the OpenThread instance.
*
@@ -74,7 +74,7 @@ void otSysDeinit(void);
bool otSysPseudoResetWasRequested(void);
/**
* This function performs all platform-specific processing for OpenThread's example applications.
* Performs all platform-specific processing for OpenThread's example applications.
*
* @note This function is not called by the OpenThread library. Instead, the system/RTOS should call this function
* in the main loop when processing OpenThread's drivers is most appropriate.
@@ -85,7 +85,7 @@ bool otSysPseudoResetWasRequested(void);
void otSysProcessDrivers(otInstance *aInstance);
/**
* This function is called whenever platform drivers needs processing.
* Is called whenever platform drivers needs processing.
*
* @note This function is not handled by the OpenThread library. Instead, the system/RTOS should handle this function
* and schedule a call to `otSysProcessDrivers()`.
examples/platforms/simulation/platform-simulation.h
+25 -25
View File
@@ -91,13 +91,13 @@ enum
extern uint32_t gNodeId;
/**
* This function initializes the alarm service used by OpenThread.
* Initializes the alarm service used by OpenThread.
*
*/
void platformAlarmInit(uint32_t aSpeedUpFactor);
/**
* This function retrieves the time remaining until the alarm fires.
* Retrieves the time remaining until the alarm fires.
*
* @param[out] aTimeout A pointer to the timeval struct.
*
@@ -105,7 +105,7 @@ void platformAlarmInit(uint32_t aSpeedUpFactor);
void platformAlarmUpdateTimeout(struct timeval *aTimeout);
/**
* This function performs alarm driver processing.
* Performs alarm driver processing.
*
* @param[in] aInstance The OpenThread instance structure.
*
@@ -113,7 +113,7 @@ void platformAlarmUpdateTimeout(struct timeval *aTimeout);
void platformAlarmProcess(otInstance *aInstance);
/**
* This function returns the duration to the next alarm event time (in micro seconds)
* Returns the duration to the next alarm event time (in micro seconds)
*
* @returns The duration (in micro seconds) to the next alarm event.
*
@@ -121,7 +121,7 @@ void platformAlarmProcess(otInstance *aInstance);
uint64_t platformAlarmGetNext(void);
/**
* This function returns the current alarm time.
* Returns the current alarm time.
*
* @returns The current alarm time.
*
@@ -129,7 +129,7 @@ uint64_t platformAlarmGetNext(void);
uint64_t platformAlarmGetNow(void);
/**
* This function advances the alarm time by @p aDelta.
* Advances the alarm time by @p aDelta.
*
* @param[in] aDelta The amount of time to advance.
*
@@ -137,19 +137,19 @@ uint64_t platformAlarmGetNow(void);
void platformAlarmAdvanceNow(uint64_t aDelta);
/**
* This function initializes the radio service used by OpenThread.
* Initializes the radio service used by OpenThread.
*
*/
void platformRadioInit(void);
/**
* This function shuts down the radio service used by OpenThread.
* Shuts down the radio service used by OpenThread.
*
*/
void platformRadioDeinit(void);
/**
* This function inputs a received radio frame.
* Inputs a received radio frame.
*
* @param[in] aInstance A pointer to the OpenThread instance.
* @param[in] aBuf A pointer to the received radio frame.
@@ -159,7 +159,7 @@ void platformRadioDeinit(void);
void platformRadioReceive(otInstance *aInstance, uint8_t *aBuf, uint16_t aBufLength);
/**
* This function updates the file descriptor sets with file descriptors used by the radio driver.
* Updates the file descriptor sets with file descriptors used by the radio driver.
*
* @param[in,out] aReadFdSet A pointer to the read file descriptors.
* @param[in,out] aWriteFdSet A pointer to the write file descriptors.
@@ -170,7 +170,7 @@ void platformRadioReceive(otInstance *aInstance, uint8_t *aBuf, uint16_t aBufLen
void platformRadioUpdateFdSet(fd_set *aReadFdSet, fd_set *aWriteFdSet, struct timeval *aTimeout, int *aMaxFd);
/**
* This function performs radio driver processing.
* Performs radio driver processing.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aReadFdSet A pointer to the read file descriptors.
@@ -180,7 +180,7 @@ void platformRadioUpdateFdSet(fd_set *aReadFdSet, fd_set *aWriteFdSet, struct ti
void platformRadioProcess(otInstance *aInstance, const fd_set *aReadFdSet, const fd_set *aWriteFdSet);
/**
* This function initializes the random number service used by OpenThread.
* Initializes the random number service used by OpenThread.
*
*/
void platformRandomInit(void);
@@ -194,7 +194,7 @@ void platformRandomInit(void);
void platformLoggingSetFileName(const char *aName);
/**
* This function initializes the platform logging service.
* Initializes the platform logging service.
*
* @param[in] aName The log module name to set with syslog.
*
@@ -202,13 +202,13 @@ void platformLoggingSetFileName(const char *aName);
void platformLoggingInit(const char *aName);
/**
* This function finalizes the platform logging service.
* Finalizes the platform logging service.
*
*/
void platformLoggingDeinit(void);
/**
* This function updates the file descriptor sets with file descriptors used by the UART driver.
* Updates the file descriptor sets with file descriptors used by the UART driver.
*
* @param[in,out] aReadFdSet A pointer to the read file descriptors.
* @param[in,out] aWriteFdSet A pointer to the write file descriptors.
@@ -218,19 +218,19 @@ void platformLoggingDeinit(void);
void platformUartUpdateFdSet(fd_set *aReadFdSet, fd_set *aWriteFdSet, fd_set *aErrorFdSet, int *aMaxFd);
/**
* This function performs radio driver processing.
* Performs radio driver processing.
*
*/
void platformUartProcess(void);
/**
* This function restores the Uart.
* Restores the Uart.
*
*/
void platformUartRestore(void);
/**
* This function sends a simulation event.
* Sends a simulation event.
*
* @param[in] aEvent A pointer to the simulation event to send
*
@@ -238,7 +238,7 @@ void platformUartRestore(void);
void otSimSendEvent(const struct Event *aEvent);
/**
* This function sends Uart data through simulation.
* Sends Uart data through simulation.
*
* @param[in] aData A pointer to the UART data.
* @param[in] aLength Length of UART data.
@@ -247,7 +247,7 @@ void otSimSendEvent(const struct Event *aEvent);
void otSimSendUartWriteEvent(const uint8_t *aData, uint16_t aLength);
/**
* This function checks if radio transmitting is pending.
* Checks if radio transmitting is pending.
*
* @returns Whether radio transmitting is pending.
*
@@ -255,7 +255,7 @@ void otSimSendUartWriteEvent(const uint8_t *aData, uint16_t aLength);
bool platformRadioIsTransmitPending(void);
/**
* This function parses an environment variable as an unsigned 16-bit integer.
* Parses an environment variable as an unsigned 16-bit integer.
*
* If the environment variable does not exist, this function does nothing.
* If it is not a valid integer, this function will terminate the process with an error message.
@@ -269,7 +269,7 @@ void parseFromEnvAsUint16(const char *aEnvName, uint16_t *aValue);
#if OPENTHREAD_CONFIG_RADIO_LINK_TREL_ENABLE
/**
* This function initializes the TREL service.
* Initializes the TREL service.
*
* @param[in] aSpeedUpFactor The time speed-up factor.
*
@@ -277,13 +277,13 @@ void parseFromEnvAsUint16(const char *aEnvName, uint16_t *aValue);
void platformTrelInit(uint32_t aSpeedUpFactor);
/**
* This function shuts down the TREL service.
* Shuts down the TREL service.
*
*/
void platformTrelDeinit(void);
/**
* This function updates the file descriptor sets with file descriptors used by the TREL.
* Updates the file descriptor sets with file descriptors used by the TREL.
*
* @param[in,out] aReadFdSet A pointer to the read file descriptors.
* @param[in,out] aWriteFdSet A pointer to the write file descriptors.
@@ -294,7 +294,7 @@ void platformTrelDeinit(void);
void platformTrelUpdateFdSet(fd_set *aReadFdSet, fd_set *aWriteFdSet, struct timeval *aTimeout, int *aMaxFd);
/**
* This function performs TREL processing.
* Performs TREL processing.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aReadFdSet A pointer to the read file descriptors.
examples/platforms/simulation/system.c
+1 -1
View File
@@ -64,7 +64,7 @@ static void handleSignal(int aSignal)
}
/**
* This enumeration defines the argument return values.
* Defines the argument return values.
*
*/
enum
examples/platforms/utils/code_utils.h
+1 -1
View File
@@ -72,7 +72,7 @@
} while (0)
/**
* This macro calculates the number of elements in an array.
* Calculates the number of elements in an array.
*
* @param[in] aArray Name of the array variable.
*
examples/platforms/utils/link_metrics.cpp
+3 -3
View File
@@ -71,7 +71,7 @@ public:
}
/**
* This method gets Link Metrics data stored in this object.
* Gets Link Metrics data stored in this object.
*
* TODO: Currently the order of Link Metircs data is fixed. Will update it to follow the order specified in TLV.
*
@@ -114,7 +114,7 @@ public:
}
/**
* This method gets the length of Link Metrics Data.
* Gets the length of Link Metrics Data.
*
* @returns The number of bytes for the data.
*
@@ -126,7 +126,7 @@ public:
}
/**
* This method gets the metrics configured for the Enhanced-ACK Based Probing.
* Gets the metrics configured for the Enhanced-ACK Based Probing.
*
* @returns The metrics configured.
*
examples/platforms/utils/link_metrics.h
+6 -6
View File
@@ -48,7 +48,7 @@ extern "C" {
#endif
/**
* This method initializes the Link Metrics util module.
* Initializes the Link Metrics util module.
*
* @param[in] aNoiseFloor The noise floor used by Link Metrics. It should be set to the platform's
* noise floor (measured noise floor, receiver sensitivity or a constant).
@@ -57,9 +57,9 @@ extern "C" {
void otLinkMetricsInit(int8_t aNoiseFloor);
/**
* This method sets/clears Enhanced-ACK Based Probing for a specific Initiator.
* Sets/clears Enhanced-ACK Based Probing for a specific Initiator.
*
* This method can start/stop Enhanced-ACK Based Probing for a neighbor that has the address @p aShortAddress and
* Can start/stop Enhanced-ACK Based Probing for a neighbor that has the address @p aShortAddress and
* @p aExtAddress. Once the Probing is started, the device would record the Link Metrics data of link layer frames
* sent from that neighbor and include the data into header IE in Enhanced-ACK sent to that neighbor.
*
@@ -79,10 +79,10 @@ otError otLinkMetricsConfigureEnhAckProbing(otShortAddress aShortAddress,
otLinkMetrics aLinkMetrics);
/**
* This method generates the Link Metrics data (assessed for the acknowledged frame) bytes that would be included in
* Generates the Link Metrics data (assessed for the acknowledged frame) bytes that would be included in
* Vendor-Specific IE.
*
* This method first checks what Link Metrics are specified by the Initiator indicated by @p aMacAddress. And then
* First checks what Link Metrics are specified by the Initiator indicated by @p aMacAddress. And then
* write the values to @p aData.
*
* @param[in] aMacAddress The Mac address of the Initiator.
@@ -98,7 +98,7 @@ otError otLinkMetricsConfigureEnhAckProbing(otShortAddress aShortAddress,
uint8_t otLinkMetricsEnhAckGenData(const otMacAddress *aMacAddress, uint8_t aLqi, int8_t aRssi, uint8_t *aData);
/**
* This method returns the data length of Enhanced-ACK Based Probing for a specific Initiator.
* Returns the data length of Enhanced-ACK Based Probing for a specific Initiator.
*
* @param[in] aMacAddress The Mac address of the Initiator.
*
examples/platforms/utils/logging_rtt.h
+1 -1
View File
@@ -124,7 +124,7 @@ void utilsLogRttInit(void);
void utilsLogRttDeinit(void);
/**
* This function outputs logs to SEGGER RTT.
* Outputs logs to SEGGER RTT.
*
* @param[in] aLogLevel The log level.
* @param[in] aLogRegion The log region.
examples/platforms/utils/mac_frame.h
+3 -3
View File
@@ -43,7 +43,7 @@ extern "C" {
#endif
/**
* This enumeration specifies the IEEE 802.15.4 Address type.
* Specifies the IEEE 802.15.4 Address type.
*
*/
typedef enum
@@ -54,7 +54,7 @@ typedef enum
} otMacAddressType;
/**
* This structure represents an IEEE 802.15.4 short or extended Address.
* Represents an IEEE 802.15.4 short or extended Address.
*
*/
typedef struct otMacAddress
@@ -176,7 +176,7 @@ otError otMacFrameGetDstAddr(const otRadioFrame *aFrame, otMacAddress *aMacAddre
uint8_t otMacFrameGetSequence(const otRadioFrame *aFrame);
/**
* This function performs AES CCM on the frame which is going to be sent.
* Performs AES CCM on the frame which is going to be sent.
*
* @param[in] aFrame A pointer to the MAC frame buffer that is going to be sent.
* @param[in] aExtAddress A pointer to the extended address, which will be used to generate nonce
include/openthread/backbone_router.h
+2 -2
View File
@@ -52,7 +52,7 @@ extern "C" {
*/
/**
* This structure represents Backbone Router configuration.
* Represents Backbone Router configuration.
*
*/
typedef struct otBackboneRouterConfig
@@ -64,7 +64,7 @@ typedef struct otBackboneRouterConfig
} otBackboneRouterConfig;
/**
* This function gets the Primary Backbone Router information in the Thread Network.
* Gets the Primary Backbone Router information in the Thread Network.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[out] aConfig A pointer to where to put Primary Backbone Router information.
include/openthread/backbone_router_ftd.h
+13 -13
View File
@@ -161,7 +161,7 @@ otError otBackboneRouterSetConfig(otInstance *aInstance, const otBackboneRouterC
otError otBackboneRouterRegister(otInstance *aInstance);
/**
* This method returns the Backbone Router registration jitter value.
* Returns the Backbone Router registration jitter value.
*
* @returns The Backbone Router registration jitter value.
*
@@ -171,7 +171,7 @@ otError otBackboneRouterRegister(otInstance *aInstance);
uint8_t otBackboneRouterGetRegistrationJitter(otInstance *aInstance);
/**
* This method sets the Backbone Router registration jitter value.
* Sets the Backbone Router registration jitter value.
*
* @param[in] aJitter the Backbone Router registration jitter value to set.
*
@@ -181,7 +181,7 @@ uint8_t otBackboneRouterGetRegistrationJitter(otInstance *aInstance);
void otBackboneRouterSetRegistrationJitter(otInstance *aInstance, uint8_t aJitter);
/**
* This method gets the local Domain Prefix configuration.
* Gets the local Domain Prefix configuration.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[out] aConfig A pointer to the Domain Prefix configuration.
@@ -193,7 +193,7 @@ void otBackboneRouterSetRegistrationJitter(otInstance *aInstance, uint8_t aJitte
otError otBackboneRouterGetDomainPrefix(otInstance *aInstance, otBorderRouterConfig *aConfig);
/**
* This method configures response status for next DUA registration.
* Configures response status for next DUA registration.
*
* Note: available only when `OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE` is enabled.
* Only used for test and certification.
@@ -235,7 +235,7 @@ typedef enum
} otBackboneRouterMulticastListenerEvent;
/**
* This function pointer is called whenever the Multicast Listeners change.
* Pointer is called whenever the Multicast Listeners change.
*
* @param[in] aContext The user context pointer.
* @param[in] aEvent The Multicast Listener event.
@@ -247,7 +247,7 @@ typedef void (*otBackboneRouterMulticastListenerCallback)(void
const otIp6Address *aAddress);
/**
* This method sets the Backbone Router Multicast Listener callback.
* Sets the Backbone Router Multicast Listener callback.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aCallback A pointer to the Multicast Listener callback.
@@ -302,7 +302,7 @@ otError otBackboneRouterMulticastListenerAdd(otInstance *aInstance, const otIp6A
typedef uint16_t otBackboneRouterMulticastListenerIterator; ///< Used to iterate through Multicast Listeners.
/**
* This structure represents a Backbone Router Multicast Listener info.
* Represents a Backbone Router Multicast Listener info.
*
*/
typedef struct otBackboneRouterMulticastListenerInfo
@@ -312,7 +312,7 @@ typedef struct otBackboneRouterMulticastListenerInfo
} otBackboneRouterMulticastListenerInfo;
/**
* This function gets the next Multicast Listener info (using an iterator).
* Gets the next Multicast Listener info (using an iterator).
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in,out] aIterator A pointer to the iterator. On success the iterator will be updated to point to next
@@ -346,7 +346,7 @@ typedef enum
} otBackboneRouterNdProxyEvent;
/**
* This function pointer is called whenever the Nd Proxy changed.
* Pointer is called whenever the Nd Proxy changed.
*
* @param[in] aContext The user context pointer.
* @param[in] aEvent The ND Proxy event.
@@ -359,7 +359,7 @@ typedef void (*otBackboneRouterNdProxyCallback)(void *aCo
const otIp6Address *aDua);
/**
* This method sets the Backbone Router ND Proxy callback.
* Sets the Backbone Router ND Proxy callback.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aCallback A pointer to the ND Proxy callback.
@@ -382,7 +382,7 @@ typedef struct otBackboneRouterNdProxyInfo
} otBackboneRouterNdProxyInfo;
/**
* This method gets the Backbone Router ND Proxy info.
* Gets the Backbone Router ND Proxy info.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aDua The Domain Unicast Address.
@@ -408,7 +408,7 @@ typedef enum
} otBackboneRouterDomainPrefixEvent;
/**
* This function pointer is called whenever the Domain Prefix changed.
* Pointer is called whenever the Domain Prefix changed.
*
* @param[in] aContext The user context pointer.
* @param[in] aEvent The Domain Prefix event.
@@ -419,7 +419,7 @@ typedef void (*otBackboneRouterDomainPrefixCallback)(void
otBackboneRouterDomainPrefixEvent aEvent,
const otIp6Prefix *aDomainPrefix);
/**
* This method sets the Backbone Router Domain Prefix callback.
* Sets the Backbone Router Domain Prefix callback.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aCallback A pointer to the Domain Prefix callback.
include/openthread/border_agent.h
+2 -2
View File
@@ -60,7 +60,7 @@ extern "C" {
/**
* @struct otBorderAgentId
*
* This structure represents a Border Agent ID.
* Represents a Border Agent ID.
*
*/
OT_TOOL_PACKED_BEGIN
@@ -70,7 +70,7 @@ struct otBorderAgentId
} OT_TOOL_PACKED_END;
/**
* This enumeration defines the Border Agent state.
* Defines the Border Agent state.
*
*/
typedef enum otBorderAgentState
include/openthread/border_router.h
+3 -3
View File
@@ -54,7 +54,7 @@ extern "C" {
*/
/**
* This method provides a full or stable copy of the local Thread Network Data.
* Provides a full or stable copy of the local Thread Network Data.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aStable TRUE when copying the stable version, FALSE when copying the full version.
@@ -94,7 +94,7 @@ otError otBorderRouterAddOnMeshPrefix(otInstance *aInstance, const otBorderRoute
otError otBorderRouterRemoveOnMeshPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix);
/**
* This function gets the next On Mesh Prefix in the local Network Data.
* Gets the next On Mesh Prefix in the local Network Data.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in,out] aIterator A pointer to the Network Data iterator context. To get the first on-mesh entry
@@ -139,7 +139,7 @@ otError otBorderRouterAddRoute(otInstance *aInstance, const otExternalRouteConfi
otError otBorderRouterRemoveRoute(otInstance *aInstance, const otIp6Prefix *aPrefix);
/**
* This function gets the next external route in the local Network Data.
* Gets the next external route in the local Network Data.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in,out] aIterator A pointer to the Network Data iterator context. To get the first external route entry
include/openthread/border_routing.h
+9 -9
View File
@@ -73,7 +73,7 @@ extern "C" {
*/
/**
* This structure represents an iterator to iterate through the Border Router's discovered prefix table.
* Represents an iterator to iterate through the Border Router's discovered prefix table.
*
* The fields in this type are opaque (intended for use by OpenThread core only) and therefore should not be
* accessed or used by caller.
@@ -89,7 +89,7 @@ typedef struct otBorderRoutingPrefixTableIterator
} otBorderRoutingPrefixTableIterator;
/**
* This structure represents an entry from the discovered prefix table.
* Represents an entry from the discovered prefix table.
*
* The entries in the discovered table track the Prefix/Route Info Options in the received Router Advertisement messages
* from other routers on infrastructure link.
@@ -107,7 +107,7 @@ typedef struct otBorderRoutingPrefixTableEntry
} otBorderRoutingPrefixTableEntry;
/**
* This enumeration represents the state of Border Routing Manager.
* Represents the state of Border Routing Manager.
*
*/
typedef enum
@@ -119,7 +119,7 @@ typedef enum
} otBorderRoutingState;
/**
* This method initializes the Border Routing Manager on given infrastructure interface.
* Initializes the Border Routing Manager on given infrastructure interface.
*
* @note This method MUST be called before any other otBorderRouting* APIs.
*
@@ -163,7 +163,7 @@ otError otBorderRoutingSetEnabled(otInstance *aInstance, bool aEnabled);
otBorderRoutingState otBorderRoutingGetState(otInstance *aInstance);
/**
* This function gets the current preference used when advertising Route Info Options (RIO) in Router Advertisement
* Gets the current preference used when advertising Route Info Options (RIO) in Router Advertisement
* messages sent over the infrastructure link.
*
* The RIO preference is determined as follows:
@@ -179,7 +179,7 @@ otBorderRoutingState otBorderRoutingGetState(otInstance *aInstance);
otRoutePreference otBorderRoutingGetRouteInfoOptionPreference(otInstance *aInstance);
/**
* This function explicitly sets the preference to use when advertising Route Info Options (RIO) in Router
* Explicitly sets the preference to use when advertising Route Info Options (RIO) in Router
* Advertisement messages sent over the infrastructure link.
*
* After a call to this function, BR will use the given preference for all its advertised RIOs. The preference can be
@@ -192,7 +192,7 @@ otRoutePreference otBorderRoutingGetRouteInfoOptionPreference(otInstance *aInsta
void otBorderRoutingSetRouteInfoOptionPreference(otInstance *aInstance, otRoutePreference aPreference);
/**
* This function clears a previously set preference value for advertised Route Info Options.
* Clears a previously set preference value for advertised Route Info Options.
*
* After a call to this function, BR will use device's role to determine the RIO preference: Medium preference when
* in router/leader role and low preference when in child role.
@@ -296,7 +296,7 @@ otError otBorderRoutingGetFavoredNat64Prefix(otInstance *aInstance,
otRoutePreference *aPreference);
/**
* This function initializes an `otBorderRoutingPrefixTableIterator`.
* Initializes an `otBorderRoutingPrefixTableIterator`.
*
* An iterator MUST be initialized before it is used.
*
@@ -312,7 +312,7 @@ otError otBorderRoutingGetFavoredNat64Prefix(otInstance *aInstance,
void otBorderRoutingPrefixTableInitIterator(otInstance *aInstance, otBorderRoutingPrefixTableIterator *aIterator);
/**
* This function iterates over the entries in the Border Router's discovered prefix table.
* Iterates over the entries in the Border Router's discovered prefix table.
*
* @param[in] aInstance The OpenThread instance.
* @param[in,out] aIterator A pointer to the iterator.
include/openthread/channel_manager.h
+5 -5
View File
@@ -69,7 +69,7 @@ extern "C" {
void otChannelManagerRequestChannelChange(otInstance *aInstance, uint8_t aChannel);
/**
* This function gets the channel from the last successful call to `otChannelManagerRequestChannelChange()`
* Gets the channel from the last successful call to `otChannelManagerRequestChannelChange()`
*
* @returns The last requested channel or zero if there has been no channel change request yet.
*
@@ -77,7 +77,7 @@ void otChannelManagerRequestChannelChange(otInstance *aInstance, uint8_t aChanne
uint8_t otChannelManagerGetRequestedChannel(otInstance *aInstance);
/**
* This function gets the delay (in seconds) used by Channel Manager for a channel change.
* Gets the delay (in seconds) used by Channel Manager for a channel change.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -102,7 +102,7 @@ uint16_t otChannelManagerGetDelay(otInstance *aInstance);
otError otChannelManagerSetDelay(otInstance *aInstance, uint16_t aDelay);
/**
* This function requests that `ChannelManager` checks and selects a new channel and starts a channel change.
* Requests that `ChannelManager` checks and selects a new channel and starts a channel change.
*
* Unlike the `otChannelManagerRequestChannelChange()` where the channel must be given as a parameter, this function
* asks the `ChannelManager` to select a channel by itself (based on collected channel quality info).
@@ -144,7 +144,7 @@ otError otChannelManagerRequestChannelSelect(otInstance *aInstance, bool aSkipQu
void otChannelManagerSetAutoChannelSelectionEnabled(otInstance *aInstance, bool aEnabled);
/**
* This function indicates whether the auto-channel-selection functionality is enabled or not.
* Indicates whether the auto-channel-selection functionality is enabled or not.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -166,7 +166,7 @@ bool otChannelManagerGetAutoChannelSelectionEnabled(otInstance *aInstance);
otError otChannelManagerSetAutoChannelSelectionInterval(otInstance *aInstance, uint32_t aInterval);
/**
* This function gets the period interval (in seconds) used by auto-channel-selection functionality.
* Gets the period interval (in seconds) used by auto-channel-selection functionality.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
include/openthread/channel_monitor.h
+1 -1
View File
@@ -82,7 +82,7 @@ extern "C" {
otError otChannelMonitorSetEnabled(otInstance *aInstance, bool aEnabled);
/**
* This function indicates whether the Channel Monitoring operation is enabled and running.
* Indicates whether the Channel Monitoring operation is enabled and running.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
include/openthread/cli.h
+3 -3
View File
@@ -46,7 +46,7 @@ extern "C" {
#endif
/**
* This structure represents a CLI command.
* Represents a CLI command.
*
*/
typedef struct otCliCommand
@@ -68,7 +68,7 @@ typedef struct otCliCommand
*/
/**
* This function pointer is called to notify about Console output.
* Pointer is called to notify about Console output.
*
* @param[out] aContext A user context pointer.
* @param[in] aFormat The format string.
@@ -90,7 +90,7 @@ typedef int (*otCliOutputCallback)(void *aContext, const char *aFormat, va_list
void otCliInit(otInstance *aInstance, otCliOutputCallback aCallback, void *aContext);
/**
* This method is called to feed in a console input line.
* Is called to feed in a console input line.
*
* @param[in] aBuf A pointer to a null-terminated string.
*
include/openthread/coap.h
+61 -61
View File
@@ -151,7 +151,7 @@ typedef enum otCoapOptionType
} otCoapOptionType;
/**
* This structure represents a CoAP option.
* Represents a CoAP option.
*
*/
typedef struct otCoapOption
@@ -161,7 +161,7 @@ typedef struct otCoapOption
} otCoapOption;
/**
* This structure acts as an iterator for CoAP options
* Acts as an iterator for CoAP options
*
*/
typedef struct otCoapOptionIterator
@@ -329,7 +329,7 @@ typedef enum otCoapBlockSzx
} otCoapBlockSzx;
/**
* This function pointer is called when a CoAP response is received or on the request timeout.
* Pointer is called when a CoAP response is received or on the request timeout.
*
* @param[in] aContext A pointer to application-specific context.
* @param[in] aMessage A pointer to the message buffer containing the response. NULL if no response was received.
@@ -347,7 +347,7 @@ typedef void (*otCoapResponseHandler)(void *aContext,
otError aResult);
/**
* This function pointer is called when a CoAP request with a given Uri-Path is received.
* Pointer is called when a CoAP request with a given Uri-Path is received.
*
* @param[in] aContext A pointer to arbitrary context information.
* @param[in] aMessage A pointer to the message.
@@ -357,9 +357,9 @@ typedef void (*otCoapResponseHandler)(void *aContext,
typedef void (*otCoapRequestHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo);
/**
* This function pointer is called when a CoAP message with an block-wise transfer option is received.
* Pointer is called when a CoAP message with an block-wise transfer option is received.
*
* This function is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration
* Is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration
* is enabled.
*
* @param[in] aContext A pointer to application-specific context.
@@ -383,9 +383,9 @@ typedef otError (*otCoapBlockwiseReceiveHook)(void *aContext,
uint32_t aTotalLength);
/**
* This function pointer is called before the next block in a block-wise transfer is sent.
* Pointer is called before the next block in a block-wise transfer is sent.
*
* This function is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration
* Is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration
* is enabled.
*
* @param[in] aContext A pointer to application-specific context.
@@ -409,7 +409,7 @@ typedef otError (*otCoapBlockwiseTransmitHook)(void *aContext,
bool *aMore);
/**
* This structure represents a CoAP resource.
* Represents a CoAP resource.
*
*/
typedef struct otCoapResource
@@ -421,7 +421,7 @@ typedef struct otCoapResource
} otCoapResource;
/**
* This structure represents a CoAP resource with block-wise transfer.
* Represents a CoAP resource with block-wise transfer.
*
*/
typedef struct otCoapBlockwiseResource
@@ -445,7 +445,7 @@ typedef struct otCoapBlockwiseResource
} otCoapBlockwiseResource;
/**
* This structure represents the CoAP transmission parameters.
* Represents the CoAP transmission parameters.
*
* @note mAckTimeout * ((2 ** (mMaxRetransmit + 1)) - 1) * (mAckRandomFactorNumerator / mAckRandomFactorDenominator)
* must not exceed what can be represented by a uint32_t (0xffffffff). This limitation allows OpenThread to
@@ -483,7 +483,7 @@ typedef struct otCoapTxParameters
} otCoapTxParameters;
/**
* This function initializes the CoAP header.
* Initializes the CoAP header.
*
* @param[in,out] aMessage A pointer to the CoAP message to initialize.
* @param[in] aType CoAP message type.
@@ -493,7 +493,7 @@ typedef struct otCoapTxParameters
void otCoapMessageInit(otMessage *aMessage, otCoapType aType, otCoapCode aCode);
/**
* This function initializes a response message.
* Initializes a response message.
*
* @note Both message ID and token are set according to @p aRequest.
*
@@ -509,7 +509,7 @@ void otCoapMessageInit(otMessage *aMessage, otCoapType aType, otCoapCode aCode);
otError otCoapMessageInitResponse(otMessage *aResponse, const otMessage *aRequest, otCoapType aType, otCoapCode aCode);
/**
* This function sets the Token value and length in a header.
* Sets the Token value and length in a header.
*
* @param[in,out] aMessage A pointer to the CoAP message.
* @param[in] aToken A pointer to the Token value.
@@ -522,7 +522,7 @@ otError otCoapMessageInitResponse(otMessage *aResponse, const otMessage *aReques
otError otCoapMessageSetToken(otMessage *aMessage, const uint8_t *aToken, uint8_t aTokenLength);
/**
* This function sets the Token length and randomizes its value.
* Sets the Token length and randomizes its value.
*
* @param[in,out] aMessage A pointer to the CoAP message.
* @param[in] aTokenLength The Length of a Token to set.
@@ -531,7 +531,7 @@ otError otCoapMessageSetToken(otMessage *aMessage, const uint8_t *aToken, uint8_
void otCoapMessageGenerateToken(otMessage *aMessage, uint8_t aTokenLength);
/**
* This function appends the Content Format CoAP option as specified in
* Appends the Content Format CoAP option as specified in
* https://tools.ietf.org/html/rfc7252#page-92. This *must* be called before
* setting otCoapMessageSetPayloadMarker if a payload is to be included in the
* message.
@@ -552,7 +552,7 @@ void otCoapMessageGenerateToken(otMessage *aMessage, uint8_t aTokenLength);
otError otCoapMessageAppendContentFormatOption(otMessage *aMessage, otCoapOptionContentFormat aContentFormat);
/**
* This function appends a CoAP option in a header.
* Appends a CoAP option in a header.
*
* @param[in,out] aMessage A pointer to the CoAP message.
* @param[in] aNumber The CoAP Option number.
@@ -567,7 +567,7 @@ otError otCoapMessageAppendContentFormatOption(otMessage *aMessage, otCoapOption
otError otCoapMessageAppendOption(otMessage *aMessage, uint16_t aNumber, uint16_t aLength, const void *aValue);
/**
* This function appends an unsigned integer CoAP option as specified in
* Appends an unsigned integer CoAP option as specified in
* https://tools.ietf.org/html/rfc7252#section-3.2
*
* @param[in,out] aMessage A pointer to the CoAP message.
@@ -583,7 +583,7 @@ otError otCoapMessageAppendOption(otMessage *aMessage, uint16_t aNumber, uint16_
otError otCoapMessageAppendUintOption(otMessage *aMessage, uint16_t aNumber, uint32_t aValue);
/**
* This function appends an Observe option.
* Appends an Observe option.
*
* @param[in,out] aMessage A pointer to the CoAP message.
* @param[in] aObserve Observe field value.
@@ -596,7 +596,7 @@ otError otCoapMessageAppendUintOption(otMessage *aMessage, uint16_t aNumber, uin
otError otCoapMessageAppendObserveOption(otMessage *aMessage, uint32_t aObserve);
/**
* This function appends a Uri-Path option.
* Appends a Uri-Path option.
*
* @param[in,out] aMessage A pointer to the CoAP message.
* @param[in] aUriPath A pointer to a NULL-terminated string.
@@ -609,7 +609,7 @@ otError otCoapMessageAppendObserveOption(otMessage *aMessage, uint32_t aObserve)
otError otCoapMessageAppendUriPathOptions(otMessage *aMessage, const char *aUriPath);
/**
* This function converts a CoAP Block option SZX field to the actual block size
* Converts a CoAP Block option SZX field to the actual block size
*
* @param[in] aSize Block size exponent.
*
@@ -619,7 +619,7 @@ otError otCoapMessageAppendUriPathOptions(otMessage *aMessage, const char *aUriP
uint16_t otCoapBlockSizeFromExponent(otCoapBlockSzx aSize);
/**
* This function appends a Block2 option
* Appends a Block2 option
*
* @param[in,out] aMessage A pointer to the CoAP message.
* @param[in] aNum Current block number.
@@ -634,7 +634,7 @@ uint16_t otCoapBlockSizeFromExponent(otCoapBlockSzx aSize);
otError otCoapMessageAppendBlock2Option(otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize);
/**
* This function appends a Block1 option
* Appends a Block1 option
*
* @param[in,out] aMessage A pointer to the CoAP message.
* @param[in] aNum Current block number.
@@ -649,7 +649,7 @@ otError otCoapMessageAppendBlock2Option(otMessage *aMessage, uint32_t aNum, bool
otError otCoapMessageAppendBlock1Option(otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize);
/**
* This function appends a Proxy-Uri option.
* Appends a Proxy-Uri option.
*
* @param[in,out] aMessage A pointer to the CoAP message.
* @param[in] aUriPath A pointer to a NULL-terminated string.
@@ -662,7 +662,7 @@ otError otCoapMessageAppendBlock1Option(otMessage *aMessage, uint32_t aNum, bool
otError otCoapMessageAppendProxyUriOption(otMessage *aMessage, const char *aUriPath);
/**
* This function appends a Max-Age option.
* Appends a Max-Age option.
*
* @param[in,out] aMessage A pointer to the CoAP message.
* @param[in] aMaxAge The Max-Age value.
@@ -675,7 +675,7 @@ otError otCoapMessageAppendProxyUriOption(otMessage *aMessage, const char *aUriP
otError otCoapMessageAppendMaxAgeOption(otMessage *aMessage, uint32_t aMaxAge);
/**
* This function appends a single Uri-Query option.
* Appends a single Uri-Query option.
*
* @param[in,out] aMessage A pointer to the CoAP message.
* @param[in] aUriQuery A pointer to NULL-terminated string, which should contain a single key=value pair.
@@ -687,7 +687,7 @@ otError otCoapMessageAppendMaxAgeOption(otMessage *aMessage, uint32_t aMaxAge);
otError otCoapMessageAppendUriQueryOption(otMessage *aMessage, const char *aUriQuery);
/**
* This function adds Payload Marker indicating beginning of the payload to the CoAP header.
* Adds Payload Marker indicating beginning of the payload to the CoAP header.
*
* @param[in,out] aMessage A pointer to the CoAP message.
*
@@ -698,7 +698,7 @@ otError otCoapMessageAppendUriQueryOption(otMessage *aMessage, const char *aUriQ
otError otCoapMessageSetPayloadMarker(otMessage *aMessage);
/**
* This function returns the Type value.
* Returns the Type value.
*
* @param[in] aMessage A pointer to the CoAP message.
*
@@ -708,7 +708,7 @@ otError otCoapMessageSetPayloadMarker(otMessage *aMessage);
otCoapType otCoapMessageGetType(const otMessage *aMessage);
/**
* This function returns the Code value.
* Returns the Code value.
*
* @param[in] aMessage A pointer to the CoAP message.
*
@@ -718,7 +718,7 @@ otCoapType otCoapMessageGetType(const otMessage *aMessage);
otCoapCode otCoapMessageGetCode(const otMessage *aMessage);
/**
* This function sets the Code value.
* Sets the Code value.
*
* @param[in,out] aMessage A pointer to the CoAP message to initialize.
* @param[in] aCode CoAP message code.
@@ -727,7 +727,7 @@ otCoapCode otCoapMessageGetCode(const otMessage *aMessage);
void otCoapMessageSetCode(otMessage *aMessage, otCoapCode aCode);
/**
* This method returns the CoAP Code as human readable string.
* Returns the CoAP Code as human readable string.
*
* @param[in] aMessage A pointer to the CoAP message.
*
@@ -737,7 +737,7 @@ void otCoapMessageSetCode(otMessage *aMessage, otCoapCode aCode);
const char *otCoapMessageCodeToString(const otMessage *aMessage);
/**
* This function returns the Message ID value.
* Returns the Message ID value.
*
* @param[in] aMessage A pointer to the CoAP message.
*
@@ -747,7 +747,7 @@ const char *otCoapMessageCodeToString(const otMessage *aMessage);
uint16_t otCoapMessageGetMessageId(const otMessage *aMessage);
/**
* This function returns the Token length.
* Returns the Token length.
*
* @param[in] aMessage A pointer to the CoAP message.
*
@@ -757,7 +757,7 @@ uint16_t otCoapMessageGetMessageId(const otMessage *aMessage);
uint8_t otCoapMessageGetTokenLength(const otMessage *aMessage);
/**
* This function returns a pointer to the Token value.
* Returns a pointer to the Token value.
*
* @param[in] aMessage A pointer to the CoAP message.
*
@@ -767,7 +767,7 @@ uint8_t otCoapMessageGetTokenLength(const otMessage *aMessage);
const uint8_t *otCoapMessageGetToken(const otMessage *aMessage);
/**
* This function initialises an iterator for the options in the given message.
* Initialises an iterator for the options in the given message.
*
* @param[in,out] aIterator A pointer to the CoAP message option iterator.
* @param[in] aMessage A pointer to the CoAP message.
@@ -779,7 +779,7 @@ const uint8_t *otCoapMessageGetToken(const otMessage *aMessage);
otError otCoapOptionIteratorInit(otCoapOptionIterator *aIterator, const otMessage *aMessage);
/**
* This function returns a pointer to the first option matching the specified option number.
* Returns a pointer to the first option matching the specified option number.
*
* @param[in] aIterator A pointer to the CoAP message option iterator.
* @param[in] aOption The option number sought.
@@ -790,7 +790,7 @@ otError otCoapOptionIteratorInit(otCoapOptionIterator *aIterator, const otMessag
const otCoapOption *otCoapOptionIteratorGetFirstOptionMatching(otCoapOptionIterator *aIterator, uint16_t aOption);
/**
* This function returns a pointer to the first option.
* Returns a pointer to the first option.
*
* @param[in,out] aIterator A pointer to the CoAP message option iterator.
*
@@ -800,7 +800,7 @@ const otCoapOption *otCoapOptionIteratorGetFirstOptionMatching(otCoapOptionItera
const otCoapOption *otCoapOptionIteratorGetFirstOption(otCoapOptionIterator *aIterator);
/**
* This function returns a pointer to the next option matching the specified option number.
* Returns a pointer to the next option matching the specified option number.
*
* @param[in] aIterator A pointer to the CoAP message option iterator.
* @param[in] aOption The option number sought.
@@ -811,7 +811,7 @@ const otCoapOption *otCoapOptionIteratorGetFirstOption(otCoapOptionIterator *aIt
const otCoapOption *otCoapOptionIteratorGetNextOptionMatching(otCoapOptionIterator *aIterator, uint16_t aOption);
/**
* This function returns a pointer to the next option.
* Returns a pointer to the next option.
*
* @param[in,out] aIterator A pointer to the CoAP message option iterator.
*
@@ -821,7 +821,7 @@ const otCoapOption *otCoapOptionIteratorGetNextOptionMatching(otCoapOptionIterat
const otCoapOption *otCoapOptionIteratorGetNextOption(otCoapOptionIterator *aIterator);
/**
* This function fills current option value into @p aValue assuming the current value is an unsigned integer encoded
* Fills current option value into @p aValue assuming the current value is an unsigned integer encoded
* according to https://tools.ietf.org/html/rfc7252#section-3.2
*
* @param[in,out] aIterator A pointer to the CoAP message option iterator.
@@ -836,7 +836,7 @@ const otCoapOption *otCoapOptionIteratorGetNextOption(otCoapOptionIterator *aIte
otError otCoapOptionIteratorGetOptionUintValue(otCoapOptionIterator *aIterator, uint64_t *aValue);
/**
* This function fills current option value into @p aValue.
* Fills current option value into @p aValue.
*
* @param[in,out] aIterator A pointer to the CoAP message option iterator.
* @param[out] aValue A pointer to a buffer to receive the option value.
@@ -848,7 +848,7 @@ otError otCoapOptionIteratorGetOptionUintValue(otCoapOptionIterator *aIterator,
otError otCoapOptionIteratorGetOptionValue(otCoapOptionIterator *aIterator, void *aValue);
/**
* This function creates a new CoAP message.
* Creates a new CoAP message.
*
* @note If @p aSettings is 'NULL', the link layer security is enabled and the message priority is set to
* OT_MESSAGE_PRIORITY_NORMAL by default.
@@ -862,7 +862,7 @@ otError otCoapOptionIteratorGetOptionValue(otCoapOptionIterator *aIterator, void
otMessage *otCoapNewMessage(otInstance *aInstance, const otMessageSettings *aSettings);
/**
* This function sends a CoAP request with custom transmission parameters.
* Sends a CoAP request with custom transmission parameters.
*
* If a response for a request is expected, respective function and context information should be provided.
* If no response is expected, these arguments should be NULL pointers.
@@ -891,9 +891,9 @@ otError otCoapSendRequestWithParameters(otInstance *aInstance,
const otCoapTxParameters *aTxParameters);
/**
* This function sends a CoAP request block-wise with custom transmission parameters.
* Sends a CoAP request block-wise with custom transmission parameters.
*
* This function is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration
* Is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration
* is enabled.
*
* If a response for a request is expected, respective function and context information should be provided.
@@ -923,9 +923,9 @@ otError otCoapSendRequestBlockWiseWithParameters(otInstance *aIn
otCoapBlockwiseReceiveHook aReceiveHook);
/**
* This function sends a CoAP request block-wise.
* Sends a CoAP request block-wise.
*
* This function is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration
* Is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration
* is enabled.
*
* If a response for a request is expected, respective function and context information should be provided.
@@ -958,7 +958,7 @@ static inline otError otCoapSendRequestBlockWise(otInstance *aIn
}
/**
* This function sends a CoAP request.
* Sends a CoAP request.
*
* If a response for a request is expected, respective function and context information should be provided.
* If no response is expected, these arguments should be NULL pointers.
@@ -984,7 +984,7 @@ static inline otError otCoapSendRequest(otInstance *aInstance,
}
/**
* This function starts the CoAP server.
* Starts the CoAP server.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aPort The local UDP port to bind to.
@@ -996,7 +996,7 @@ static inline otError otCoapSendRequest(otInstance *aInstance,
otError otCoapStart(otInstance *aInstance, uint16_t aPort);
/**
* This function stops the CoAP server.
* Stops the CoAP server.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -1006,7 +1006,7 @@ otError otCoapStart(otInstance *aInstance, uint16_t aPort);
otError otCoapStop(otInstance *aInstance);
/**
* This function adds a resource to the CoAP server.
* Adds a resource to the CoAP server.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aResource A pointer to the resource.
@@ -1015,7 +1015,7 @@ otError otCoapStop(otInstance *aInstance);
void otCoapAddResource(otInstance *aInstance, otCoapResource *aResource);
/**
* This function removes a resource from the CoAP server.
* Removes a resource from the CoAP server.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aResource A pointer to the resource.
@@ -1024,7 +1024,7 @@ void otCoapAddResource(otInstance *aInstance, otCoapResource *aResource);
void otCoapRemoveResource(otInstance *aInstance, otCoapResource *aResource);
/**
* This function adds a block-wise resource to the CoAP server.
* Adds a block-wise resource to the CoAP server.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aResource A pointer to the resource.
@@ -1033,7 +1033,7 @@ void otCoapRemoveResource(otInstance *aInstance, otCoapResource *aResource);
void otCoapAddBlockWiseResource(otInstance *aInstance, otCoapBlockwiseResource *aResource);
/**
* This function removes a block-wise resource from the CoAP server.
* Removes a block-wise resource from the CoAP server.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aResource A pointer to the resource.
@@ -1042,7 +1042,7 @@ void otCoapAddBlockWiseResource(otInstance *aInstance, otCoapBlockwiseResource *
void otCoapRemoveBlockWiseResource(otInstance *aInstance, otCoapBlockwiseResource *aResource);
/**
* This function sets the default handler for unhandled CoAP requests.
* Sets the default handler for unhandled CoAP requests.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aHandler A function pointer that shall be called when an unhandled request arrives.
@@ -1052,7 +1052,7 @@ void otCoapRemoveBlockWiseResource(otInstance *aInstance, otCoapBlockwiseResourc
void otCoapSetDefaultHandler(otInstance *aInstance, otCoapRequestHandler aHandler, void *aContext);
/**
* This function sends a CoAP response from the server with custom transmission parameters.
* Sends a CoAP response from the server with custom transmission parameters.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aMessage A pointer to the CoAP response to send.
@@ -1069,9 +1069,9 @@ otError otCoapSendResponseWithParameters(otInstance *aInstance,
const otCoapTxParameters *aTxParameters);
/**
* This function sends a CoAP response block-wise from the server with custom transmission parameters.
* Sends a CoAP response block-wise from the server with custom transmission parameters.
*
* This function is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration
* Is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration
* is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
@@ -1093,9 +1093,9 @@ otError otCoapSendResponseBlockWiseWithParameters(otInstance *aI
otCoapBlockwiseTransmitHook aTransmitHook);
/**
* This function sends a CoAP response block-wise from the server.
* Sends a CoAP response block-wise from the server.
*
* This function is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration
* Is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration
* is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
@@ -1119,7 +1119,7 @@ static inline otError otCoapSendResponseBlockWise(otInstance *aI
}
/**
* This function sends a CoAP response from the server.
* Sends a CoAP response from the server.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aMessage A pointer to the CoAP response to send.
include/openthread/coap_secure.h
+24 -24
View File
@@ -68,7 +68,7 @@ extern "C" {
#define OT_DEFAULT_COAP_SECURE_PORT 5684 ///< Default CoAP Secure port, as specified in RFC 7252
/**
* This function pointer is called when the DTLS connection state changes.
* Pointer is called when the DTLS connection state changes.
*
* @param[in] aConnected true, if a connection was established, false otherwise.
* @param[in] aContext A pointer to arbitrary context information.
@@ -77,7 +77,7 @@ extern "C" {
typedef void (*otHandleCoapSecureClientConnect)(bool aConnected, void *aContext);
/**
* This function starts the CoAP Secure service.
* Starts the CoAP Secure service.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aPort The local UDP port to bind to.
@@ -88,7 +88,7 @@ typedef void (*otHandleCoapSecureClientConnect)(bool aConnected, void *aContext)
otError otCoapSecureStart(otInstance *aInstance, uint16_t aPort);
/**
* This function stops the CoAP Secure server.
* Stops the CoAP Secure server.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -96,7 +96,7 @@ otError otCoapSecureStart(otInstance *aInstance, uint16_t aPort);
void otCoapSecureStop(otInstance *aInstance);
/**
* This method sets the Pre-Shared Key (PSK) and cipher suite
* Sets the Pre-Shared Key (PSK) and cipher suite
* DTLS_PSK_WITH_AES_128_CCM_8.
*
* @note This function requires the build-time feature `MBEDTLS_KEY_EXCHANGE_PSK_ENABLED` to be enabled.
@@ -115,7 +115,7 @@ void otCoapSecureSetPsk(otInstance *aInstance,
uint16_t aPskIdLength);
/**
* This method returns the peer x509 certificate base64 encoded.
* Returns the peer x509 certificate base64 encoded.
*
* @note This function requires the build-time features `MBEDTLS_BASE64_C` and
* `MBEDTLS_SSL_KEEP_PEER_CERTIFICATE` to be enabled.
@@ -136,7 +136,7 @@ otError otCoapSecureGetPeerCertificateBase64(otInstance *aInstance,
size_t aCertBufferSize);
/**
* This method sets the authentication mode for the coap secure connection.
* Sets the authentication mode for the coap secure connection.
*
* Disable or enable the verification of peer certificate.
* Must be called before start.
@@ -148,7 +148,7 @@ otError otCoapSecureGetPeerCertificateBase64(otInstance *aInstance,
void otCoapSecureSetSslAuthMode(otInstance *aInstance, bool aVerifyPeerCertificate);
/**
* This method sets the local device's X509 certificate with corresponding private key for
* Sets the local device's X509 certificate with corresponding private key for
* DTLS session with DTLS_ECDHE_ECDSA_WITH_AES_128_CCM_8.
*
* @note This function requires `MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED=1`.
@@ -167,7 +167,7 @@ void otCoapSecureSetCertificate(otInstance *aInstance,
uint32_t aPrivateKeyLength);
/**
* This method sets the trusted top level CAs. It is needed for validating the
* Sets the trusted top level CAs. It is needed for validating the
* certificate of the peer.
*
* DTLS mode "ECDHE ECDSA with AES 128 CCM 8" for Application CoAPS.
@@ -184,7 +184,7 @@ void otCoapSecureSetCaCertificateChain(otInstance *aInstance,
uint32_t aX509CaCertChainLength);
/**
* This method initializes DTLS session with a peer.
* Initializes DTLS session with a peer.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aSockAddr A pointer to the remote socket address.
@@ -201,7 +201,7 @@ otError otCoapSecureConnect(otInstance *aInstance,
void *aContext);
/**
* This method stops the DTLS connection.
* Stops the DTLS connection.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -209,7 +209,7 @@ otError otCoapSecureConnect(otInstance *aInstance,
void otCoapSecureDisconnect(otInstance *aInstance);
/**
* This method indicates whether or not the DTLS session is connected.
* Indicates whether or not the DTLS session is connected.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -220,7 +220,7 @@ void otCoapSecureDisconnect(otInstance *aInstance);
bool otCoapSecureIsConnected(otInstance *aInstance);
/**
* This method indicates whether or not the DTLS session is active.
* Indicates whether or not the DTLS session is active.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -231,9 +231,9 @@ bool otCoapSecureIsConnected(otInstance *aInstance);
bool otCoapSecureIsConnectionActive(otInstance *aInstance);
/**
* This method sends a CoAP request block-wise over secure DTLS connection.
* Sends a CoAP request block-wise over secure DTLS connection.
*
* This function is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration
* Is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration
* is enabled.
*
* If a response for a request is expected, respective function and context information should be provided.
@@ -260,7 +260,7 @@ otError otCoapSecureSendRequestBlockWise(otInstance *aInstance,
otCoapBlockwiseReceiveHook aReceiveHook);
/**
* This method sends a CoAP request over secure DTLS connection.
* Sends a CoAP request over secure DTLS connection.
*
* If a response for a request is expected, respective function and context information should be provided.
* If no response is expected, these arguments should be NULL pointers.
@@ -282,7 +282,7 @@ otError otCoapSecureSendRequest(otInstance *aInstance,
void *aContext);
/**
* This function adds a resource to the CoAP Secure server.
* Adds a resource to the CoAP Secure server.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aResource A pointer to the resource.
@@ -291,7 +291,7 @@ otError otCoapSecureSendRequest(otInstance *aInstance,
void otCoapSecureAddResource(otInstance *aInstance, otCoapResource *aResource);
/**
* This function removes a resource from the CoAP Secure server.
* Removes a resource from the CoAP Secure server.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aResource A pointer to the resource.
@@ -300,7 +300,7 @@ void otCoapSecureAddResource(otInstance *aInstance, otCoapResource *aResource);
void otCoapSecureRemoveResource(otInstance *aInstance, otCoapResource *aResource);
/**
* This function adds a block-wise resource to the CoAP Secure server.
* Adds a block-wise resource to the CoAP Secure server.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aResource A pointer to the resource.
@@ -309,7 +309,7 @@ void otCoapSecureRemoveResource(otInstance *aInstance, otCoapResource *aResource
void otCoapSecureAddBlockWiseResource(otInstance *aInstance, otCoapBlockwiseResource *aResource);
/**
* This function removes a block-wise resource from the CoAP Secure server.
* Removes a block-wise resource from the CoAP Secure server.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aResource A pointer to the resource.
@@ -318,7 +318,7 @@ void otCoapSecureAddBlockWiseResource(otInstance *aInstance, otCoapBlockwiseReso
void otCoapSecureRemoveBlockWiseResource(otInstance *aInstance, otCoapBlockwiseResource *aResource);
/**
* This function sets the default handler for unhandled CoAP Secure requests.
* Sets the default handler for unhandled CoAP Secure requests.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aHandler A function pointer that shall be called when an unhandled request arrives.
@@ -328,7 +328,7 @@ void otCoapSecureRemoveBlockWiseResource(otInstance *aInstance, otCoapBlockwiseR
void otCoapSecureSetDefaultHandler(otInstance *aInstance, otCoapRequestHandler aHandler, void *aContext);
/**
* This method sets the connected callback to indicate, when
* Sets the connected callback to indicate, when
* a Client connect to the CoAP Secure server.
*
* @param[in] aInstance A pointer to an OpenThread instance.
@@ -341,9 +341,9 @@ void otCoapSecureSetClientConnectedCallback(otInstance *aIns
void *aContext);
/**
* This function sends a CoAP response block-wise from the CoAP Secure server.
* Sends a CoAP response block-wise from the CoAP Secure server.
*
* This function is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration
* Is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration
* is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
@@ -363,7 +363,7 @@ otError otCoapSecureSendResponseBlockWise(otInstance *aInstance,
otCoapBlockwiseTransmitHook aTransmitHook);
/**
* This function sends a CoAP response from the CoAP Secure server.
* Sends a CoAP response from the CoAP Secure server.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aMessage A pointer to the CoAP response to send.
include/openthread/commissioner.h
+29 -29
View File
@@ -56,7 +56,7 @@ extern "C" {
*/
/**
* This enumeration defines the Commissioner State.
* Defines the Commissioner State.
*
*/
typedef enum otCommissionerState
@@ -67,7 +67,7 @@ typedef enum otCommissionerState
} otCommissionerState;
/**
* This enumeration defines a Joiner Event on the Commissioner.
* Defines a Joiner Event on the Commissioner.
*
*/
typedef enum otCommissionerJoinerEvent
@@ -87,7 +87,7 @@ typedef enum otCommissionerJoinerEvent
#define OT_STEERING_DATA_MAX_LENGTH 16 ///< Max steering data length (bytes)
/**
* This structure represents the steering data.
* Represents the steering data.
*
*/
typedef struct otSteeringData
@@ -97,7 +97,7 @@ typedef struct otSteeringData
} otSteeringData;
/**
* This structure represents a Commissioning Dataset.
* Represents a Commissioning Dataset.
*
*/
typedef struct otCommissioningDataset
@@ -116,7 +116,7 @@ typedef struct otCommissioningDataset
#define OT_JOINER_MAX_PSKD_LENGTH 32 ///< Maximum string length of a Joiner PSKd (does not include null char).
/**
* This structure represents a Joiner PSKd.
* Represents a Joiner PSKd.
*
*/
typedef struct otJoinerPskd
@@ -125,7 +125,7 @@ typedef struct otJoinerPskd
} otJoinerPskd;
/**
* This enumeration defines a Joiner Info Type.
* Defines a Joiner Info Type.
*
*/
typedef enum otJoinerInfoType
@@ -136,7 +136,7 @@ typedef enum otJoinerInfoType
} otJoinerInfoType;
/**
* This structure represents a Joiner Info.
* Represents a Joiner Info.
*
*/
typedef struct otJoinerInfo
@@ -152,7 +152,7 @@ typedef struct otJoinerInfo
} otJoinerInfo;
/**
* This function pointer is called whenever the commissioner state changes.
* Pointer is called whenever the commissioner state changes.
*
* @param[in] aState The Commissioner state.
* @param[in] aContext A pointer to application-specific context.
@@ -161,7 +161,7 @@ typedef struct otJoinerInfo
typedef void (*otCommissionerStateCallback)(otCommissionerState aState, void *aContext);
/**
* This function pointer is called whenever the joiner state changes.
* Pointer is called whenever the joiner state changes.
*
* @param[in] aEvent The joiner event type.
* @param[in] aJoinerInfo A pointer to the Joiner Info.
@@ -175,7 +175,7 @@ typedef void (*otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent,
void *aContext);
/**
* This function enables the Thread Commissioner role.
* Enables the Thread Commissioner role.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aStateCallback A pointer to a function that is called when the commissioner state changes.
@@ -193,7 +193,7 @@ otError otCommissionerStart(otInstance *aInstance,
void *aCallbackContext);
/**
* This function disables the Thread Commissioner role.
* Disables the Thread Commissioner role.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -204,7 +204,7 @@ otError otCommissionerStart(otInstance *aInstance,
otError otCommissionerStop(otInstance *aInstance);
/**
* This function returns the Commissioner Id.
* Returns the Commissioner Id.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -214,7 +214,7 @@ otError otCommissionerStop(otInstance *aInstance);
const char *otCommissionerGetId(otInstance *aInstance);
/**
* This function sets the Commissioner Id.
* Sets the Commissioner Id.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aId A pointer to a string character array. Must be null terminated.
@@ -227,7 +227,7 @@ const char *otCommissionerGetId(otInstance *aInstance);
otError otCommissionerSetId(otInstance *aInstance, const char *aId);
/**
* This function adds a Joiner entry.
* Adds a Joiner entry.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aEui64 A pointer to the Joiner's IEEE EUI-64 or NULL for any Joiner.
@@ -248,7 +248,7 @@ otError otCommissionerAddJoiner(otInstance *aInstance,
uint32_t aTimeout);
/**
* This function adds a Joiner entry with a given Joiner Discerner value.
* Adds a Joiner entry with a given Joiner Discerner value.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aDiscerner A pointer to the Joiner Discerner.
@@ -269,7 +269,7 @@ otError otCommissionerAddJoinerWithDiscerner(otInstance *aInstance,
uint32_t aTimeout);
/**
* This method get joiner info at aIterator position.
* Get joiner info at aIterator position.
*
* @param[in] aInstance A pointer to instance.
* @param[in,out] aIterator A pointer to the Joiner Info iterator context.
@@ -282,7 +282,7 @@ otError otCommissionerAddJoinerWithDiscerner(otInstance *aInstance,
otError otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner);
/**
* This function removes a Joiner entry.
* Removes a Joiner entry.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aEui64 A pointer to the Joiner's IEEE EUI-64 or NULL for any Joiner.
@@ -298,7 +298,7 @@ otError otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterat
otError otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aEui64);
/**
* This function removes a Joiner entry.
* Removes a Joiner entry.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aDiscerner A pointer to the Joiner Discerner.
@@ -314,7 +314,7 @@ otError otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aE
otError otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner);
/**
* This function gets the Provisioning URL.
* Gets the Provisioning URL.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -324,7 +324,7 @@ otError otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJ
const char *otCommissionerGetProvisioningUrl(otInstance *aInstance);
/**
* This function sets the Provisioning URL.
* Sets the Provisioning URL.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aProvisioningUrl A pointer to the Provisioning URL (may be NULL to set as empty string).
@@ -336,7 +336,7 @@ const char *otCommissionerGetProvisioningUrl(otInstance *aInstance);
otError otCommissionerSetProvisioningUrl(otInstance *aInstance, const char *aProvisioningUrl);
/**
* This function sends an Announce Begin message.
* Sends an Announce Begin message.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aChannelMask The channel mask value.
@@ -358,7 +358,7 @@ otError otCommissionerAnnounceBegin(otInstance *aInstance,
const otIp6Address *aAddress);
/**
* This function pointer is called when the Commissioner receives an Energy Report.
* Pointer is called when the Commissioner receives an Energy Report.
*
* @param[in] aChannelMask The channel mask value.
* @param[in] aEnergyList A pointer to the energy measurement list.
@@ -372,7 +372,7 @@ typedef void (*otCommissionerEnergyReportCallback)(uint32_t aChannelMask,
void *aContext);
/**
* This function sends an Energy Scan Query message.
* Sends an Energy Scan Query message.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aChannelMask The channel mask value.
@@ -400,7 +400,7 @@ otError otCommissionerEnergyScan(otInstance *aInstance,
void *aContext);
/**
* This function pointer is called when the Commissioner receives a PAN ID Conflict message.
* Pointer is called when the Commissioner receives a PAN ID Conflict message.
*
* @param[in] aPanId The PAN ID value.
* @param[in] aChannelMask The channel mask value.
@@ -410,7 +410,7 @@ otError otCommissionerEnergyScan(otInstance *aInstance,
typedef void (*otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext);
/**
* This function sends a PAN ID Query message.
* Sends a PAN ID Query message.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aPanId The PAN ID to query.
@@ -434,7 +434,7 @@ otError otCommissionerPanIdQuery(otInstance *aInstance,
void *aContext);
/**
* This function sends MGMT_COMMISSIONER_GET.
* Sends MGMT_COMMISSIONER_GET.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aTlvs A pointer to TLVs.
@@ -448,7 +448,7 @@ otError otCommissionerPanIdQuery(otInstance *aInstance,
otError otCommissionerSendMgmtGet(otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength);
/**
* This function sends MGMT_COMMISSIONER_SET.
* Sends MGMT_COMMISSIONER_SET.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aDataset A pointer to commissioning dataset.
@@ -466,7 +466,7 @@ otError otCommissionerSendMgmtSet(otInstance *aInstance,
uint8_t aLength);
/**
* This function returns the Commissioner Session ID.
* Returns the Commissioner Session ID.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -476,7 +476,7 @@ otError otCommissionerSendMgmtSet(otInstance *aInstance,
uint16_t otCommissionerGetSessionId(otInstance *aInstance);
/**
* This function returns the Commissioner State.
* Returns the Commissioner State.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
include/openthread/crypto.h
+3 -3
View File
@@ -58,13 +58,13 @@ extern "C" {
/**
* @struct otCryptoSha256Hash
*
* This structure represents a SHA-256 hash.
* Represents a SHA-256 hash.
*
*/
typedef otPlatCryptoSha256Hash otCryptoSha256Hash;
/**
* This function performs HMAC computation.
* Performs HMAC computation.
*
* @param[in] aKey A pointer to the key.
* @param[in] aBuf A pointer to the input buffer.
@@ -75,7 +75,7 @@ typedef otPlatCryptoSha256Hash otCryptoSha256Hash;
void otCryptoHmacSha256(const otCryptoKey *aKey, const uint8_t *aBuf, uint16_t aBufLength, otCryptoSha256Hash *aHash);
/**
* This method performs AES CCM computation.
* Performs AES CCM computation.
*
* @param[in] aKey A pointer to the key.
* @param[in] aTagLength Length of tag in bytes.
include/openthread/dataset.h
+23 -23
View File
@@ -58,7 +58,7 @@ extern "C" {
/**
* @struct otNetworkKey
*
* This structure represents a Thread Network Key.
* Represents a Thread Network Key.
*
*/
OT_TOOL_PACKED_BEGIN
@@ -68,7 +68,7 @@ struct otNetworkKey
} OT_TOOL_PACKED_END;
/**
* This structure represents a Thread Network Key.
* Represents a Thread Network Key.
*
*/
typedef struct otNetworkKey otNetworkKey;
@@ -82,7 +82,7 @@ typedef otCryptoKeyRef otNetworkKeyRef; ///< Reference to Key
#define OT_NETWORK_NAME_MAX_SIZE 16 ///< Maximum size of the Thread Network Name field (bytes)
/**
* This structure represents a Network Name.
* Represents a Network Name.
*
* The `otNetworkName` is a null terminated C string (i.e., `m8` char array MUST end with null char `\0`).
*
@@ -95,7 +95,7 @@ typedef struct otNetworkName
#define OT_EXT_PAN_ID_SIZE 8 ///< Size of a Thread PAN ID (bytes)
/**
* This structure represents an Extended PAN ID.
* Represents an Extended PAN ID.
*
*/
OT_TOOL_PACKED_BEGIN
@@ -105,7 +105,7 @@ struct otExtendedPanId
} OT_TOOL_PACKED_END;
/**
* This structure represents an Extended PAN ID.
* Represents an Extended PAN ID.
*
*/
typedef struct otExtendedPanId otExtendedPanId;
@@ -113,7 +113,7 @@ typedef struct otExtendedPanId otExtendedPanId;
#define OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE ///< Size of the Mesh Local Prefix (bytes)
/**
* This structure represents a Mesh Local Prefix.
* Represents a Mesh Local Prefix.
*
*/
typedef otIp6NetworkPrefix otMeshLocalPrefix;
@@ -121,7 +121,7 @@ typedef otIp6NetworkPrefix otMeshLocalPrefix;
#define OT_PSKC_MAX_SIZE 16 ///< Maximum size of the PSKc (bytes)
/**
* This structure represents PSKc.
* Represents PSKc.
*
*/
OT_TOOL_PACKED_BEGIN
@@ -131,7 +131,7 @@ struct otPskc
} OT_TOOL_PACKED_END;
/**
* This structure represents a PSKc.
* Represents a PSKc.
*
*/
typedef struct otPskc otPskc;
@@ -143,7 +143,7 @@ typedef struct otPskc otPskc;
typedef otCryptoKeyRef otPskcRef; ///< Reference to Key
/**
* This structure represent Security Policy.
* Represent Security Policy.
*
*/
typedef struct otSecurityPolicy
@@ -163,7 +163,7 @@ typedef struct otSecurityPolicy
} otSecurityPolicy;
/**
* This type represents Channel Mask.
* Represents Channel Mask.
*
*/
typedef uint32_t otChannelMask;
@@ -196,7 +196,7 @@ typedef uint32_t otChannelMask;
#define OT_CHANNEL_26_MASK (1 << 26) ///< Channel 26
/**
* This structure represents presence of different components in Active or Pending Operational Dataset.
* Represents presence of different components in Active or Pending Operational Dataset.
*
*/
typedef struct otOperationalDatasetComponents
@@ -216,7 +216,7 @@ typedef struct otOperationalDatasetComponents
} otOperationalDatasetComponents;
/**
* This structure represents a Thread Dataset timestamp component.
* Represents a Thread Dataset timestamp component.
*
*/
typedef struct otTimestamp
@@ -227,7 +227,7 @@ typedef struct otTimestamp
} otTimestamp;
/**
* This structure represents an Active or Pending Operational Dataset.
* Represents an Active or Pending Operational Dataset.
*
* Components in Dataset are optional. `mComponents` structure specifies which components are present in the Dataset.
*
@@ -256,7 +256,7 @@ typedef struct otOperationalDataset
#define OT_OPERATIONAL_DATASET_MAX_LENGTH 254
/**
* This structure represents an Active or Pending Operational Dataset.
* Represents an Active or Pending Operational Dataset.
*
* The Operational Dataset is TLV encoded as specified by Thread.
*
@@ -268,7 +268,7 @@ typedef struct otOperationalDatasetTlvs
} otOperationalDatasetTlvs;
/**
* This enumeration represents meshcop TLV types.
* Represents meshcop TLV types.
*
*/
typedef enum otMeshcopTlvType
@@ -316,7 +316,7 @@ typedef enum otMeshcopTlvType
} otMeshcopTlvType;
/**
* This function pointer is called when a response to a MGMT_SET request is received or times out.
* Pointer is called when a response to a MGMT_SET request is received or times out.
*
* @param[in] aResult A result of the operation.
* @param[in] aContext A pointer to application-specific context.
@@ -331,7 +331,7 @@ typedef enum otMeshcopTlvType
typedef void (*otDatasetMgmtSetCallback)(otError aResult, void *aContext);
/**
* This function indicates whether a valid network is present in the Active Operational Dataset or not.
* Indicates whether a valid network is present in the Active Operational Dataset or not.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -353,7 +353,7 @@ bool otDatasetIsCommissioned(otInstance *aInstance);
otError otDatasetGetActive(otInstance *aInstance, otOperationalDataset *aDataset);
/**
* This function gets the Active Operational Dataset.
* Gets the Active Operational Dataset.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[out] aDataset A pointer to where the Active Operational Dataset will be placed.
@@ -391,7 +391,7 @@ otError otDatasetGetActiveTlvs(otInstance *aInstance, otOperationalDatasetTlvs *
otError otDatasetSetActive(otInstance *aInstance, const otOperationalDataset *aDataset);
/**
* This function sets the Active Operational Dataset.
* Sets the Active Operational Dataset.
*
* If the dataset does not include an Active Timestamp, the dataset is only partially complete.
*
@@ -417,7 +417,7 @@ otError otDatasetSetActive(otInstance *aInstance, const otOperationalDataset *aD
otError otDatasetSetActiveTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset);
/**
* This function gets the Pending Operational Dataset.
* Gets the Pending Operational Dataset.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[out] aDataset A pointer to where the Pending Operational Dataset will be placed.
@@ -429,7 +429,7 @@ otError otDatasetSetActiveTlvs(otInstance *aInstance, const otOperationalDataset
otError otDatasetGetPending(otInstance *aInstance, otOperationalDataset *aDataset);
/**
* This function gets the Pending Operational Dataset.
* Gets the Pending Operational Dataset.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[out] aDataset A pointer to where the Pending Operational Dataset will be placed.
@@ -454,7 +454,7 @@ otError otDatasetGetPendingTlvs(otInstance *aInstance, otOperationalDatasetTlvs
otError otDatasetSetPending(otInstance *aInstance, const otOperationalDataset *aDataset);
/**
* This function sets the Pending Operational Dataset.
* Sets the Pending Operational Dataset.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aDataset A pointer to the Pending Operational Dataset.
@@ -549,7 +549,7 @@ otError otDatasetSendMgmtPendingSet(otInstance *aInstance,
void *aContext);
/**
* This function generates PSKc from a given pass-phrase, network name, and extended PAN ID.
* Generates PSKc from a given pass-phrase, network name, and extended PAN ID.
*
* PSKc is used to establish the Commissioner Session.
*
include/openthread/dataset_updater.h
+3 -3
View File
@@ -69,7 +69,7 @@ extern "C" {
typedef void (*otDatasetUpdaterCallback)(otError aError, void *aContext);
/**
* This function requests an update to Operational Dataset.
* Requests an update to Operational Dataset.
*
* Available when `OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE` is enabled.
*
@@ -94,7 +94,7 @@ otError otDatasetUpdaterRequestUpdate(otInstance *aInstance,
void *aContext);
/**
* This function cancels an ongoing (if any) Operational Dataset update request.
* Cancels an ongoing (if any) Operational Dataset update request.
*
* Available when `OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE` is enabled.
*
@@ -104,7 +104,7 @@ otError otDatasetUpdaterRequestUpdate(otInstance *aInstance,
void otDatasetUpdaterCancelUpdate(otInstance *aInstance);
/**
* This function indicates whether there is an ongoing Operation Dataset update request.
* Indicates whether there is an ongoing Operation Dataset update request.
*
* Available when `OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE` is enabled.
*
include/openthread/diag.h
+3 -3
View File
@@ -52,7 +52,7 @@ extern "C" {
*/
/**
* This function processes a factory diagnostics command line.
* Processes a factory diagnostics command line.
*
* The output of this function (the content written to @p aOutput) MUST terminate with `\0` and the `\0` is within the
* output buffer.
@@ -75,7 +75,7 @@ otError otDiagProcessCmd(otInstance *aInstance,
size_t aOutputMaxLen);
/**
* This function processes a factory diagnostics command line.
* Processes a factory diagnostics command line.
*
* The output of this function (the content written to @p aOutput) MUST terminate with `\0` and the `\0` is within the
* output buffer.
@@ -94,7 +94,7 @@ otError otDiagProcessCmd(otInstance *aInstance,
otError otDiagProcessCmdLine(otInstance *aInstance, const char *aString, char *aOutput, size_t aOutputMaxLen);
/**
* This function indicates whether or not the factory diagnostics mode is enabled.
* Indicates whether or not the factory diagnostics mode is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
include/openthread/dns.h
+6 -6
View File
@@ -63,7 +63,7 @@ extern "C" {
#define OT_DNS_TXT_KEY_MAX_LENGTH 9 ///< Recommended maximum length of TXT record key string (RFC 6763 - section 6.4).
/**
* This structure represents a TXT record entry representing a key/value pair (RFC 6763 - section 6.3).
* Represents a TXT record entry representing a key/value pair (RFC 6763 - section 6.3).
*
* The string buffers pointed to by `mKey` and `mValue` MUST persist and remain unchanged after an instance of such
* structure is passed to OpenThread (as part of `otSrpClientService` instance).
@@ -95,7 +95,7 @@ typedef struct otDnsTxtEntry
} otDnsTxtEntry;
/**
* This structure represents an iterator for TXT record entries (key/value pairs).
* Represents an iterator for TXT record entries (key/value pairs).
*
* The data fields in this structure are intended for use by OpenThread core and caller should not read or change them.
*
@@ -108,7 +108,7 @@ typedef struct otDnsTxtEntryIterator
} otDnsTxtEntryIterator;
/**
* This function initializes a TXT record iterator.
* Initializes a TXT record iterator.
*
* The buffer pointer @p aTxtData and its content MUST persist and remain unchanged while @p aIterator object
* is being used.
@@ -121,7 +121,7 @@ typedef struct otDnsTxtEntryIterator
void otDnsInitTxtEntryIterator(otDnsTxtEntryIterator *aIterator, const uint8_t *aTxtData, uint16_t aTxtDataLength);
/**
* This function parses the TXT data from an iterator and gets the next TXT record entry (key/value pair).
* Parses the TXT data from an iterator and gets the next TXT record entry (key/value pair).
*
* The @p aIterator MUST be initialized using `otDnsInitTxtEntryIterator()` before calling this function and the TXT
* data buffer used to initialize the iterator MUST persist and remain unchanged. Otherwise the behavior of this
@@ -142,7 +142,7 @@ void otDnsInitTxtEntryIterator(otDnsTxtEntryIterator *aIterator, const uint8_t *
otError otDnsGetNextTxtEntry(otDnsTxtEntryIterator *aIterator, otDnsTxtEntry *aEntry);
/**
* This function enables/disables the "DNS name compression" mode.
* Enables/disables the "DNS name compression" mode.
*
* By default DNS name compression is enabled. When disabled, DNS names are appended as full and never compressed. This
* is applicable to OpenThread's DNS and SRP client/server modules.
@@ -158,7 +158,7 @@ otError otDnsGetNextTxtEntry(otDnsTxtEntryIterator *aIterator, otDnsTxtEntry *aE
void otDnsSetNameCompressionEnabled(bool aEnabled);
/**
* This function indicates whether the "DNS name compression" mode is enabled or not.
* Indicates whether the "DNS name compression" mode is enabled or not.
*
* This is intended for testing only and available when `OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE` config is enabled.
*
include/openthread/dns_client.h
+42 -42
View File
@@ -56,7 +56,7 @@ extern "C" {
*/
/**
* This enumeration type represents the "Recursion Desired" (RD) flag in an `otDnsQueryConfig`.
* Type represents the "Recursion Desired" (RD) flag in an `otDnsQueryConfig`.
*
*/
typedef enum
@@ -67,7 +67,7 @@ typedef enum
} otDnsRecursionFlag;
/**
* This enumeration type represents the NAT64 mode in an `otDnsQueryConfig`.
* Type represents the NAT64 mode in an `otDnsQueryConfig`.
*
* The NAT64 mode indicates whether to allow or disallow NAT64 address translation during DNS client address resolution.
* This mode is only used when `OPENTHREAD_CONFIG_DNS_CLIENT_NAT64_ENABLE` is enabled.
@@ -81,7 +81,7 @@ typedef enum
} otDnsNat64Mode;
/**
* This enumeration type represents the service resolution mode in an `otDnsQueryConfig`.
* Type represents the service resolution mode in an `otDnsQueryConfig`.
*
* This is only used during DNS client service resolution `otDnsClientResolveService()`. It determines which
* record types to query.
@@ -98,7 +98,7 @@ typedef enum
} otDnsServiceMode;
/**
* This enumeration type represents the DNS transport protocol in an `otDnsQueryConfig`.
* Type represents the DNS transport protocol in an `otDnsQueryConfig`.
*
* This `OT_DNS_TRANSPORT_TCP` is only supported when `OPENTHREAD_CONFIG_DNS_CLIENT_OVER_TCP_ENABLE` is enabled.
*
@@ -111,7 +111,7 @@ typedef enum
} otDnsTransportProto;
/**
* This structure represents a DNS query configuration.
* Represents a DNS query configuration.
*
* Any of the fields in this structure can be set to zero to indicate that it is not specified. How the unspecified
* fields are treated is determined by the function which uses the instance of `otDnsQueryConfig`.
@@ -129,7 +129,7 @@ typedef struct otDnsQueryConfig
} otDnsQueryConfig;
/**
* This function gets the current default query config used by DNS client.
* Gets the current default query config used by DNS client.
*
* When OpenThread stack starts, the default DNS query config is determined from a set of OT config options such as
* `OPENTHREAD_CONFIG_DNS_CLIENT_DEFAULT_SERVER_IP6_ADDRESS`, `_DEFAULT_SERVER_PORT`, `_DEFAULT_RESPONSE_TIMEOUT`, etc.
@@ -143,7 +143,7 @@ typedef struct otDnsQueryConfig
const otDnsQueryConfig *otDnsClientGetDefaultConfig(otInstance *aInstance);
/**
* This function sets the default query config on DNS client.
* Sets the default query config on DNS client.
*
* @note Any ongoing query will continue to use the config from when it was started. The new default config will be
* used for any future DNS queries.
@@ -169,7 +169,7 @@ const otDnsQueryConfig *otDnsClientGetDefaultConfig(otInstance *aInstance);
void otDnsClientSetDefaultConfig(otInstance *aInstance, const otDnsQueryConfig *aConfig);
/**
* This type is an opaque representation of a response to an address resolution DNS query.
* An opaque representation of a response to an address resolution DNS query.
*
* Pointers to instance of this type are provided from callback `otDnsAddressCallback`.
*
@@ -177,7 +177,7 @@ void otDnsClientSetDefaultConfig(otInstance *aInstance, const otDnsQueryConfig *
typedef struct otDnsAddressResponse otDnsAddressResponse;
/**
* This function pointer is called when a DNS response is received for an address resolution query.
* Pointer is called when a DNS response is received for an address resolution query.
*
* Within this callback the user can use `otDnsAddressResponseGet{Item}()` functions along with the @p aResponse
* pointer to get more info about the response.
@@ -217,7 +217,7 @@ typedef struct otDnsAddressResponse otDnsAddressResponse;
typedef void (*otDnsAddressCallback)(otError aError, const otDnsAddressResponse *aResponse, void *aContext);
/**
* This function sends an address resolution DNS query for AAAA (IPv6) record(s) for a given host name.
* Sends an address resolution DNS query for AAAA (IPv6) record(s) for a given host name.
*
* The @p aConfig can be NULL. In this case the default config (from `otDnsClientGetDefaultConfig()`) will be used as
* the config for this query. In a non-NULL @p aConfig, some of the fields can be left unspecified (value zero). The
@@ -242,9 +242,9 @@ otError otDnsClientResolveAddress(otInstance *aInstance,
const otDnsQueryConfig *aConfig);
/**
* This function sends an address resolution DNS query for A (IPv4) record(s) for a given host name.
* Sends an address resolution DNS query for A (IPv4) record(s) for a given host name.
*
* This function requires and is available when `OPENTHREAD_CONFIG_DNS_CLIENT_NAT64_ENABLE` is enabled.
* Requires and is available when `OPENTHREAD_CONFIG_DNS_CLIENT_NAT64_ENABLE` is enabled.
*
* When a successful response is received, the addresses are returned from @p aCallback as NAT64 IPv6 translated
* versions of the IPv4 addresses from the query response.
@@ -272,9 +272,9 @@ otError otDnsClientResolveIp4Address(otInstance *aInstance,
const otDnsQueryConfig *aConfig);
/**
* This function gets the full host name associated with an address resolution DNS response.
* Gets the full host name associated with an address resolution DNS response.
*
* This function MUST only be used from `otDnsAddressCallback`.
* MUST only be used from `otDnsAddressCallback`.
*
* @param[in] aResponse A pointer to the response.
* @param[out] aNameBuffer A buffer to char array to output the full host name (MUST NOT be NULL).
@@ -289,9 +289,9 @@ otError otDnsAddressResponseGetHostName(const otDnsAddressResponse *aResponse,
uint16_t aNameBufferSize);
/**
* This function gets an IPv6 address associated with an address resolution DNS response.
* Gets an IPv6 address associated with an address resolution DNS response.
*
* This function MUST only be used from `otDnsAddressCallback`.
* MUST only be used from `otDnsAddressCallback`.
*
* The response may include multiple IPv6 address records. @p aIndex can be used to iterate through the list of
* addresses. Index zero gets the first address and so on. When we reach end of the list, `OT_ERROR_NOT_FOUND` is
@@ -315,7 +315,7 @@ otError otDnsAddressResponseGetAddress(const otDnsAddressResponse *aResponse,
uint32_t *aTtl);
/**
* This type is an opaque representation of a response to a browse (service instance enumeration) DNS query.
* An opaque representation of a response to a browse (service instance enumeration) DNS query.
*
* Pointers to instance of this type are provided from callback `otDnsBrowseCallback`.
*
@@ -323,7 +323,7 @@ otError otDnsAddressResponseGetAddress(const otDnsAddressResponse *aResponse,
typedef struct otDnsBrowseResponse otDnsBrowseResponse;
/**
* This function pointer is called when a DNS response is received for a browse (service instance enumeration) query.
* Pointer is called when a DNS response is received for a browse (service instance enumeration) query.
*
* Within this callback the user can use `otDnsBrowseResponseGet{Item}()` functions along with the @p aResponse
* pointer to get more info about the response.
@@ -341,7 +341,7 @@ typedef struct otDnsBrowseResponse otDnsBrowseResponse;
typedef void (*otDnsBrowseCallback)(otError aError, const otDnsBrowseResponse *aResponse, void *aContext);
/**
* This structure provides info for a DNS service instance.
* Provides info for a DNS service instance.
*
*/
typedef struct otDnsServiceInfo
@@ -361,9 +361,9 @@ typedef struct otDnsServiceInfo
} otDnsServiceInfo;
/**
* This function sends a DNS browse (service instance enumeration) query for a given service name.
* Sends a DNS browse (service instance enumeration) query for a given service name.
*
* This function is available when `OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE` is enabled.
* Is available when `OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE` is enabled.
*
* The @p aConfig can be NULL. In this case the default config (from `otDnsClientGetDefaultConfig()`) will be used as
* the config for this query. In a non-NULL @p aConfig, some of the fields can be left unspecified (value zero). The
@@ -386,9 +386,9 @@ otError otDnsClientBrowse(otInstance *aInstance,
const otDnsQueryConfig *aConfig);
/**
* This function gets the service name associated with a DNS browse (service instance enumeration) response.
* Gets the service name associated with a DNS browse (service instance enumeration) response.
*
* This function MUST only be used from `otDnsBrowseCallback`.
* MUST only be used from `otDnsBrowseCallback`.
*
* @param[in] aResponse A pointer to the response.
* @param[out] aNameBuffer A buffer to char array to output the service name (MUST NOT be NULL).
@@ -403,9 +403,9 @@ otError otDnsBrowseResponseGetServiceName(const otDnsBrowseResponse *aResponse,
uint16_t aNameBufferSize);
/**
* This function gets a service instance associated with a DNS browse (service instance enumeration) response.
* Gets a service instance associated with a DNS browse (service instance enumeration) response.
*
* This function MUST only be used from `otDnsBrowseCallback`.
* MUST only be used from `otDnsBrowseCallback`.
*
* The response may include multiple service instance records. @p aIndex can be used to iterate through the list. Index
* zero gives the the first record. When we reach end of the list, `OT_ERROR_NOT_FOUND` is returned.
@@ -430,9 +430,9 @@ otError otDnsBrowseResponseGetServiceInstance(const otDnsBrowseResponse *aRespon
uint8_t aLabelBufferSize);
/**
* This function gets info for a service instance from a DNS browse (service instance enumeration) response.
* Gets info for a service instance from a DNS browse (service instance enumeration) response.
*
* This function MUST only be used from `otDnsBrowseCallback`.
* MUST only be used from `otDnsBrowseCallback`.
*
* A browse DNS response can include SRV, TXT, and AAAA records for the service instances that are enumerated. This is
* a SHOULD and not a MUST requirement, and servers/resolvers are not required to provide this. This function attempts
@@ -462,9 +462,9 @@ otError otDnsBrowseResponseGetServiceInfo(const otDnsBrowseResponse *aResponse,
otDnsServiceInfo *aServiceInfo);
/**
* This function gets the host IPv6 address from a DNS browse (service instance enumeration) response.
* Gets the host IPv6 address from a DNS browse (service instance enumeration) response.
*
* This function MUST only be used from `otDnsBrowseCallback`.
* MUST only be used from `otDnsBrowseCallback`.
*
* The response can include zero or more IPv6 address records. @p aIndex can be used to iterate through the list of
* addresses. Index zero gets the first address and so on. When we reach end of the list, `OT_ERROR_NOT_FOUND` is
@@ -489,7 +489,7 @@ otError otDnsBrowseResponseGetHostAddress(const otDnsBrowseResponse *aResponse,
uint32_t *aTtl);
/**
* This type is an opaque representation of a response to a service instance resolution DNS query.
* An opaque representation of a response to a service instance resolution DNS query.
*
* Pointers to instance of this type are provided from callback `otDnsAddressCallback`.
*
@@ -497,7 +497,7 @@ otError otDnsBrowseResponseGetHostAddress(const otDnsBrowseResponse *aResponse,
typedef struct otDnsServiceResponse otDnsServiceResponse;
/**
* This function pointer is called when a DNS response is received for a service instance resolution query.
* Pointer is called when a DNS response is received for a service instance resolution query.
*
* Within this callback the user can use `otDnsServiceResponseGet{Item}()` functions along with the @p aResponse
* pointer to get more info about the response.
@@ -515,9 +515,9 @@ typedef struct otDnsServiceResponse otDnsServiceResponse;
typedef void (*otDnsServiceCallback)(otError aError, const otDnsServiceResponse *aResponse, void *aContext);
/**
* This function starts a DNS service instance resolution for a given service instance.
* Starts a DNS service instance resolution for a given service instance.
*
* This function is available when `OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE` is enabled.
* Is available when `OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE` is enabled.
*
* The @p aConfig can be NULL. In this case the default config (from `otDnsClientGetDefaultConfig()`) will be used as
* the config for this query. In a non-NULL @p aConfig, some of the fields can be left unspecified (value zero). The
@@ -555,10 +555,10 @@ otError otDnsClientResolveService(otInstance *aInstance,
const otDnsQueryConfig *aConfig);
/**
* This function starts a DNS service instance resolution for a given service instance, with a potential follow-up
* Starts a DNS service instance resolution for a given service instance, with a potential follow-up
* address resolution for the host name discovered for the service instance.
*
* This function is available when `OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE` is enabled.
* Is available when `OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE` is enabled.
*
* The @p aConfig can be NULL. In this case the default config (from `otDnsClientGetDefaultConfig()`) will be used as
* the config for this query. In a non-NULL @p aConfig, some of the fields can be left unspecified (value zero). The
@@ -566,7 +566,7 @@ otError otDnsClientResolveService(otInstance *aInstance,
* `mServiceMode` in DNS config set to `OT_DNS_SERVICE_MODE_TXT` (i.e., querying for TXT record only) and will return
* `OT_ERROR_INVALID_ARGS`.
*
* This function behaves similarly to `otDnsClientResolveService()` sending queries for SRV and TXT records. However,
* Behaves similarly to `otDnsClientResolveService()` sending queries for SRV and TXT records. However,
* if the server/resolver does not provide AAAA/A records for the host name in the response to SRV query (in the
* Additional Data section), it will perform host name resolution (sending an AAAA query) for the discovered host name
* from the SRV record. The callback @p aCallback is invoked when responses for all queries are received (i.e., both
@@ -592,9 +592,9 @@ otError otDnsClientResolveServiceAndHostAddress(otInstance *aInstanc
const otDnsQueryConfig *aConfig);
/**
* This function gets the service instance name associated with a DNS service instance resolution response.
* Gets the service instance name associated with a DNS service instance resolution response.
*
* This function MUST only be used from `otDnsServiceCallback`.
* MUST only be used from `otDnsServiceCallback`.
*
* @param[in] aResponse A pointer to the response.
* @param[out] aLabelBuffer A buffer to char array to output the service instance label (MUST NOT be NULL).
@@ -614,9 +614,9 @@ otError otDnsServiceResponseGetServiceName(const otDnsServiceResponse *aResponse
uint16_t aNameBufferSize);
/**
* This function gets info for a service instance from a DNS service instance resolution response.
* Gets info for a service instance from a DNS service instance resolution response.
*
* This function MUST only be used from a `otDnsServiceCallback` triggered from `otDnsClientResolveService()` or
* MUST only be used from a `otDnsServiceCallback` triggered from `otDnsClientResolveService()` or
* `otDnsClientResolveServiceAndHostAddress()`.
*
* When this is is used from a `otDnsClientResolveService()` callback, the DNS response from server/resolver may
@@ -649,9 +649,9 @@ otError otDnsServiceResponseGetServiceName(const otDnsServiceResponse *aResponse
otError otDnsServiceResponseGetServiceInfo(const otDnsServiceResponse *aResponse, otDnsServiceInfo *aServiceInfo);
/**
* This function gets the host IPv6 address from a DNS service instance resolution response.
* Gets the host IPv6 address from a DNS service instance resolution response.
*
* This function MUST only be used from `otDnsServiceCallback`.
* MUST only be used from `otDnsServiceCallback`.
*
* The response can include zero or more IPv6 address records. @p aIndex can be used to iterate through the list of
* addresses. Index zero gets the first address and so on. When we reach end of the list, `OT_ERROR_NOT_FOUND` is
include/openthread/dnssd_server.h
+12 -12
View File
@@ -56,7 +56,7 @@ extern "C" {
*/
/**
* This function is called when a DNS-SD query subscribes one of:
* Is called when a DNS-SD query subscribes one of:
* 1. a service name.
* 2. a service instance name.
* 3. a host name.
@@ -83,7 +83,7 @@ extern "C" {
typedef void (*otDnssdQuerySubscribeCallback)(void *aContext, const char *aFullName);
/**
* This function is called when a DNS-SD query unsubscribes one of:
* Is called when a DNS-SD query unsubscribes one of:
* 1. a service name.
* 2. a service instance name.
* 3. a host name.
@@ -107,7 +107,7 @@ typedef void (*otDnssdQueryUnsubscribeCallback)(void *aContext, const char *aFul
typedef void otDnssdQuery;
/**
* This structure represents information of a discovered service instance for a DNS-SD query.
* Represents information of a discovered service instance for a DNS-SD query.
*
*/
typedef struct otDnssdServiceInstanceInfo
@@ -125,7 +125,7 @@ typedef struct otDnssdServiceInstanceInfo
} otDnssdServiceInstanceInfo;
/**
* This structure represents information of a discovered host for a DNS-SD query.
* Represents information of a discovered host for a DNS-SD query.
*
*/
typedef struct otDnssdHostInfo
@@ -136,7 +136,7 @@ typedef struct otDnssdHostInfo
} otDnssdHostInfo;
/**
* This enumeration specifies a DNS-SD query type.
* Specifies a DNS-SD query type.
*
*/
typedef enum
@@ -148,7 +148,7 @@ typedef enum
} otDnssdQueryType;
/**
* This structure contains the counters of DNS-SD server.
* Contains the counters of DNS-SD server.
*
*/
typedef struct otDnssdCounters
@@ -164,7 +164,7 @@ typedef struct otDnssdCounters
} otDnssdCounters;
/**
* This function sets DNS-SD server query callbacks.
* Sets DNS-SD server query callbacks.
*
* The DNS-SD server calls @p aSubscribe to subscribe to a service or service instance to resolve a DNS-SD query and @p
* aUnsubscribe to unsubscribe when the query is resolved or timeout.
@@ -183,7 +183,7 @@ void otDnssdQuerySetCallbacks(otInstance *aInstance,
void *aContext);
/**
* This function notifies a discovered service instance.
* Notifies a discovered service instance.
*
* The external query resolver (e.g. Discovery Proxy) should call this function to notify OpenThread core of the
* subscribed services or service instances.
@@ -199,7 +199,7 @@ void otDnssdQueryHandleDiscoveredServiceInstance(otInstance *aIn
const char *aServiceFullName,
otDnssdServiceInstanceInfo *aInstanceInfo);
/**
* This function notifies a discovered host.
* Notifies a discovered host.
*
* The external query resolver (e.g. Discovery Proxy) should call this function to notify OpenThread core of the
* subscribed hosts.
@@ -214,7 +214,7 @@ void otDnssdQueryHandleDiscoveredServiceInstance(otInstance *aIn
void otDnssdQueryHandleDiscoveredHost(otInstance *aInstance, const char *aHostFullName, otDnssdHostInfo *aHostInfo);
/**
* This function acquires the next query in the DNS-SD server.
* Acquires the next query in the DNS-SD server.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aQuery The query pointer. Pass NULL to get the first query.
@@ -225,7 +225,7 @@ void otDnssdQueryHandleDiscoveredHost(otInstance *aInstance, const char *aHostFu
const otDnssdQuery *otDnssdGetNextQuery(otInstance *aInstance, const otDnssdQuery *aQuery);
/**
* This function acquires the DNS-SD query type and name for a specific query.
* Acquires the DNS-SD query type and name for a specific query.
*
* @param[in] aQuery The query pointer acquired from `otDnssdGetNextQuery`.
* @param[out] aNameOutput The name output buffer, which should be `OT_DNS_MAX_NAME_SIZE` bytes long.
@@ -236,7 +236,7 @@ const otDnssdQuery *otDnssdGetNextQuery(otInstance *aInstance, const otDnssdQuer
otDnssdQueryType otDnssdGetQueryTypeAndName(const otDnssdQuery *aQuery, char (*aNameOutput)[OT_DNS_MAX_NAME_SIZE]);
/**
* This function returns the counters of the DNS-SD server.
* Returns the counters of the DNS-SD server.
*
* @param[in] aInstance The OpenThread instance structure.
*
include/openthread/error.h
+2 -2
View File
@@ -52,7 +52,7 @@ extern "C" {
*/
/**
* This enumeration represents error codes used throughout OpenThread.
* Represents error codes used throughout OpenThread.
*
*/
typedef enum OT_MUST_USE_RESULT otError
@@ -251,7 +251,7 @@ typedef enum OT_MUST_USE_RESULT otError
} otError;
/**
* This function converts an otError enum into a string.
* Converts an otError enum into a string.
*
* @param[in] aError An otError enum.
*
include/openthread/history_tracker.h
+24 -24
View File
@@ -60,7 +60,7 @@ extern "C" {
#define OT_HISTORY_TRACKER_ENTRY_AGE_STRING_SIZE 21 ///< Recommended size for string representation of an entry age.
/**
* This type represents an iterator to iterate through a history list.
* Represents an iterator to iterate through a history list.
*
* The fields in this type are opaque (intended for use by OpenThread core) and therefore should not be accessed/used
* by caller.
@@ -75,7 +75,7 @@ typedef struct otHistoryTrackerIterator
} otHistoryTrackerIterator;
/**
* This structure represents Thread network info.
* Represents Thread network info.
*
*/
typedef struct otHistoryTrackerNetworkInfo
@@ -87,7 +87,7 @@ typedef struct otHistoryTrackerNetworkInfo
} otHistoryTrackerNetworkInfo;
/**
* This enumeration defines the events for an IPv6 (unicast or multicast) address info (i.e., whether address is added
* Defines the events for an IPv6 (unicast or multicast) address info (i.e., whether address is added
* or removed).
*
*/
@@ -98,7 +98,7 @@ typedef enum
} otHistoryTrackerAddressEvent;
/**
* This structure represent a unicast IPv6 address info.
* Represent a unicast IPv6 address info.
*
*/
typedef struct otHistoryTrackerUnicastAddressInfo
@@ -114,7 +114,7 @@ typedef struct otHistoryTrackerUnicastAddressInfo
} otHistoryTrackerUnicastAddressInfo;
/**
* This structure represent an IPv6 multicast address info.
* Represent an IPv6 multicast address info.
*
*/
typedef struct otHistoryTrackerMulticastAddressInfo
@@ -137,7 +137,7 @@ enum
};
/**
* This structure represents a RX/TX IPv6 message info.
* Represents a RX/TX IPv6 message info.
*
* Some of the fields in this struct are applicable to a RX message or a TX message only, e.g., `mAveRxRss` is the
* average RSS of all fragment frames that form a received message and is only applicable for a RX message.
@@ -161,7 +161,7 @@ typedef struct otHistoryTrackerMessageInfo
} otHistoryTrackerMessageInfo;
/**
* This enumeration defines the events in a neighbor info (i.e. whether neighbor is added, removed, or changed).
* Defines the events in a neighbor info (i.e. whether neighbor is added, removed, or changed).
*
* Event `OT_HISTORY_TRACKER_NEIGHBOR_EVENT_RESTORING` is applicable to child neighbors only. It is triggered after
* the device (re)starts and when the previous children list is retrieved from non-volatile settings and the device
@@ -177,7 +177,7 @@ typedef enum
} otHistoryTrackerNeighborEvent;
/**
* This structure represents a neighbor info.
* Represents a neighbor info.
*
*/
typedef struct otHistoryTrackerNeighborInfo
@@ -193,7 +193,7 @@ typedef struct otHistoryTrackerNeighborInfo
} otHistoryTrackerNeighborInfo;
/**
* This enumeration defines the events in a router info (i.e. whether router is added, removed, or changed).
* Defines the events in a router info (i.e. whether router is added, removed, or changed).
*
*/
typedef enum
@@ -209,7 +209,7 @@ typedef enum
#define OT_HISTORY_TRACKER_INFINITE_PATH_COST 0 ///< Infinite path cost - used in `otHistoryTrackerRouterInfo`.
/**
* This structure represents a router table entry event.
* Represents a router table entry event.
*
*/
typedef struct otHistoryTrackerRouterInfo
@@ -222,7 +222,7 @@ typedef struct otHistoryTrackerRouterInfo
} otHistoryTrackerRouterInfo;
/**
* This enumeration defines the events for a Network Data entry (i.e., whether an entry is added or removed).
* Defines the events for a Network Data entry (i.e., whether an entry is added or removed).
*
*/
typedef enum
@@ -232,7 +232,7 @@ typedef enum
} otHistoryTrackerNetDataEvent;
/**
* This structure represent a Network Data on mesh prefix info.
* Represent a Network Data on mesh prefix info.
*
*/
typedef struct otHistoryTrackerOnMeshPrefixInfo
@@ -242,7 +242,7 @@ typedef struct otHistoryTrackerOnMeshPrefixInfo
} otHistoryTrackerOnMeshPrefixInfo;
/**
* This structure represent a Network Data extern route info.
* Represent a Network Data extern route info.
*
*/
typedef struct otHistoryTrackerExternalRouteInfo
@@ -252,7 +252,7 @@ typedef struct otHistoryTrackerExternalRouteInfo
} otHistoryTrackerExternalRouteInfo;
/**
* This function initializes an `otHistoryTrackerIterator`.
* Initializes an `otHistoryTrackerIterator`.
*
* An iterator MUST be initialized before it is used.
*
@@ -268,7 +268,7 @@ typedef struct otHistoryTrackerExternalRouteInfo
void otHistoryTrackerInitIterator(otHistoryTrackerIterator *aIterator);
/**
* This function iterates over the entries in the network info history list.
* Iterates over the entries in the network info history list.
*
* @param[in] aInstance A pointer to the OpenThread instance.
* @param[in,out] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined.
@@ -285,7 +285,7 @@ const otHistoryTrackerNetworkInfo *otHistoryTrackerIterateNetInfoHistory(otInsta
uint32_t *aEntryAge);
/**
* This function iterates over the entries in the unicast address history list.
* Iterates over the entries in the unicast address history list.
*
* @param[in] aInstance A pointer to the OpenThread instance.
* @param[in,out] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined.
@@ -303,7 +303,7 @@ const otHistoryTrackerUnicastAddressInfo *otHistoryTrackerIterateUnicastAddressH
uint32_t *aEntryAge);
/**
* This function iterates over the entries in the multicast address history list.
* Iterates over the entries in the multicast address history list.
*
* @param[in] aInstance A pointer to the OpenThread instance.
* @param[in,out] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined.
@@ -321,7 +321,7 @@ const otHistoryTrackerMulticastAddressInfo *otHistoryTrackerIterateMulticastAddr
uint32_t *aEntryAge);
/**
* This function iterates over the entries in the RX message history list.
* Iterates over the entries in the RX message history list.
*
* @param[in] aInstance A pointer to the OpenThread instance.
* @param[in,out] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined.
@@ -338,7 +338,7 @@ const otHistoryTrackerMessageInfo *otHistoryTrackerIterateRxHistory(otInstance
uint32_t *aEntryAge);
/**
* This function iterates over the entries in the TX message history list.
* Iterates over the entries in the TX message history list.
*
* @param[in] aInstance A pointer to the OpenThread instance.
* @param[in,out] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined.
@@ -355,7 +355,7 @@ const otHistoryTrackerMessageInfo *otHistoryTrackerIterateTxHistory(otInstance
uint32_t *aEntryAge);
/**
* This function iterates over the entries in the neighbor history list.
* Iterates over the entries in the neighbor history list.
*
* @param[in] aInstance A pointer to the OpenThread instance.
* @param[in,out] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined.
@@ -372,7 +372,7 @@ const otHistoryTrackerNeighborInfo *otHistoryTrackerIterateNeighborHistory(otIns
uint32_t *aEntryAge);
/**
* This function iterates over the entries in the router history list.
* Iterates over the entries in the router history list.
*
* @param[in] aInstance A pointer to the OpenThread instance.
* @param[in,out] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined.
@@ -389,7 +389,7 @@ const otHistoryTrackerRouterInfo *otHistoryTrackerIterateRouterHistory(otInstanc
uint32_t *aEntryAge);
/**
* This function iterates over the entries in the Network Data on mesh prefix entry history list.
* Iterates over the entries in the Network Data on mesh prefix entry history list.
*
* @param[in] aInstance A pointer to the OpenThread instance.
* @param[in,out] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined.
@@ -406,7 +406,7 @@ const otHistoryTrackerOnMeshPrefixInfo *otHistoryTrackerIterateOnMeshPrefixHisto
uint32_t *aEntryAge);
/**
* This function iterates over the entries in the Network Data external route entry history list.
* Iterates over the entries in the Network Data external route entry history list.
*
* @param[in] aInstance A pointer to the OpenThread instance.
* @param[in,out] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined.
@@ -424,7 +424,7 @@ const otHistoryTrackerExternalRouteInfo *otHistoryTrackerIterateExternalRouteHis
uint32_t *aEntryAge);
/**
* This function converts a given entry age to a human-readable string.
* Converts a given entry age to a human-readable string.
*
* The entry age string follows the format "<hh>:<mm>:<ss>.<mmmm>" for hours, minutes, seconds and millisecond (if
* shorter than one day) or "<dd> days <hh>:<mm>:<ss>.<mmmm>" (if longer than one day).
include/openthread/icmp6.h
+7 -7
View File
@@ -85,7 +85,7 @@ typedef enum otIcmp6Code
/**
* @struct otIcmp6Header
*
* This structure represents an ICMPv6 header.
* Represents an ICMPv6 header.
*
*/
OT_TOOL_PACKED_BEGIN
@@ -103,7 +103,7 @@ struct otIcmp6Header
} OT_TOOL_PACKED_END;
/**
* This type represents an ICMPv6 header.
* Represents an ICMPv6 header.
*
*/
typedef struct otIcmp6Header otIcmp6Header;
@@ -123,7 +123,7 @@ typedef void (*otIcmp6ReceiveCallback)(void *aContext,
const otIcmp6Header *aIcmpHeader);
/**
* This structure implements ICMPv6 message handler.
* Implements ICMPv6 message handler.
*
*/
typedef struct otIcmp6Handler
@@ -146,7 +146,7 @@ typedef enum otIcmp6EchoMode
} otIcmp6EchoMode;
/**
* This function indicates whether or not ICMPv6 Echo processing is enabled.
* Indicates whether or not ICMPv6 Echo processing is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -159,7 +159,7 @@ typedef enum otIcmp6EchoMode
otIcmp6EchoMode otIcmp6GetEchoMode(otInstance *aInstance);
/**
* This function sets whether or not ICMPv6 Echo processing is enabled.
* Sets whether or not ICMPv6 Echo processing is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aMode The ICMPv6 Echo processing mode.
@@ -168,7 +168,7 @@ otIcmp6EchoMode otIcmp6GetEchoMode(otInstance *aInstance);
void otIcmp6SetEchoMode(otInstance *aInstance, otIcmp6EchoMode aMode);
/**
* This function registers a handler to provide received ICMPv6 messages.
* Registers a handler to provide received ICMPv6 messages.
*
* @note A handler structure @p aHandler has to be stored in persistent (static) memory.
* OpenThread does not make a copy of handler structure.
@@ -181,7 +181,7 @@ void otIcmp6SetEchoMode(otInstance *aInstance, otIcmp6EchoMode aMode);
otError otIcmp6RegisterHandler(otInstance *aInstance, otIcmp6Handler *aHandler);
/**
* This function sends an ICMPv6 Echo Request via the Thread interface.
* Sends an ICMPv6 Echo Request via the Thread interface.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aMessage A pointer to the message buffer containing the ICMPv6 payload.
include/openthread/instance.h
+24 -24
View File
@@ -53,7 +53,7 @@ extern "C" {
* @note This number versions both OpenThread platform and user APIs.
*
*/
#define OPENTHREAD_API_VERSION (327)
#define OPENTHREAD_API_VERSION (328)
/**
* @addtogroup api-instance
@@ -66,17 +66,17 @@ extern "C" {
*/
/**
* This structure represents the OpenThread instance structure.
* Represents the OpenThread instance structure.
*/
typedef struct otInstance otInstance;
/**
* This function initializes the OpenThread library.
* Initializes the OpenThread library.
*
* This function initializes OpenThread and prepares it for subsequent OpenThread API calls. This function must be
* Initializes OpenThread and prepares it for subsequent OpenThread API calls. This function must be
* called before any other calls to OpenThread.
*
* This function is available and can only be used when support for multiple OpenThread instances is enabled.
* Is available and can only be used when support for multiple OpenThread instances is enabled.
*
* @param[in] aInstanceBuffer The buffer for OpenThread to use for allocating the otInstance structure.
* @param[in,out] aInstanceBufferSize On input, the size of aInstanceBuffer. On output, if not enough space for
@@ -90,12 +90,12 @@ typedef struct otInstance otInstance;
otInstance *otInstanceInit(void *aInstanceBuffer, size_t *aInstanceBufferSize);
/**
* This function initializes the static single instance of the OpenThread library.
* Initializes the static single instance of the OpenThread library.
*
* This function initializes OpenThread and prepares it for subsequent OpenThread API calls. This function must be
* Initializes OpenThread and prepares it for subsequent OpenThread API calls. This function must be
* called before any other calls to OpenThread.
*
* This function is available and can only be used when support for multiple OpenThread instances is disabled.
* Is available and can only be used when support for multiple OpenThread instances is disabled.
*
* @returns A pointer to the single OpenThread instance.
*
@@ -114,7 +114,7 @@ otInstance *otInstanceInitSingle(void);
uint32_t otInstanceGetId(otInstance *aInstance);
/**
* This function indicates whether or not the instance is valid/initialized.
* Indicates whether or not the instance is valid/initialized.
*
* The instance is considered valid if it is acquired and initialized using either `otInstanceInitSingle()` (in single
* instance case) or `otInstanceInit()` (in multi instance case). A subsequent call to `otInstanceFinalize()` causes
@@ -128,7 +128,7 @@ uint32_t otInstanceGetId(otInstance *aInstance);
bool otInstanceIsInitialized(otInstance *aInstance);
/**
* This function disables the OpenThread library.
* Disables the OpenThread library.
*
* Call this function when OpenThread is no longer in use.
*
@@ -138,9 +138,9 @@ bool otInstanceIsInitialized(otInstance *aInstance);
void otInstanceFinalize(otInstance *aInstance);
/**
* This function returns the current instance uptime (in msec).
* Returns the current instance uptime (in msec).
*
* This function requires `OPENTHREAD_CONFIG_UPTIME_ENABLE` to be enabled.
* Requires `OPENTHREAD_CONFIG_UPTIME_ENABLE` to be enabled.
*
* The uptime is given as number of milliseconds since OpenThread instance was initialized.
*
@@ -154,9 +154,9 @@ uint64_t otInstanceGetUptime(otInstance *aInstance);
#define OT_UPTIME_STRING_SIZE 24 ///< Recommended size for string representation of uptime.
/**
* This function returns the current instance uptime as a human-readable string.
* Returns the current instance uptime as a human-readable string.
*
* This function requires `OPENTHREAD_CONFIG_UPTIME_ENABLE` to be enabled.
* Requires `OPENTHREAD_CONFIG_UPTIME_ENABLE` to be enabled.
*
* The string follows the format "<hh>:<mm>:<ss>.<mmmm>" for hours, minutes, seconds and millisecond (if uptime is
* shorter than one day) or "<dd>d.<hh>:<mm>:<ss>.<mmmm>" (if longer than a day).
@@ -172,7 +172,7 @@ uint64_t otInstanceGetUptime(otInstance *aInstance);
void otInstanceGetUptimeAsString(otInstance *aInstance, char *aBuffer, uint16_t aSize);
/**
* This enumeration defines flags that are passed as part of `otStateChangedCallback`.
* Defines flags that are passed as part of `otStateChangedCallback`.
*
*/
enum
@@ -211,14 +211,14 @@ enum
};
/**
* This type represents a bit-field indicating specific state/configuration that has changed. See `OT_CHANGED_*`
* Represents a bit-field indicating specific state/configuration that has changed. See `OT_CHANGED_*`
* definitions.
*
*/
typedef uint32_t otChangedFlags;
/**
* This function pointer is called to notify certain configuration or state changes within OpenThread.
* Pointer is called to notify certain configuration or state changes within OpenThread.
*
* @param[in] aFlags A bit-field indicating specific state that has changed. See `OT_CHANGED_*` definitions.
* @param[in] aContext A pointer to application-specific context.
@@ -227,7 +227,7 @@ typedef uint32_t otChangedFlags;
typedef void (*otStateChangedCallback)(otChangedFlags aFlags, void *aContext);
/**
* This function registers a callback to indicate when certain configuration or state changes within OpenThread.
* Registers a callback to indicate when certain configuration or state changes within OpenThread.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aCallback A pointer to a function that is called with certain configuration or state changes.
@@ -241,7 +241,7 @@ typedef void (*otStateChangedCallback)(otChangedFlags aFlags, void *aContext);
otError otSetStateChangedCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext);
/**
* This function removes a callback to indicate when certain configuration or state changes within OpenThread.
* Removes a callback to indicate when certain configuration or state changes within OpenThread.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aCallback A pointer to a function that is called with certain configuration or state changes.
@@ -251,7 +251,7 @@ otError otSetStateChangedCallback(otInstance *aInstance, otStateChangedCallback
void otRemoveStateChangeCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext);
/**
* This method triggers a platform reset.
* Triggers a platform reset.
*
* The reset process ensures that all the OpenThread state/info (stored in volatile memory) is erased. Note that the
* `otPlatformReset` does not erase any persistent state/info saved in non-volatile memory.
@@ -270,7 +270,7 @@ void otInstanceReset(otInstance *aInstance);
void otInstanceFactoryReset(otInstance *aInstance);
/**
* This method resets the internal states of the OpenThread radio stack.
* Resets the internal states of the OpenThread radio stack.
*
* Callbacks and configurations are preserved.
*
@@ -282,7 +282,7 @@ void otInstanceFactoryReset(otInstance *aInstance);
void otInstanceResetRadioStack(otInstance *aInstance);
/**
* This function erases all the OpenThread persistent info (network settings) stored on non-volatile memory.
* Erases all the OpenThread persistent info (network settings) stored on non-volatile memory.
* Erase is successful only if the device is in `disabled` state/role.
*
* @param[in] aInstance A pointer to an OpenThread instance.
@@ -294,7 +294,7 @@ void otInstanceResetRadioStack(otInstance *aInstance);
otError otInstanceErasePersistentInfo(otInstance *aInstance);
/**
* This function gets the OpenThread version string.
* Gets the OpenThread version string.
*
* @returns A pointer to the OpenThread version.
*
@@ -302,7 +302,7 @@ otError otInstanceErasePersistentInfo(otInstance *aInstance);
const char *otGetVersionString(void);
/**
* This function gets the OpenThread radio version string.
* Gets the OpenThread radio version string.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
include/openthread/ip6.h
+49 -49
View File
@@ -60,7 +60,7 @@ extern "C" {
/**
* @struct otIp6InterfaceIdentifier
*
* This structure represents the Interface Identifier of an IPv6 address.
* Represents the Interface Identifier of an IPv6 address.
*
*/
OT_TOOL_PACKED_BEGIN
@@ -75,7 +75,7 @@ struct otIp6InterfaceIdentifier
} OT_TOOL_PACKED_END;
/**
* This structure represents the Interface Identifier of an IPv6 address.
* Represents the Interface Identifier of an IPv6 address.
*
*/
typedef struct otIp6InterfaceIdentifier otIp6InterfaceIdentifier;
@@ -83,7 +83,7 @@ typedef struct otIp6InterfaceIdentifier otIp6InterfaceIdentifier;
/**
* @struct otIp6NetworkPrefix
*
* This structure represents the Network Prefix of an IPv6 address (most significant 64 bits of the address).
* Represents the Network Prefix of an IPv6 address (most significant 64 bits of the address).
*
*/
OT_TOOL_PACKED_BEGIN
@@ -93,7 +93,7 @@ struct otIp6NetworkPrefix
} OT_TOOL_PACKED_END;
/**
* This structure represents the Network Prefix of an IPv6 address (most significant 64 bits of the address).
* Represents the Network Prefix of an IPv6 address (most significant 64 bits of the address).
*
*/
typedef struct otIp6NetworkPrefix otIp6NetworkPrefix;
@@ -101,7 +101,7 @@ typedef struct otIp6NetworkPrefix otIp6NetworkPrefix;
/**
* @struct otIp6AddressComponents
*
* This structure represents the components of an IPv6 address.
* Represents the components of an IPv6 address.
*
*/
OT_TOOL_PACKED_BEGIN
@@ -112,7 +112,7 @@ struct otIp6AddressComponents
} OT_TOOL_PACKED_END;
/**
* This structure represents the components of an IPv6 address.
* Represents the components of an IPv6 address.
*
*/
typedef struct otIp6AddressComponents otIp6AddressComponents;
@@ -120,7 +120,7 @@ typedef struct otIp6AddressComponents otIp6AddressComponents;
/**
* @struct otIp6Address
*
* This structure represents an IPv6 address.
* Represents an IPv6 address.
*
*/
OT_TOOL_PACKED_BEGIN
@@ -136,13 +136,13 @@ struct otIp6Address
} OT_TOOL_PACKED_END;
/**
* This structure represents an IPv6 address.
* Represents an IPv6 address.
*
*/
typedef struct otIp6Address otIp6Address;
/**
* This structure represents an IPv6 prefix.
* Represents an IPv6 prefix.
*
*/
OT_TOOL_PACKED_BEGIN
@@ -153,7 +153,7 @@ struct otIp6Prefix
} OT_TOOL_PACKED_END;
/**
* This structure represents an IPv6 prefix.
* Represents an IPv6 prefix.
*
*/
typedef struct otIp6Prefix otIp6Prefix;
@@ -171,7 +171,7 @@ enum
};
/**
* This structure represents an IPv6 network interface unicast address.
* Represents an IPv6 network interface unicast address.
*
*/
typedef struct otNetifAddress
@@ -188,7 +188,7 @@ typedef struct otNetifAddress
} otNetifAddress;
/**
* This structure represents an IPv6 network interface multicast address.
* Represents an IPv6 network interface multicast address.
*
*/
typedef struct otNetifMulticastAddress
@@ -198,7 +198,7 @@ typedef struct otNetifMulticastAddress
} otNetifMulticastAddress;
/**
* This structure represents an IPv6 socket address.
* Represents an IPv6 socket address.
*
*/
typedef struct otSockAddr
@@ -220,7 +220,7 @@ enum
};
/**
* This structure represents the local and peer IPv6 socket addresses.
* Represents the local and peer IPv6 socket addresses.
*
*/
typedef struct otMessageInfo
@@ -420,7 +420,7 @@ otMessage *otIp6NewMessageFromBuffer(otInstance *aInstance,
const otMessageSettings *aSettings);
/**
* This function pointer is called when an IPv6 datagram is received.
* Pointer is called when an IPv6 datagram is received.
*
* @param[in] aMessage A pointer to the message buffer containing the received IPv6 datagram. This function transfers
* the ownership of the @p aMessage to the receiver of the callback. The message should be
@@ -431,7 +431,7 @@ otMessage *otIp6NewMessageFromBuffer(otInstance *aInstance,
typedef void (*otIp6ReceiveCallback)(otMessage *aMessage, void *aContext);
/**
* This function registers a callback to provide received IPv6 datagrams.
* Registers a callback to provide received IPv6 datagrams.
*
* By default, this callback does not pass Thread control traffic. See otIp6SetReceiveFilterEnabled() to
* change the Thread control traffic filter setting.
@@ -450,7 +450,7 @@ void otIp6SetReceiveCallback(otInstance *aInstance, otIp6ReceiveCallback aCallba
/**
* @struct otIp6AddressInfo
*
* This structure represents IPv6 address information.
* Represents IPv6 address information.
*
*/
typedef struct otIp6AddressInfo
@@ -462,7 +462,7 @@ typedef struct otIp6AddressInfo
} otIp6AddressInfo;
/**
* This function pointer is called when an internal IPv6 address is added or removed.
* Pointer is called when an internal IPv6 address is added or removed.
*
* @param[in] aAddressInfo A pointer to the IPv6 address information.
* @param[in] aIsAdded TRUE if the @p aAddress was added, FALSE if @p aAddress was removed.
@@ -472,7 +472,7 @@ typedef struct otIp6AddressInfo
typedef void (*otIp6AddressCallback)(const otIp6AddressInfo *aAddressInfo, bool aIsAdded, void *aContext);
/**
* This function registers a callback to notify internal IPv6 address changes.
* Registers a callback to notify internal IPv6 address changes.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aCallback A pointer to a function that is called when an internal IPv6 address is added or
@@ -483,7 +483,7 @@ typedef void (*otIp6AddressCallback)(const otIp6AddressInfo *aAddressInfo, bool
void otIp6SetAddressCallback(otInstance *aInstance, otIp6AddressCallback aCallback, void *aCallbackContext);
/**
* This function indicates whether or not Thread control traffic is filtered out when delivering IPv6 datagrams
* Indicates whether or not Thread control traffic is filtered out when delivering IPv6 datagrams
* via the callback specified in otIp6SetReceiveCallback().
*
* @param[in] aInstance A pointer to an OpenThread instance.
@@ -497,7 +497,7 @@ void otIp6SetAddressCallback(otInstance *aInstance, otIp6AddressCallback aCallba
bool otIp6IsReceiveFilterEnabled(otInstance *aInstance);
/**
* This function sets whether or not Thread control traffic is filtered out when delivering IPv6 datagrams
* Sets whether or not Thread control traffic is filtered out when delivering IPv6 datagrams
* via the callback specified in otIp6SetReceiveCallback().
*
* @param[in] aInstance A pointer to an OpenThread instance.
@@ -510,7 +510,7 @@ bool otIp6IsReceiveFilterEnabled(otInstance *aInstance);
void otIp6SetReceiveFilterEnabled(otInstance *aInstance, bool aEnabled);
/**
* This function sends an IPv6 datagram via the Thread interface.
* Sends an IPv6 datagram via the Thread interface.
*
* The caller transfers ownership of @p aMessage when making this call. OpenThread will free @p aMessage when
* processing is complete, including when a value other than `OT_ERROR_NONE` is returned.
@@ -530,7 +530,7 @@ void otIp6SetReceiveFilterEnabled(otInstance *aInstance, bool aEnabled);
otError otIp6Send(otInstance *aInstance, otMessage *aMessage);
/**
* This function adds a port to the allowed unsecured port list.
* Adds a port to the allowed unsecured port list.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aPort The port value.
@@ -543,7 +543,7 @@ otError otIp6Send(otInstance *aInstance, otMessage *aMessage);
otError otIp6AddUnsecurePort(otInstance *aInstance, uint16_t aPort);
/**
* This function removes a port from the allowed unsecure port list.
* Removes a port from the allowed unsecure port list.
*
* @note This function removes @p aPort by overwriting @p aPort with the element after @p aPort in the internal port
* list. Be careful when calling otIp6GetUnsecurePorts() followed by otIp6RemoveUnsecurePort() to remove unsecure
@@ -560,7 +560,7 @@ otError otIp6AddUnsecurePort(otInstance *aInstance, uint16_t aPort);
otError otIp6RemoveUnsecurePort(otInstance *aInstance, uint16_t aPort);
/**
* This function removes all ports from the allowed unsecure port list.
* Removes all ports from the allowed unsecure port list.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -568,7 +568,7 @@ otError otIp6RemoveUnsecurePort(otInstance *aInstance, uint16_t aPort);
void otIp6RemoveAllUnsecurePorts(otInstance *aInstance);
/**
* This function returns a pointer to the unsecure port list.
* Returns a pointer to the unsecure port list.
*
* @note Port value 0 is used to indicate an invalid entry.
*
@@ -605,7 +605,7 @@ bool otIp6IsAddressEqual(const otIp6Address *aFirst, const otIp6Address *aSecond
bool otIp6ArePrefixesEqual(const otIp6Prefix *aFirst, const otIp6Prefix *aSecond);
/**
* This function converts a human-readable IPv6 address string into a binary representation.
* Converts a human-readable IPv6 address string into a binary representation.
*
* @param[in] aString A pointer to a NULL-terminated string.
* @param[out] aAddress A pointer to an IPv6 address.
@@ -617,7 +617,7 @@ bool otIp6ArePrefixesEqual(const otIp6Prefix *aFirst, const otIp6Prefix *aSecond
otError otIp6AddressFromString(const char *aString, otIp6Address *aAddress);
/**
* This function converts a human-readable IPv6 prefix string into a binary representation.
* Converts a human-readable IPv6 prefix string into a binary representation.
*
* The @p aString parameter should be a string in the format "<address>/<plen>", where `<address>` is an IPv6
* address and `<plen>` is a prefix length.
@@ -634,7 +634,7 @@ otError otIp6PrefixFromString(const char *aString, otIp6Prefix *aPrefix);
#define OT_IP6_ADDRESS_STRING_SIZE 40 ///< Recommended size for string representation of an IPv6 address.
/**
* This function converts a given IPv6 address to a human-readable string.
* Converts a given IPv6 address to a human-readable string.
*
* The IPv6 address string is formatted as 16 hex values separated by ':' (i.e., "%x:%x:%x:...:%x").
*
@@ -651,7 +651,7 @@ void otIp6AddressToString(const otIp6Address *aAddress, char *aBuffer, uint16_t
#define OT_IP6_SOCK_ADDR_STRING_SIZE 48 ///< Recommended size for string representation of an IPv6 socket address.
/**
* This function converts a given IPv6 socket address to a human-readable string.
* Converts a given IPv6 socket address to a human-readable string.
*
* The IPv6 socket address string is formatted as [`address`]:`port` where `address` is shown
* as 16 hex values separated by `:` and `port` is the port number in decimal format,
@@ -670,7 +670,7 @@ void otIp6SockAddrToString(const otSockAddr *aSockAddr, char *aBuffer, uint16_t
#define OT_IP6_PREFIX_STRING_SIZE 45 ///< Recommended size for string representation of an IPv6 prefix.
/**
* This function converts a given IPv6 prefix to a human-readable string.
* Converts a given IPv6 prefix to a human-readable string.
*
* The IPv6 address string is formatted as "%x:%x:%x:...[::]/plen".
*
@@ -685,7 +685,7 @@ void otIp6SockAddrToString(const otSockAddr *aSockAddr, char *aBuffer, uint16_t
void otIp6PrefixToString(const otIp6Prefix *aPrefix, char *aBuffer, uint16_t aSize);
/**
* This function returns the prefix match length (bits) for two IPv6 addresses.
* Returns the prefix match length (bits) for two IPv6 addresses.
*
* @param[in] aFirst A pointer to the first IPv6 address.
* @param[in] aSecond A pointer to the second IPv6 address.
@@ -696,7 +696,7 @@ void otIp6PrefixToString(const otIp6Prefix *aPrefix, char *aBuffer, uint16_t aSi
uint8_t otIp6PrefixMatch(const otIp6Address *aFirst, const otIp6Address *aSecond);
/**
* This method gets a prefix with @p aLength from @p aAddress.
* Gets a prefix with @p aLength from @p aAddress.
*
* @param[in] aAddress A pointer to an IPv6 address.
* @param[in] aLength The length of prefix in bits.
@@ -706,7 +706,7 @@ uint8_t otIp6PrefixMatch(const otIp6Address *aFirst, const otIp6Address *aSecond
void otIp6GetPrefix(const otIp6Address *aAddress, uint8_t aLength, otIp6Prefix *aPrefix);
/**
* This function indicates whether or not a given IPv6 address is the Unspecified Address.
* Indicates whether or not a given IPv6 address is the Unspecified Address.
*
* @param[in] aAddress A pointer to an IPv6 address.
*
@@ -717,7 +717,7 @@ void otIp6GetPrefix(const otIp6Address *aAddress, uint8_t aLength, otIp6Prefix *
bool otIp6IsAddressUnspecified(const otIp6Address *aAddress);
/**
* This function perform OpenThread source address selection.
* Perform OpenThread source address selection.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in,out] aMessageInfo A pointer to the message information.
@@ -729,9 +729,9 @@ bool otIp6IsAddressUnspecified(const otIp6Address *aAddress);
otError otIp6SelectSourceAddress(otInstance *aInstance, otMessageInfo *aMessageInfo);
/**
* This function indicates whether the SLAAC module is enabled or not.
* Indicates whether the SLAAC module is enabled or not.
*
* This function requires the build-time feature `OPENTHREAD_CONFIG_IP6_SLAAC_ENABLE` to be enabled.
* Requires the build-time feature `OPENTHREAD_CONFIG_IP6_SLAAC_ENABLE` to be enabled.
*
* @retval TRUE SLAAC module is enabled.
* @retval FALSE SLAAC module is disabled.
@@ -740,9 +740,9 @@ otError otIp6SelectSourceAddress(otInstance *aInstance, otMessageInfo *aMessageI
bool otIp6IsSlaacEnabled(otInstance *aInstance);
/**
* This function enables/disables the SLAAC module.
* Enables/disables the SLAAC module.
*
* This function requires the build-time feature `OPENTHREAD_CONFIG_IP6_SLAAC_ENABLE` to be enabled.
* Requires the build-time feature `OPENTHREAD_CONFIG_IP6_SLAAC_ENABLE` to be enabled.
*
* When SLAAC module is enabled, SLAAC addresses (based on on-mesh prefixes in Network Data) are added to the interface.
* When SLAAC module is disabled any previously added SLAAC address is removed.
@@ -754,7 +754,7 @@ bool otIp6IsSlaacEnabled(otInstance *aInstance);
void otIp6SetSlaacEnabled(otInstance *aInstance, bool aEnabled);
/**
* This function pointer allows user to filter prefixes and not allow an SLAAC address based on a prefix to be added.
* Pointer allows user to filter prefixes and not allow an SLAAC address based on a prefix to be added.
*
* `otIp6SetSlaacPrefixFilter()` can be used to set the filter handler. The filter handler is invoked by SLAAC module
* when it is about to add a SLAAC address based on a prefix. Its boolean return value determines whether the address
@@ -770,9 +770,9 @@ void otIp6SetSlaacEnabled(otInstance *aInstance, bool aEnabled);
typedef bool (*otIp6SlaacPrefixFilter)(otInstance *aInstance, const otIp6Prefix *aPrefix);
/**
* This function sets the SLAAC module filter handler.
* Sets the SLAAC module filter handler.
*
* This function requires the build-time feature `OPENTHREAD_CONFIG_IP6_SLAAC_ENABLE` to be enabled.
* Requires the build-time feature `OPENTHREAD_CONFIG_IP6_SLAAC_ENABLE` to be enabled.
*
* The filter handler is called by SLAAC module when it is about to add a SLAAC address based on a prefix to decide
* whether the address should be added or not.
@@ -788,7 +788,7 @@ typedef bool (*otIp6SlaacPrefixFilter)(otInstance *aInstance, const otIp6Prefix
void otIp6SetSlaacPrefixFilter(otInstance *aInstance, otIp6SlaacPrefixFilter aFilter);
/**
* This function pointer is called with results of `otIp6RegisterMulticastListeners`.
* Pointer is called with results of `otIp6RegisterMulticastListeners`.
*
* @param[in] aContext A pointer to the user context.
* @param[in] aError OT_ERROR_NONE when successfully sent MLR.req and received MLR.rsp,
@@ -810,7 +810,7 @@ typedef void (*otIp6RegisterMulticastListenersCallback)(void *aCon
#define OT_IP6_MAX_MLR_ADDRESSES 15 ///< Max number of IPv6 addresses supported by Multicast Listener Registration.
/**
* This function registers Multicast Listeners to Primary Backbone Router.
* Registers Multicast Listeners to Primary Backbone Router.
*
* Note: only available when both `OPENTHREAD_CONFIG_TMF_PROXY_MLR_ENABLE` and
* `OPENTHREAD_CONFIG_COMMISSIONER_ENABLE` are enabled)
@@ -843,7 +843,7 @@ otError otIp6RegisterMulticastListeners(otInstance *
void *aContext);
/**
* This function sets the Mesh Local IID (for test purpose).
* Sets the Mesh Local IID (for test purpose).
*
* Only available when `OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE` is enabled.
*
@@ -857,7 +857,7 @@ otError otIp6RegisterMulticastListeners(otInstance *
otError otIp6SetMeshLocalIid(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid);
/**
* This function converts a given IP protocol number to a human-readable string.
* Converts a given IP protocol number to a human-readable string.
*
* @param[in] aIpProto An IP protocol number (`OT_IP6_PROTO_*` enumeration).
*
@@ -867,7 +867,7 @@ otError otIp6SetMeshLocalIid(otInstance *aInstance, const otIp6InterfaceIdentifi
const char *otIp6ProtoToString(uint8_t aIpProto);
/**
* This structure represents the counters for packets and bytes.
* Represents the counters for packets and bytes.
*
*/
typedef struct otPacketsAndBytes
@@ -877,7 +877,7 @@ typedef struct otPacketsAndBytes
} otPacketsAndBytes;
/**
* This structure represents the counters of packets forwarded via Border Routing.
* Represents the counters of packets forwarded via Border Routing.
*
*/
typedef struct otBorderRoutingCounters
@@ -897,7 +897,7 @@ typedef struct otBorderRoutingCounters
/**
* Gets the Border Routing counters.
*
* This function requires the build-time feature `OPENTHREAD_CONFIG_IP6_BR_COUNTERS_ENABLE` to be enabled.
* Requires the build-time feature `OPENTHREAD_CONFIG_IP6_BR_COUNTERS_ENABLE` to be enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
include/openthread/jam_detection.h
+1 -1
View File
@@ -55,7 +55,7 @@ extern "C" {
*/
/**
* This function pointer is called if signal jam detection is enabled and a jam is detected.
* Pointer is called if signal jam detection is enabled and a jam is detected.
*
* @param[in] aJamState Current jam state (`true` if jam is detected, `false` otherwise).
* @param[in] aContext A pointer to application-specific context.
include/openthread/joiner.h
+4 -4
View File
@@ -56,7 +56,7 @@ extern "C" {
*/
/**
* This enumeration defines the Joiner State.
* Defines the Joiner State.
*
*/
typedef enum otJoinerState
@@ -72,7 +72,7 @@ typedef enum otJoinerState
#define OT_JOINER_MAX_DISCERNER_LENGTH 64 ///< Maximum length of a Joiner Discerner in bits.
/**
* This structure represents a Joiner Discerner.
* Represents a Joiner Discerner.
*
*/
typedef struct otJoinerDiscerner
@@ -82,7 +82,7 @@ typedef struct otJoinerDiscerner
} otJoinerDiscerner;
/**
* This function pointer is called to notify the completion of a join operation.
* Pointer is called to notify the completion of a join operation.
*
* @param[in] aError OT_ERROR_NONE if the join process succeeded.
* OT_ERROR_SECURITY if the join process failed due to security credentials.
@@ -188,7 +188,7 @@ otError otJoinerSetDiscerner(otInstance *aInstance, otJoinerDiscerner *aDiscerne
const otJoinerDiscerner *otJoinerGetDiscerner(otInstance *aInstance);
/**
* This function converts a given joiner state enumeration value to a human-readable string.
* Converts a given joiner state enumeration value to a human-readable string.
*
* @param[in] aState The joiner state.
*
include/openthread/link.h
+68 -68
View File
@@ -55,7 +55,7 @@ extern "C" {
#define OT_US_PER_TEN_SYMBOLS OT_RADIO_TEN_SYMBOLS_TIME ///< Time for 10 symbols in units of microseconds
/**
* This structure represents link-specific information for messages received from the Thread radio.
* Represents link-specific information for messages received from the Thread radio.
*
*/
typedef struct otThreadLinkInfo
@@ -97,7 +97,7 @@ typedef enum otMacFilterAddressMode
} otMacFilterAddressMode;
/**
* This structure represents a Mac Filter entry.
* Represents a Mac Filter entry.
*
*/
typedef struct otMacFilterEntry
@@ -107,7 +107,7 @@ typedef struct otMacFilterEntry
} otMacFilterEntry;
/**
* This structure represents the MAC layer counters.
* Represents the MAC layer counters.
*
*/
typedef struct otMacCounters
@@ -374,7 +374,7 @@ typedef struct otMacCounters
} otMacCounters;
/**
* This structure represents a received IEEE 802.15.4 Beacon.
* Represents a received IEEE 802.15.4 Beacon.
*
*/
typedef struct otActiveScanResult
@@ -398,7 +398,7 @@ typedef struct otActiveScanResult
} otActiveScanResult;
/**
* This structure represents an energy scan result.
* Represents an energy scan result.
*
*/
typedef struct otEnergyScanResult
@@ -408,7 +408,7 @@ typedef struct otEnergyScanResult
} otEnergyScanResult;
/**
* This function pointer is called during an IEEE 802.15.4 Active Scan when an IEEE 802.15.4 Beacon is received or
* Pointer is called during an IEEE 802.15.4 Active Scan when an IEEE 802.15.4 Beacon is received or
* the scan completes.
*
* @param[in] aResult A valid pointer to the beacon information or NULL when the active scan completes.
@@ -418,7 +418,7 @@ typedef struct otEnergyScanResult
typedef void (*otHandleActiveScanResult)(otActiveScanResult *aResult, void *aContext);
/**
* This function starts an IEEE 802.15.4 Active Scan
* Starts an IEEE 802.15.4 Active Scan
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aScanChannels A bit vector indicating which channels to scan (e.g. OT_CHANNEL_11_MASK).
@@ -437,7 +437,7 @@ otError otLinkActiveScan(otInstance *aInstance,
void *aCallbackContext);
/**
* This function indicates whether or not an IEEE 802.15.4 Active Scan is currently in progress.
* Indicates whether or not an IEEE 802.15.4 Active Scan is currently in progress.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -446,7 +446,7 @@ otError otLinkActiveScan(otInstance *aInstance,
bool otLinkIsActiveScanInProgress(otInstance *aInstance);
/**
* This function pointer is called during an IEEE 802.15.4 Energy Scan when the result for a channel is ready or the
* Pointer is called during an IEEE 802.15.4 Energy Scan when the result for a channel is ready or the
* scan completes.
*
* @param[in] aResult A valid pointer to the energy scan result information or NULL when the energy scan completes.
@@ -456,7 +456,7 @@ bool otLinkIsActiveScanInProgress(otInstance *aInstance);
typedef void (*otHandleEnergyScanResult)(otEnergyScanResult *aResult, void *aContext);
/**
* This function starts an IEEE 802.15.4 Energy Scan
* Starts an IEEE 802.15.4 Energy Scan
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aScanChannels A bit vector indicating on which channels to perform energy scan.
@@ -475,7 +475,7 @@ otError otLinkEnergyScan(otInstance *aInstance,
void *aCallbackContext);
/**
* This function indicates whether or not an IEEE 802.15.4 Energy Scan is currently in progress.
* Indicates whether or not an IEEE 802.15.4 Energy Scan is currently in progress.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -485,7 +485,7 @@ otError otLinkEnergyScan(otInstance *aInstance,
bool otLinkIsEnergyScanInProgress(otInstance *aInstance);
/**
* This function enqueues an IEEE 802.15.4 Data Request message for transmission.
* Enqueues an IEEE 802.15.4 Data Request message for transmission.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -497,7 +497,7 @@ bool otLinkIsEnergyScanInProgress(otInstance *aInstance);
otError otLinkSendDataRequest(otInstance *aInstance);
/**
* This function indicates whether or not an IEEE 802.15.4 MAC is in the transmit state.
* Indicates whether or not an IEEE 802.15.4 MAC is in the transmit state.
*
* MAC module is in the transmit state during CSMA/CA procedure, CCA, Data, Beacon or Data Request frame transmission
* and receiving an ACK of a transmitted frame. MAC module is not in the transmit state during transmission of an ACK
@@ -525,7 +525,7 @@ uint8_t otLinkGetChannel(otInstance *aInstance);
/**
* Set the IEEE 802.15.4 channel
*
* This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the
* Succeeds only when Thread protocols are disabled. A successful call to this function invalidates the
* Active and Pending Operational Datasets in non-volatile memory.
*
* @param[in] aInstance A pointer to an OpenThread instance.
@@ -553,7 +553,7 @@ uint32_t otLinkGetSupportedChannelMask(otInstance *aInstance);
/**
* Set the supported channel mask of MAC layer.
*
* This function succeeds only when Thread protocols are disabled.
* Succeeds only when Thread protocols are disabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aChannelMask The supported channel mask (bit 0 or lsb mapping to channel 0, and so on).
@@ -613,7 +613,7 @@ otPanId otLinkGetPanId(otInstance *aInstance);
/**
* Set the IEEE 802.15.4 PAN ID.
*
* This function succeeds only when Thread protocols are disabled. A successful call to this function also invalidates
* Succeeds only when Thread protocols are disabled. A successful call to this function also invalidates
* the Active and Pending Operational Datasets in non-volatile memory.
*
* @param[in] aInstance A pointer to an OpenThread instance.
@@ -674,7 +674,7 @@ otError otLinkSetPollPeriod(otInstance *aInstance, uint32_t aPollPeriod);
otShortAddress otLinkGetShortAddress(otInstance *aInstance);
/**
* This method returns the maximum number of frame retries during direct transmission.
* Returns the maximum number of frame retries during direct transmission.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -684,7 +684,7 @@ otShortAddress otLinkGetShortAddress(otInstance *aInstance);
uint8_t otLinkGetMaxFrameRetriesDirect(otInstance *aInstance);
/**
* This method sets the maximum number of frame retries during direct transmission.
* Sets the maximum number of frame retries during direct transmission.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aMaxFrameRetriesDirect The maximum number of retries during direct transmission.
@@ -693,7 +693,7 @@ uint8_t otLinkGetMaxFrameRetriesDirect(otInstance *aInstance);
void otLinkSetMaxFrameRetriesDirect(otInstance *aInstance, uint8_t aMaxFrameRetriesDirect);
/**
* This method returns the maximum number of frame retries during indirect transmission.
* Returns the maximum number of frame retries during indirect transmission.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -703,7 +703,7 @@ void otLinkSetMaxFrameRetriesDirect(otInstance *aInstance, uint8_t aMaxFrameRetr
uint8_t otLinkGetMaxFrameRetriesIndirect(otInstance *aInstance);
/**
* This method sets the maximum number of frame retries during indirect transmission.
* Sets the maximum number of frame retries during indirect transmission.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aMaxFrameRetriesIndirect The maximum number of retries during indirect transmission.
@@ -712,9 +712,9 @@ uint8_t otLinkGetMaxFrameRetriesIndirect(otInstance *aInstance);
void otLinkSetMaxFrameRetriesIndirect(otInstance *aInstance, uint8_t aMaxFrameRetriesIndirect);
/**
* This function gets the address mode of MAC filter.
* Gets the address mode of MAC filter.
*
* This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
* Is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -724,9 +724,9 @@ void otLinkSetMaxFrameRetriesIndirect(otInstance *aInstance, uint8_t aMaxFrameRe
otMacFilterAddressMode otLinkFilterGetAddressMode(otInstance *aInstance);
/**
* This function sets the address mode of MAC filter.
* Sets the address mode of MAC filter.
*
* This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
* Is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aMode The address mode to set.
@@ -735,9 +735,9 @@ otMacFilterAddressMode otLinkFilterGetAddressMode(otInstance *aInstance);
void otLinkFilterSetAddressMode(otInstance *aInstance, otMacFilterAddressMode aMode);
/**
* This method adds an Extended Address to MAC filter.
* Adds an Extended Address to MAC filter.
*
* This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
* Is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aExtAddress A pointer to the Extended Address (MUST NOT be NULL).
@@ -749,9 +749,9 @@ void otLinkFilterSetAddressMode(otInstance *aInstance, otMacFilterAddressMode aM
otError otLinkFilterAddAddress(otInstance *aInstance, const otExtAddress *aExtAddress);
/**
* This method removes an Extended Address from MAC filter.
* Removes an Extended Address from MAC filter.
*
* This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
* Is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
*
* No action is performed if there is no existing entry in Filter matching the given Extended Address.
*
@@ -762,9 +762,9 @@ otError otLinkFilterAddAddress(otInstance *aInstance, const otExtAddress *aExtAd
void otLinkFilterRemoveAddress(otInstance *aInstance, const otExtAddress *aExtAddress);
/**
* This method clears all the Extended Addresses from MAC filter.
* Clears all the Extended Addresses from MAC filter.
*
* This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
* Is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -772,9 +772,9 @@ void otLinkFilterRemoveAddress(otInstance *aInstance, const otExtAddress *aExtAd
void otLinkFilterClearAddresses(otInstance *aInstance);
/**
* This method gets an in-use address filter entry.
* Gets an in-use address filter entry.
*
* This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
* Is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in,out] aIterator A pointer to the MAC filter iterator context. To get the first in-use address filter
@@ -788,10 +788,10 @@ void otLinkFilterClearAddresses(otInstance *aInstance);
otError otLinkFilterGetNextAddress(otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry);
/**
* This method adds a fixed received signal strength (in dBm) entry for the messages from a given Extended Address in
* Adds a fixed received signal strength (in dBm) entry for the messages from a given Extended Address in
* MAC Filter.
*
* This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
* Is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aExtAddress A pointer to the IEEE 802.15.4 Extended Address. MUST NOT be NULL.
@@ -804,9 +804,9 @@ otError otLinkFilterGetNextAddress(otInstance *aInstance, otMacFilterIterator *a
otError otLinkFilterAddRssIn(otInstance *aInstance, const otExtAddress *aExtAddress, int8_t aRss);
/**
* This method removes a MAC Filter entry for fixed received signal strength setting for a given Extended Address.
* Removes a MAC Filter entry for fixed received signal strength setting for a given Extended Address.
*
* This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
* Is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
*
* No action is performed if there is no existing entry in Filter matching the given Extended Address.
*
@@ -817,9 +817,9 @@ otError otLinkFilterAddRssIn(otInstance *aInstance, const otExtAddress *aExtAddr
void otLinkFilterRemoveRssIn(otInstance *aInstance, const otExtAddress *aExtAddress);
/**
* This method sets the default received signal strength (in dBm) on MAC Filter.
* Sets the default received signal strength (in dBm) on MAC Filter.
*
* This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
* Is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
*
* The default RSS value is used for all received frames from addresses for which there is no explicit RSS-IN entry
* in the Filter list (added using `otLinkFilterAddRssIn()`).
@@ -831,9 +831,9 @@ void otLinkFilterRemoveRssIn(otInstance *aInstance, const otExtAddress *aExtAddr
void otLinkFilterSetDefaultRssIn(otInstance *aInstance, int8_t aRss);
/**
* This method clears any previously set default received signal strength (in dBm) on MAC Filter.
* Clears any previously set default received signal strength (in dBm) on MAC Filter.
*
* This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
* Is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -841,9 +841,9 @@ void otLinkFilterSetDefaultRssIn(otInstance *aInstance, int8_t aRss);
void otLinkFilterClearDefaultRssIn(otInstance *aInstance);
/**
* This method clears all the received signal strength entries (including default RSS-in) on MAC Filter.
* Clears all the received signal strength entries (including default RSS-in) on MAC Filter.
*
* This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
* Is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -851,9 +851,9 @@ void otLinkFilterClearDefaultRssIn(otInstance *aInstance);
void otLinkFilterClearAllRssIn(otInstance *aInstance);
/**
* This method gets an in-use RssIn filter entry.
* Gets an in-use RssIn filter entry.
*
* This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
* Is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in,out] aIterator A pointer to the MAC filter iterator context. MUST NOT be NULL.
@@ -869,9 +869,9 @@ void otLinkFilterClearAllRssIn(otInstance *aInstance);
otError otLinkFilterGetNextRssIn(otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry);
/**
* This function enables/disables IEEE 802.15.4 radio filter mode.
* Enables/disables IEEE 802.15.4 radio filter mode.
*
* This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
* Is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
*
* The radio filter is mainly intended for testing. It can be used to temporarily block all tx/rx on the 802.15.4 radio.
* When radio filter is enabled, radio is put to sleep instead of receive (to ensure device does not receive any frame
@@ -885,9 +885,9 @@ otError otLinkFilterGetNextRssIn(otInstance *aInstance, otMacFilterIterator *aIt
void otLinkSetRadioFilterEnabled(otInstance *aInstance, bool aFilterEnabled);
/**
* This function indicates whether the IEEE 802.15.4 radio filter is enabled or not.
* Indicates whether the IEEE 802.15.4 radio filter is enabled or not.
*
* This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
* Is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.
*
* @retval TRUE If the radio filter is enabled.
* @retval FALSE If the radio filter is disabled.
@@ -896,7 +896,7 @@ void otLinkSetRadioFilterEnabled(otInstance *aInstance, bool aFilterEnabled);
bool otLinkIsRadioFilterEnabled(otInstance *aInstance);
/**
* This method converts received signal strength to link quality.
* Converts received signal strength to link quality.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aRss The received signal strength value to be converted.
@@ -907,7 +907,7 @@ bool otLinkIsRadioFilterEnabled(otInstance *aInstance);
uint8_t otLinkConvertRssToLinkQuality(otInstance *aInstance, int8_t aRss);
/**
* This method converts link quality to typical received signal strength.
* Converts link quality to typical received signal strength.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aLinkQuality LinkQuality value, should be in range [0,3].
@@ -918,9 +918,9 @@ uint8_t otLinkConvertRssToLinkQuality(otInstance *aInstance, int8_t aRss);
int8_t otLinkConvertLinkQualityToRss(otInstance *aInstance, uint8_t aLinkQuality);
/**
* This method gets histogram of retries for a single direct packet until success.
* Gets histogram of retries for a single direct packet until success.
*
* This function is valid when OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE configuration is enabled.
* Is valid when OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE configuration is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[out] aNumberOfEntries A pointer to where the size of returned histogram array is placed.
@@ -931,9 +931,9 @@ int8_t otLinkConvertLinkQualityToRss(otInstance *aInstance, uint8_t aLinkQuality
const uint32_t *otLinkGetTxDirectRetrySuccessHistogram(otInstance *aInstance, uint8_t *aNumberOfEntries);
/**
* This method gets histogram of retries for a single indirect packet until success.
* Gets histogram of retries for a single indirect packet until success.
*
* This function is valid when OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE configuration is enabled.
* Is valid when OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE configuration is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[out] aNumberOfEntries A pointer to where the size of returned histogram array is placed.
@@ -945,9 +945,9 @@ const uint32_t *otLinkGetTxDirectRetrySuccessHistogram(otInstance *aInstance, ui
const uint32_t *otLinkGetTxIndirectRetrySuccessHistogram(otInstance *aInstance, uint8_t *aNumberOfEntries);
/**
* This method clears histogram statistics for direct and indirect transmissions.
* Clears histogram statistics for direct and indirect transmissions.
*
* This function is valid when OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE configuration is enabled.
* Is valid when OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE configuration is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -973,7 +973,7 @@ const otMacCounters *otLinkGetCounters(otInstance *aInstance);
void otLinkResetCounters(otInstance *aInstance);
/**
* This function pointer is called when an IEEE 802.15.4 frame is received.
* Pointer is called when an IEEE 802.15.4 frame is received.
*
* @note This callback is called after FCS processing and @p aFrame may not contain the actual FCS that was received.
*
@@ -987,7 +987,7 @@ void otLinkResetCounters(otInstance *aInstance);
typedef void (*otLinkPcapCallback)(const otRadioFrame *aFrame, bool aIsTx, void *aContext);
/**
* This function registers a callback to provide received raw IEEE 802.15.4 frames.
* Registers a callback to provide received raw IEEE 802.15.4 frames.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aPcapCallback A pointer to a function that is called when receiving an IEEE 802.15.4 link frame or
@@ -998,7 +998,7 @@ typedef void (*otLinkPcapCallback)(const otRadioFrame *aFrame, bool aIsTx, void
void otLinkSetPcapCallback(otInstance *aInstance, otLinkPcapCallback aPcapCallback, void *aCallbackContext);
/**
* This function indicates whether or not promiscuous mode is enabled at the link layer.
* Indicates whether or not promiscuous mode is enabled at the link layer.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -1009,7 +1009,7 @@ void otLinkSetPcapCallback(otInstance *aInstance, otLinkPcapCallback aPcapCallba
bool otLinkIsPromiscuous(otInstance *aInstance);
/**
* This function enables or disables the link layer promiscuous mode.
* Enables or disables the link layer promiscuous mode.
*
* @note Promiscuous mode may only be enabled when the Thread interface is disabled.
*
@@ -1024,7 +1024,7 @@ bool otLinkIsPromiscuous(otInstance *aInstance);
otError otLinkSetPromiscuous(otInstance *aInstance, bool aPromiscuous);
/**
* This function gets the CSL channel.
* Gets the CSL channel.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -1047,7 +1047,7 @@ uint8_t otLinkCslGetChannel(otInstance *aInstance);
otError otLinkCslSetChannel(otInstance *aInstance, uint8_t aChannel);
/**
* This function gets the CSL period.
* Gets the CSL period.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -1069,7 +1069,7 @@ uint16_t otLinkCslGetPeriod(otInstance *aInstance);
otError otLinkCslSetPeriod(otInstance *aInstance, uint16_t aPeriod);
/**
* This function gets the CSL timeout.
* Gets the CSL timeout.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -1091,7 +1091,7 @@ uint32_t otLinkCslGetTimeout(otInstance *aInstance);
otError otLinkCslSetTimeout(otInstance *aInstance, uint32_t aTimeout);
/**
* This function returns the current CCA (Clear Channel Assessment) failure rate.
* Returns the current CCA (Clear Channel Assessment) failure rate.
*
* The rate is maintained over a window of (roughly) last `OPENTHREAD_CONFIG_CCA_FAILURE_RATE_AVERAGING_WINDOW`
* frame transmissions.
@@ -1102,7 +1102,7 @@ otError otLinkCslSetTimeout(otInstance *aInstance, uint32_t aTimeout);
uint16_t otLinkGetCcaFailureRate(otInstance *aInstance);
/**
* This function enables or disables the link layer.
* Enables or disables the link layer.
*
* @note The link layer may only be enabled / disabled when the Thread Interface is disabled.
*
@@ -1117,7 +1117,7 @@ uint16_t otLinkGetCcaFailureRate(otInstance *aInstance);
otError otLinkSetEnabled(otInstance *aInstance, bool aEnable);
/**
* This function indicates whether or not the link layer is enabled.
* Indicates whether or not the link layer is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -1128,9 +1128,9 @@ otError otLinkSetEnabled(otInstance *aInstance, bool aEnable);
bool otLinkIsEnabled(otInstance *aInstance);
/**
* This function instructs the device to send an empty IEEE 802.15.4 data frame.
* Instructs the device to send an empty IEEE 802.15.4 data frame.
*
* This function is only supported on an Rx-Off-When-Idle device to send an empty data frame to its parent.
* Is only supported on an Rx-Off-When-Idle device to send an empty data frame to its parent.
* Note: available only when `OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE` is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
include/openthread/link_metrics.h
+7 -7
View File
@@ -56,7 +56,7 @@ extern "C" {
*/
/**
* This structure represents the result (value) for a Link Metrics query.
* Represents the result (value) for a Link Metrics query.
*
*/
typedef struct otLinkMetricsValues
@@ -70,7 +70,7 @@ typedef struct otLinkMetricsValues
} otLinkMetricsValues;
/**
* This structure represents which frames are accounted in a Forward Tracking Series.
* Represents which frames are accounted in a Forward Tracking Series.
*
*/
typedef struct otLinkMetricsSeriesFlags
@@ -108,7 +108,7 @@ typedef enum otLinkMetricsStatus
} otLinkMetricsStatus;
/**
* This function pointer is called when a Link Metrics report is received.
* Pointer is called when a Link Metrics report is received.
*
* @param[in] aSource A pointer to the source address.
* @param[in] aMetricsValues A pointer to the Link Metrics values (the query result).
@@ -121,7 +121,7 @@ typedef void (*otLinkMetricsReportCallback)(const otIp6Address *aSource,
uint8_t aStatus,
void *aContext);
/**
* This function pointer is called when a Link Metrics Management Response is received.
* Pointer is called when a Link Metrics Management Response is received.
*
* @param[in] aSource A pointer to the source address.
* @param[in] aStatus The status code in the response.
@@ -131,7 +131,7 @@ typedef void (*otLinkMetricsReportCallback)(const otIp6Address *aSource,
typedef void (*otLinkMetricsMgmtResponseCallback)(const otIp6Address *aSource, uint8_t aStatus, void *aContext);
/**
* This function pointer is called when Enh-ACK Probing IE is received.
* Pointer is called when Enh-ACK Probing IE is received.
*
* @param[in] aShortAddress The Mac short address of the Probing Subject.
* @param[in] aExtAddress A pointer to the Mac extended address of the Probing Subject.
@@ -145,7 +145,7 @@ typedef void (*otLinkMetricsEnhAckProbingIeReportCallback)(otShortAddress
void *aContext);
/**
* This function sends an MLE Data Request to query Link Metrics.
* Sends an MLE Data Request to query Link Metrics.
*
* It could be either Single Probe or Forward Tracking Series.
*
@@ -198,7 +198,7 @@ otError otLinkMetricsConfigForwardTrackingSeries(otInstance
void *aCallbackContext);
/**
* This function sends an MLE Link Metrics Management Request to configure/clear an Enhanced-ACK Based Probing.
* Sends an MLE Link Metrics Management Request to configure/clear an Enhanced-ACK Based Probing.
* This functionality requires OT_LINK_METRICS_INITIATOR feature enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
include/openthread/link_raw.h
+11 -11
View File
@@ -52,7 +52,7 @@ extern "C" {
*/
/**
* This function pointer on receipt of a IEEE 802.15.4 frame.
* Pointer on receipt of a IEEE 802.15.4 frame.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aFrame A pointer to the received frame or NULL if the receive operation was aborted.
@@ -63,7 +63,7 @@ extern "C" {
typedef void (*otLinkRawReceiveDone)(otInstance *aInstance, otRadioFrame *aFrame, otError aError);
/**
* This function enables/disables the raw link-layer.
* Enables/disables the raw link-layer.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aCallback A pointer to a function called on receipt of a IEEE 802.15.4 frame. NULL to disable the
@@ -77,7 +77,7 @@ typedef void (*otLinkRawReceiveDone)(otInstance *aInstance, otRadioFrame *aFrame
otError otLinkRawSetReceiveDone(otInstance *aInstance, otLinkRawReceiveDone aCallback);
/**
* This function indicates whether or not the raw link-layer is enabled.
* Indicates whether or not the raw link-layer is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -88,7 +88,7 @@ otError otLinkRawSetReceiveDone(otInstance *aInstance, otLinkRawReceiveDone aCal
bool otLinkRawIsEnabled(otInstance *aInstance);
/**
* This function gets the status of promiscuous mode.
* Gets the status of promiscuous mode.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -99,7 +99,7 @@ bool otLinkRawIsEnabled(otInstance *aInstance);
bool otLinkRawGetPromiscuous(otInstance *aInstance);
/**
* This function enables or disables promiscuous mode.
* Enables or disables promiscuous mode.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aEnable A value to enable or disable promiscuous mode.
@@ -149,7 +149,7 @@ otError otLinkRawReceive(otInstance *aInstance);
/**
* The radio transitions from Transmit to Receive.
* This method returns a pointer to the transmit buffer.
* Returns a pointer to the transmit buffer.
*
* The caller forms the IEEE 802.15.4 frame in this buffer then calls otLinkRawTransmit()
* to request transmission.
@@ -162,7 +162,7 @@ otError otLinkRawReceive(otInstance *aInstance);
otRadioFrame *otLinkRawGetTransmitBuffer(otInstance *aInstance);
/**
* This function pointer on receipt of a IEEE 802.15.4 frame.
* Pointer on receipt of a IEEE 802.15.4 frame.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aFrame A pointer to the frame that was transmitted.
@@ -180,7 +180,7 @@ typedef void (*otLinkRawTransmitDone)(otInstance *aInstance,
otError aError);
/**
* This method begins the transmit sequence on the radio.
* Begins the transmit sequence on the radio.
*
* The caller must form the IEEE 802.15.4 frame in the buffer provided by otLinkRawGetTransmitBuffer() before
* requesting transmission. The channel and transmit power are also included in the otRadioFrame structure.
@@ -219,7 +219,7 @@ int8_t otLinkRawGetRssi(otInstance *aInstance);
otRadioCaps otLinkRawGetCaps(otInstance *aInstance);
/**
* This function pointer on receipt of a IEEE 802.15.4 frame.
* Pointer on receipt of a IEEE 802.15.4 frame.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aEnergyScanMaxRssi The maximum RSSI encountered on the scanned channel.
@@ -228,7 +228,7 @@ otRadioCaps otLinkRawGetCaps(otInstance *aInstance);
typedef void (*otLinkRawEnergyScanDone)(otInstance *aInstance, int8_t aEnergyScanMaxRssi);
/**
* This method begins the energy scan sequence on the radio.
* Begins the energy scan sequence on the radio.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aScanChannel The channel to perform the energy scan on.
@@ -356,7 +356,7 @@ otError otLinkRawSetMacKey(otInstance *aInstance,
/**
* Sets the current MAC frame counter value.
*
* This function always sets the MAC counter to the new given value @p aMacFrameCounter independent of the current
* Always sets the MAC counter to the new given value @p aMacFrameCounter independent of the current
* value.
*
* @param[in] aInstance A pointer to an OpenThread instance.
include/openthread/logging.h
+19 -19
View File
@@ -53,7 +53,7 @@ extern "C" {
*/
/**
* This function returns the current log level.
* Returns the current log level.
*
* If dynamic log level feature `OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE` is enabled, this function returns the
* currently set dynamic log level. Otherwise, this function returns the build-time configured log level.
@@ -64,7 +64,7 @@ extern "C" {
otLogLevel otLoggingGetLevel(void);
/**
* This function sets the log level.
* Sets the log level.
*
* @note This function requires `OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE=1`.
*
@@ -77,9 +77,9 @@ otLogLevel otLoggingGetLevel(void);
otError otLoggingSetLevel(otLogLevel aLogLevel);
/**
* This function emits a log message at critical log level.
* Emits a log message at critical log level.
*
* This function is intended for use by platform. If `OPENTHREAD_CONFIG_LOG_PLATFORM` is not set or the current log
* Is intended for use by platform. If `OPENTHREAD_CONFIG_LOG_PLATFORM` is not set or the current log
* level is below critical, this function does not emit any log message.
*
* @param[in] aFormat The format string.
@@ -89,9 +89,9 @@ otError otLoggingSetLevel(otLogLevel aLogLevel);
void otLogCritPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1, 2);
/**
* This function emits a log message at warning log level.
* Emits a log message at warning log level.
*
* This function is intended for use by platform. If `OPENTHREAD_CONFIG_LOG_PLATFORM` is not set or the current log
* Is intended for use by platform. If `OPENTHREAD_CONFIG_LOG_PLATFORM` is not set or the current log
* level is below warning, this function does not emit any log message.
*
* @param[in] aFormat The format string.
@@ -101,9 +101,9 @@ void otLogCritPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHE
void otLogWarnPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1, 2);
/**
* This function emits a log message at note log level.
* Emits a log message at note log level.
*
* This function is intended for use by platform. If `OPENTHREAD_CONFIG_LOG_PLATFORM` is not set or the current log
* Is intended for use by platform. If `OPENTHREAD_CONFIG_LOG_PLATFORM` is not set or the current log
* level is below note, this function does not emit any log message.
*
* @param[in] aFormat The format string.
@@ -113,9 +113,9 @@ void otLogWarnPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHE
void otLogNotePlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1, 2);
/**
* This function emits a log message at info log level.
* Emits a log message at info log level.
*
* This function is intended for use by platform. If `OPENTHREAD_CONFIG_LOG_PLATFORM` is not set or the current log
* Is intended for use by platform. If `OPENTHREAD_CONFIG_LOG_PLATFORM` is not set or the current log
* level is below info, this function does not emit any log message.
*
* @param[in] aFormat The format string.
@@ -125,9 +125,9 @@ void otLogNotePlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHE
void otLogInfoPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1, 2);
/**
* This function emits a log message at debug log level.
* Emits a log message at debug log level.
*
* This function is intended for use by platform. If `OPENTHREAD_CONFIG_LOG_PLATFORM` is not set or the current log
* Is intended for use by platform. If `OPENTHREAD_CONFIG_LOG_PLATFORM` is not set or the current log
* level is below debug, this function does not emit any log message.
*
* @param[in] aFormat The format string.
@@ -137,7 +137,7 @@ void otLogInfoPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHE
void otLogDebgPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1, 2);
/**
* This function generates a memory dump at critical log level.
* Generates a memory dump at critical log level.
*
* If `OPENTHREAD_CONFIG_LOG_PLATFORM` or `OPENTHREAD_CONFIG_LOG_PKT_DUMP` is not set or the current log level is below
* critical this function does not emit any log message.
@@ -150,7 +150,7 @@ void otLogDebgPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHE
void otDumpCritPlat(const char *aText, const void *aData, uint16_t aDataLength);
/**
* This function generates a memory dump at warning log level.
* Generates a memory dump at warning log level.
*
* If `OPENTHREAD_CONFIG_LOG_PLATFORM` or `OPENTHREAD_CONFIG_LOG_PKT_DUMP` is not set or the current log level is below
* warning this function does not emit any log message.
@@ -163,7 +163,7 @@ void otDumpCritPlat(const char *aText, const void *aData, uint16_t aDataLength);
void otDumpWarnPlat(const char *aText, const void *aData, uint16_t aDataLength);
/**
* This function generates a memory dump at note log level.
* Generates a memory dump at note log level.
*
* If `OPENTHREAD_CONFIG_LOG_PLATFORM` or `OPENTHREAD_CONFIG_LOG_PKT_DUMP` is not set or the current log level is below
* note this function does not emit any log message.
@@ -176,7 +176,7 @@ void otDumpWarnPlat(const char *aText, const void *aData, uint16_t aDataLength);
void otDumpNotePlat(const char *aText, const void *aData, uint16_t aDataLength);
/**
* This function generates a memory dump at info log level.
* Generates a memory dump at info log level.
*
* If `OPENTHREAD_CONFIG_LOG_PLATFORM` or `OPENTHREAD_CONFIG_LOG_PKT_DUMP` is not set or the current log level is below
* info this function does not emit any log message.
@@ -189,7 +189,7 @@ void otDumpNotePlat(const char *aText, const void *aData, uint16_t aDataLength);
void otDumpInfoPlat(const char *aText, const void *aData, uint16_t aDataLength);
/**
* This function generates a memory dump at debug log level.
* Generates a memory dump at debug log level.
*
* If `OPENTHREAD_CONFIG_LOG_PLATFORM` or `OPENTHREAD_CONFIG_LOG_PKT_DUMP` is not set or the current log level is below
* debug this function does not emit any log message.
@@ -202,9 +202,9 @@ void otDumpInfoPlat(const char *aText, const void *aData, uint16_t aDataLength);
void otDumpDebgPlat(const char *aText, const void *aData, uint16_t aDataLength);
/**
* This function emits a log message at a given log level.
* Emits a log message at a given log level.
*
* This function is intended for use by CLI only. If `OPENTHREAD_CONFIG_LOG_CLI` is not set or the current log
* Is intended for use by CLI only. If `OPENTHREAD_CONFIG_LOG_CLI` is not set or the current log
* level is below the given log level, this function does not emit any log message.
*
* @param[in] aLogLevel The log level.
include/openthread/mesh_diag.h
+10 -10
View File
@@ -55,7 +55,7 @@ extern "C" {
*/
/**
* This structure represents the set of configurations used when discovering mesh topology indicating which items to
* Represents the set of configurations used when discovering mesh topology indicating which items to
* discover.
*
*/
@@ -66,7 +66,7 @@ typedef struct otMeshDiagDiscoverConfig
} otMeshDiagDiscoverConfig;
/**
* This type is an opaque iterator to iterate over list of IPv6 addresses of a router.
* An opaque iterator to iterate over list of IPv6 addresses of a router.
*
* Pointers to instance of this type are provided in `otMeshDiagRouterInfo`.
*
@@ -74,7 +74,7 @@ typedef struct otMeshDiagDiscoverConfig
typedef struct otMeshDiagIp6AddrIterator otMeshDiagIp6AddrIterator;
/**
* This type is an opaque iterator to iterate over list of children of a router.
* An opaque iterator to iterate over list of children of a router.
*
* Pointers to instance of this type are provided in `otMeshDiagRouterInfo`.
*
@@ -91,7 +91,7 @@ typedef struct otMeshDiagChildIterator otMeshDiagChildIterator;
#define OT_MESH_DIAG_VERSION_UNKNOWN 0xffff
/**
* This type represents information about a router in Thread mesh.
* Represents information about a router in Thread mesh.
*
*/
typedef struct otMeshDiagRouterInfo
@@ -142,7 +142,7 @@ typedef struct otMeshDiagRouterInfo
} otMeshDiagRouterInfo;
/**
* This type represents information about a discovered child in Thread mesh.
* Represents information about a discovered child in Thread mesh.
*
*/
typedef struct otMeshDiagChildInfo
@@ -155,7 +155,7 @@ typedef struct otMeshDiagChildInfo
} otMeshDiagChildInfo;
/**
* This function pointer type represents the callback used by `otMeshDiagDiscoverTopology()` to provide information
* Pointer type represents the callback used by `otMeshDiagDiscoverTopology()` to provide information
* about a discovered router.
*
* When @p aError is `OT_ERROR_PENDING`, it indicates that the discovery is not yet finished and there will be more
@@ -171,7 +171,7 @@ typedef struct otMeshDiagChildInfo
typedef void (*otMeshDiagDiscoverCallback)(otError aError, otMeshDiagRouterInfo *aRouterInfo, void *aContext);
/**
* This function starts network topology discovery.
* Starts network topology discovery.
*
* @param[in] aInstance The OpenThread instance.
* @param[in] aConfig The configuration to use for discovery (e.g., which items to discover).
@@ -190,7 +190,7 @@ otError otMeshDiagDiscoverTopology(otInstance *aInstance,
void *aContext);
/**
* This function cancels an ongoing topology discovery if there is one, otherwise no action.
* Cancels an ongoing topology discovery if there is one, otherwise no action.
*
* When ongoing discovery is cancelled, the callback from `otMeshDiagDiscoverTopology()` will not be called anymore.
*
@@ -198,7 +198,7 @@ otError otMeshDiagDiscoverTopology(otInstance *aInstance,
void otMeshDiagCancel(otInstance *aInstance);
/**
* This function iterates through the discovered IPv6 address of a router.
* Iterates through the discovered IPv6 address of a router.
*
* @param[in,out] aIterator The address iterator to use.
* @param[out] aIp6Address A pointer to return the next IPv6 address (if any).
@@ -210,7 +210,7 @@ void otMeshDiagCancel(otInstance *aInstance);
otError otMeshDiagGetNextIp6Address(otMeshDiagIp6AddrIterator *aIterator, otIp6Address *aIp6Address);
/**
* This function iterates through the discovered children of a router.
* Iterates through the discovered children of a router.
*
* @param[in,out] aIterator The address iterator to use.
* @param[out] aChildInfo A pointer to return the child info (if any).
include/openthread/message.h
+15 -15
View File
@@ -53,13 +53,13 @@ extern "C" {
*/
/**
* This type is an opaque representation of an OpenThread message buffer.
* An opaque representation of an OpenThread message buffer.
*
*/
typedef struct otMessage otMessage;
/**
* This enumeration defines the OpenThread message priority levels.
* Defines the OpenThread message priority levels.
*
*/
typedef enum otMessagePriority
@@ -70,7 +70,7 @@ typedef enum otMessagePriority
} otMessagePriority;
/**
* This structure represents a message settings.
* Represents a message settings.
*
*/
typedef struct otMessageSettings
@@ -170,7 +170,7 @@ uint16_t otMessageGetOffset(const otMessage *aMessage);
void otMessageSetOffset(otMessage *aMessage, uint16_t aOffset);
/**
* This function indicates whether or not link security is enabled for the message.
* Indicates whether or not link security is enabled for the message.
*
* @param[in] aMessage A pointer to a message buffer.
*
@@ -181,7 +181,7 @@ void otMessageSetOffset(otMessage *aMessage, uint16_t aOffset);
bool otMessageIsLinkSecurityEnabled(const otMessage *aMessage);
/**
* This function sets/forces the message to be forwarded using direct transmission.
* Sets/forces the message to be forwarded using direct transmission.
* Default setting for a new message is `false`.
*
* @param[in] aMessage A pointer to a message buffer.
@@ -192,7 +192,7 @@ bool otMessageIsLinkSecurityEnabled(const otMessage *aMessage);
void otMessageSetDirectTransmission(otMessage *aMessage, bool aEnabled);
/**
* This function returns the average RSS (received signal strength) associated with the message.
* Returns the average RSS (received signal strength) associated with the message.
*
* @returns The average RSS value (in dBm) or OT_RADIO_RSSI_INVALID if no average RSS is available.
*
@@ -263,7 +263,7 @@ uint16_t otMessageRead(const otMessage *aMessage, uint16_t aOffset, void *aBuf,
int otMessageWrite(otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength);
/**
* This structure represents an OpenThread message queue.
* Represents an OpenThread message queue.
*/
typedef struct
{
@@ -271,7 +271,7 @@ typedef struct
} otMessageQueue;
/**
* This structure represents information about a message queue.
* Represents information about a message queue.
*
*/
typedef struct otMessageQueueInfo
@@ -282,7 +282,7 @@ typedef struct otMessageQueueInfo
} otMessageQueueInfo;
/**
* This structure represents the message buffer information for different queues used by OpenThread stack.
* Represents the message buffer information for different queues used by OpenThread stack.
*
*/
typedef struct otBufferInfo
@@ -310,7 +310,7 @@ typedef struct otBufferInfo
/**
* Initialize the message queue.
*
* This function MUST be called once and only once for a `otMessageQueue` instance before any other `otMessageQueue`
* MUST be called once and only once for a `otMessageQueue` instance before any other `otMessageQueue`
* functions. The behavior is undefined if other queue APIs are used with an `otMessageQueue` before it being
* initialized or if it is initialized more than once.
*
@@ -320,7 +320,7 @@ typedef struct otBufferInfo
void otMessageQueueInit(otMessageQueue *aQueue);
/**
* This function adds a message to the end of the given message queue.
* Adds a message to the end of the given message queue.
*
* @param[in] aQueue A pointer to the message queue.
* @param[in] aMessage The message to add.
@@ -329,7 +329,7 @@ void otMessageQueueInit(otMessageQueue *aQueue);
void otMessageQueueEnqueue(otMessageQueue *aQueue, otMessage *aMessage);
/**
* This function adds a message at the head/front of the given message queue.
* Adds a message at the head/front of the given message queue.
*
* @param[in] aQueue A pointer to the message queue.
* @param[in] aMessage The message to add.
@@ -338,7 +338,7 @@ void otMessageQueueEnqueue(otMessageQueue *aQueue, otMessage *aMessage);
void otMessageQueueEnqueueAtHead(otMessageQueue *aQueue, otMessage *aMessage);
/**
* This function removes a message from the given message queue.
* Removes a message from the given message queue.
*
* @param[in] aQueue A pointer to the message queue.
* @param[in] aMessage The message to remove.
@@ -347,7 +347,7 @@ void otMessageQueueEnqueueAtHead(otMessageQueue *aQueue, otMessage *aMessage);
void otMessageQueueDequeue(otMessageQueue *aQueue, otMessage *aMessage);
/**
* This function returns a pointer to the message at the head of the queue.
* Returns a pointer to the message at the head of the queue.
*
* @param[in] aQueue A pointer to a message queue.
*
@@ -357,7 +357,7 @@ void otMessageQueueDequeue(otMessageQueue *aQueue, otMessage *aMessage);
otMessage *otMessageQueueGetHead(otMessageQueue *aQueue);
/**
* This function returns a pointer to the next message in the queue by iterating forward (from head to tail).
* Returns a pointer to the next message in the queue by iterating forward (from head to tail).
*
* @param[in] aQueue A pointer to a message queue.
* @param[in] aMessage A pointer to current message buffer.
include/openthread/multi_radio.h
+4 -4
View File
@@ -52,7 +52,7 @@ extern "C" {
*/
/**
* This type represents information associated with a radio link.
* Represents information associated with a radio link.
*
*/
typedef struct otRadioLinkInfo
@@ -61,7 +61,7 @@ typedef struct otRadioLinkInfo
} otRadioLinkInfo;
/**
* This type represents multi radio link information associated with a neighbor.
* Represents multi radio link information associated with a neighbor.
*
*/
typedef struct otMultiRadioNeighborInfo
@@ -73,9 +73,9 @@ typedef struct otMultiRadioNeighborInfo
} otMultiRadioNeighborInfo;
/**
* This function gets the multi radio link information associated with a neighbor with a given Extended Address.
* Gets the multi radio link information associated with a neighbor with a given Extended Address.
*
* This function requires the multi radio link feature to be enabled (please see `config/radio_link.h`).
* Requires the multi radio link feature to be enabled (please see `config/radio_link.h`).
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aExtAddress The Extended Address of neighbor.
include/openthread/nat64.h
+6 -6
View File
@@ -57,7 +57,7 @@ extern "C" {
/**
* @struct otIp4Address
*
* This structure represents an IPv4 address.
* Represents an IPv4 address.
*
*/
OT_TOOL_PACKED_BEGIN
@@ -71,7 +71,7 @@ struct otIp4Address
} OT_TOOL_PACKED_END;
/**
* This structure represents an IPv4 address.
* Represents an IPv4 address.
*
*/
typedef struct otIp4Address otIp4Address;
@@ -79,7 +79,7 @@ typedef struct otIp4Address otIp4Address;
/**
* @struct otIp4Cidr
*
* This structure represents an IPv4 CIDR block.
* Represents an IPv4 CIDR block.
*
*/
typedef struct otIp4Cidr
@@ -317,7 +317,7 @@ otMessage *otIp4NewMessage(otInstance *aInstance, const otMessageSettings *aSett
/**
* Sets the CIDR used when setting the source address of the outgoing translated IPv4 packets.
*
* This function is available only when OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE is enabled.
* Is available only when OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE is enabled.
*
* @note A valid CIDR must have a non-zero prefix length. The actual addresses pool is limited by the size of the
* mapping pool and the number of addresses available in the CIDR block.
@@ -358,7 +358,7 @@ otError otNat64SetIp4Cidr(otInstance *aInstance, const otIp4Cidr *aCidr);
otError otNat64Send(otInstance *aInstance, otMessage *aMessage);
/**
* This function pointer is called when an IPv4 datagram (translated by NAT64 translator) is received.
* Pointer is called when an IPv4 datagram (translated by NAT64 translator) is received.
*
* @param[in] aMessage A pointer to the message buffer containing the received IPv6 datagram. This function transfers
* the ownership of the @p aMessage to the receiver of the callback. The message should be
@@ -436,7 +436,7 @@ void otIp4AddressToString(const otIp4Address *aAddress, char *aBuffer, uint16_t
#define OT_IP4_CIDR_STRING_SIZE 20 ///< Length of 000.000.000.000/00 plus a suffix NUL
/**
* This function converts a human-readable IPv4 CIDR string into a binary representation.
* Converts a human-readable IPv4 CIDR string into a binary representation.
*
* @param[in] aString A pointer to a NULL-terminated string.
* @param[out] aCidr A pointer to an IPv4 CIDR.
include/openthread/ncp.h
+5 -5
View File
@@ -55,7 +55,7 @@ extern "C" {
*/
/**
* This function pointer is called to send HDLC encoded NCP data.
* Pointer is called to send HDLC encoded NCP data.
*
* @param[in] aBuf A pointer to a buffer with an output.
* @param[in] aBufLength A length of the output data stored in the buffer.
@@ -66,13 +66,13 @@ extern "C" {
typedef int (*otNcpHdlcSendCallback)(const uint8_t *aBuf, uint16_t aBufLength);
/**
* This function is called after NCP send finished.
* Is called after NCP send finished.
*
*/
void otNcpHdlcSendDone(void);
/**
* This function is called after HDLC encoded NCP data received.
* Is called after HDLC encoded NCP data received.
*
* @param[in] aBuf A pointer to a buffer.
* @param[in] aBufLength The length of the data stored in the buffer.
@@ -100,7 +100,7 @@ void otNcpSpiInit(otInstance *aInstance);
/**
* @brief Send data to the host via a specific stream.
*
* This function attempts to send the given data to the host
* Attempts to send the given data to the host
* using the given aStreamId. This is useful for reporting
* error messages, implementing debug/diagnostic consoles,
* and potentially other types of datastreams.
@@ -149,7 +149,7 @@ void otNcpPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFo
typedef bool (*otNcpDelegateAllowPeekPoke)(uint32_t aAddress, uint16_t aCount);
/**
* This method registers peek/poke delegate functions with NCP module.
* Registers peek/poke delegate functions with NCP module.
*
* The delegate functions are called by NCP module to decide whether to allow peek or poke of a specific memory region.
* If the delegate pointer is set to NULL, it allows peek/poke operation for any address.
include/openthread/netdata.h
+5 -5
View File
@@ -53,7 +53,7 @@ extern "C" {
typedef uint32_t otNetworkDataIterator; ///< Used to iterate through Network Data information.
/**
* This structure represents a Border Router configuration.
* Represents a Border Router configuration.
*/
typedef struct otBorderRouterConfig
{
@@ -72,7 +72,7 @@ typedef struct otBorderRouterConfig
} otBorderRouterConfig;
/**
* This structure represents 6LoWPAN Context ID information associated with a prefix in Network Data.
* Represents 6LoWPAN Context ID information associated with a prefix in Network Data.
*
*/
typedef struct otLowpanContextInfo
@@ -83,7 +83,7 @@ typedef struct otLowpanContextInfo
} otLowpanContextInfo;
/**
* This structure represents an External Route configuration.
* Represents an External Route configuration.
*
*/
typedef struct otExternalRouteConfig
@@ -111,7 +111,7 @@ typedef enum otRoutePreference
#define OT_SERVER_DATA_MAX_SIZE 248 ///< Max size of Server Data in bytes. Theoretical limit, practically much lower.
/**
* This structure represents a Server configuration.
* Represents a Server configuration.
*
*/
typedef struct otServerConfig
@@ -123,7 +123,7 @@ typedef struct otServerConfig
} otServerConfig;
/**
* This structure represents a Service configuration.
* Represents a Service configuration.
*
*/
typedef struct otServiceConfig
include/openthread/netdata_publisher.h
+24 -24
View File
@@ -55,7 +55,7 @@ extern "C" {
*/
/**
* This enumeration represents the events reported from the Publisher callbacks.
* Represents the events reported from the Publisher callbacks.
*
*/
typedef enum otNetDataPublisherEvent
@@ -65,7 +65,7 @@ typedef enum otNetDataPublisherEvent
} otNetDataPublisherEvent;
/**
* This function pointer type defines the callback used to notify when a "DNS/SRP Service" entry is added to or removed
* Pointer type defines the callback used to notify when a "DNS/SRP Service" entry is added to or removed
* from the Thread Network Data.
*
* On remove the callback is invoked independent of whether the entry is removed by `Publisher` (e.g., when there are
@@ -79,7 +79,7 @@ typedef enum otNetDataPublisherEvent
typedef void (*otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext);
/**
* This function pointer type defines the callback used to notify when a prefix (on-mesh or external route) entry is
* Pointer type defines the callback used to notify when a prefix (on-mesh or external route) entry is
* added to or removed from the Thread Network Data.
*
* On remove the callback is invoked independent of whether the entry is removed by `Publisher` (e.g., when there are
@@ -95,9 +95,9 @@ typedef void (*otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent,
void *aContext);
/**
* This function requests "DNS/SRP Service Anycast Address" to be published in the Thread Network Data.
* Requests "DNS/SRP Service Anycast Address" to be published in the Thread Network Data.
*
* This function requires the feature `OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE` to be enabled.
* Requires the feature `OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE` to be enabled.
*
* A call to this function will remove and replace any previous "DNS/SRP Service" entry that was being published (from
* earlier call to any of `otNetDataPublishDnsSrpService{Type}()` functions).
@@ -109,14 +109,14 @@ typedef void (*otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent,
void otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber);
/**
* This function requests "DNS/SRP Service Unicast Address" to be published in the Thread Network Data.
* Requests "DNS/SRP Service Unicast Address" to be published in the Thread Network Data.
*
* This function requires the feature `OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE` to be enabled.
* Requires the feature `OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE` to be enabled.
*
* A call to this function will remove and replace any previous "DNS/SRP Service" entry that was being published (from
* earlier call to any of `otNetDataPublishDnsSrpService{Type}()` functions).
*
* This function publishes the "DNS/SRP Service Unicast Address" by including the address and port info in the Service
* Publishes the "DNS/SRP Service Unicast Address" by including the address and port info in the Service
* TLV data.
*
* @param[in] aInstance A pointer to an OpenThread instance.
@@ -127,9 +127,9 @@ void otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequen
void otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort);
/**
* This function requests "DNS/SRP Service Unicast Address" to be published in the Thread Network Data.
* Requests "DNS/SRP Service Unicast Address" to be published in the Thread Network Data.
*
* This function requires the feature `OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE` to be enabled.
* Requires the feature `OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE` to be enabled.
*
* A call to this function will remove and replace any previous "DNS/SRP Service" entry that was being published (from
* earlier call to any of `otNetDataPublishDnsSrpService{Type}()` functions).
@@ -145,9 +145,9 @@ void otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Addr
void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort);
/**
* This function indicates whether or not currently the "DNS/SRP Service" entry is added to the Thread Network Data.
* Indicates whether or not currently the "DNS/SRP Service" entry is added to the Thread Network Data.
*
* This function requires the feature `OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE` to be enabled.
* Requires the feature `OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE` to be enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -158,12 +158,12 @@ void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uin
bool otNetDataIsDnsSrpServiceAdded(otInstance *aInstance);
/**
* This function sets a callback for notifying when a published "DNS/SRP Service" is actually added to or removed from
* Sets a callback for notifying when a published "DNS/SRP Service" is actually added to or removed from
* the Thread Network Data.
*
* A subsequent call to this function replaces any previously set callback function.
*
* This function requires the feature `OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE` to be enabled.
* Requires the feature `OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE` to be enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aCallback The callback function pointer (can be NULL if not needed).
@@ -186,9 +186,9 @@ void otNetDataSetDnsSrpServicePublisherCallback(otInstance
void otNetDataUnpublishDnsSrpService(otInstance *aInstance);
/**
* This function requests an on-mesh prefix to be published in the Thread Network Data.
* Requests an on-mesh prefix to be published in the Thread Network Data.
*
* This function requires the feature `OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE` to be enabled.
* Requires the feature `OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE` to be enabled.
*
* Only stable entries can be published (i.e.,`aConfig.mStable` MUST be TRUE).
*
@@ -213,9 +213,9 @@ void otNetDataUnpublishDnsSrpService(otInstance *aInstance);
otError otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig);
/**
* This function requests an external route prefix to be published in the Thread Network Data.
* Requests an external route prefix to be published in the Thread Network Data.
*
* This function requires the feature `OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE` to be enabled.
* Requires the feature `OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE` to be enabled.
*
* Only stable entries can be published (i.e.,`aConfig.mStable` MUST be TRUE).
*
@@ -238,9 +238,9 @@ otError otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouter
otError otNetDataPublishExternalRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig);
/**
* This function replaces a previously published external route in the Thread Network Data.
* Replaces a previously published external route in the Thread Network Data.
*
* This function requires the feature `OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE` to be enabled.
* Requires the feature `OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE` to be enabled.
*
* If there is no previously published external route matching @p aPrefix, this function behaves similarly to
* `otNetDataPublishExternalRoute()`, i.e., it will start the process of publishing @a aConfig as an external route in
@@ -274,10 +274,10 @@ otError otNetDataReplacePublishedExternalRoute(otInstance *aIns
const otExternalRouteConfig *aConfig);
/**
* This function indicates whether or not currently a published prefix entry (on-mesh or external route) is added to
* Indicates whether or not currently a published prefix entry (on-mesh or external route) is added to
* the Thread Network Data.
*
* This function requires the feature `OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE` to be enabled.
* Requires the feature `OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE` to be enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aPrefix A pointer to the prefix (MUST NOT be NULL).
@@ -289,12 +289,12 @@ otError otNetDataReplacePublishedExternalRoute(otInstance *aIns
bool otNetDataIsPrefixAdded(otInstance *aInstance, const otIp6Prefix *aPrefix);
/**
* This function sets a callback for notifying when a published prefix entry is actually added to or removed from
* Sets a callback for notifying when a published prefix entry is actually added to or removed from
* the Thread Network Data.
*
* A subsequent call to this function replaces any previously set callback function.
*
* This function requires the feature `OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE` to be enabled.
* Requires the feature `OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE` to be enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aCallback The callback function pointer (can be NULL if not needed).
include/openthread/netdiag.h
+8 -8
View File
@@ -97,7 +97,7 @@ enum
typedef uint16_t otNetworkDiagIterator; ///< Used to iterate through Network Diagnostic TLV.
/**
* This structure represents a Network Diagnostic Connectivity value.
* Represents a Network Diagnostic Connectivity value.
*
*/
typedef struct otNetworkDiagConnectivity
@@ -149,7 +149,7 @@ typedef struct otNetworkDiagConnectivity
} otNetworkDiagConnectivity;
/**
* This structure represents a Network Diagnostic Route data.
* Represents a Network Diagnostic Route data.
*
*/
typedef struct otNetworkDiagRouteData
@@ -161,7 +161,7 @@ typedef struct otNetworkDiagRouteData
} otNetworkDiagRouteData;
/**
* This structure represents a Network Diagnostic Route TLV value.
* Represents a Network Diagnostic Route TLV value.
*
*/
typedef struct otNetworkDiagRoute
@@ -183,7 +183,7 @@ typedef struct otNetworkDiagRoute
} otNetworkDiagRoute;
/**
* This structure represents a Network Diagnostic Mac Counters value.
* Represents a Network Diagnostic Mac Counters value.
*
* See <a href="https://www.ietf.org/rfc/rfc2863">RFC 2863</a> for definitions of member fields.
*
@@ -202,7 +202,7 @@ typedef struct otNetworkDiagMacCounters
} otNetworkDiagMacCounters;
/**
* This structure represents a Network Diagnostic Child Table Entry.
* Represents a Network Diagnostic Child Table Entry.
*
*/
typedef struct otNetworkDiagChildEntry
@@ -232,7 +232,7 @@ typedef struct otNetworkDiagChildEntry
} otNetworkDiagChildEntry;
/**
* This structure represents a Network Diagnostic TLV.
* Represents a Network Diagnostic TLV.
*
*/
typedef struct otNetworkDiagTlv
@@ -285,7 +285,7 @@ typedef struct otNetworkDiagTlv
} otNetworkDiagTlv;
/**
* This function gets the next Network Diagnostic TLV in the message.
* Gets the next Network Diagnostic TLV in the message.
*
* Requires `OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE`.
*
@@ -306,7 +306,7 @@ otError otThreadGetNextDiagnosticTlv(const otMessage *aMessage,
otNetworkDiagTlv *aNetworkDiagTlv);
/**
* This function pointer is called when Network Diagnostic Get response is received.
* Pointer is called when Network Diagnostic Get response is received.
*
* @param[in] aError The error when failed to get the response.
* @param[in] aMessage A pointer to the message buffer containing the received Network Diagnostic
include/openthread/network_time.h
+4 -4
View File
@@ -53,7 +53,7 @@ extern "C" {
*/
/**
* This enumeration represents OpenThread time synchronization status.
* Represents OpenThread time synchronization status.
*
*/
typedef enum otNetworkTimeStatus
@@ -64,7 +64,7 @@ typedef enum otNetworkTimeStatus
} otNetworkTimeStatus;
/**
* This function pointer is called when a network time sync or status change occurs.
* Pointer is called when a network time sync or status change occurs.
*
*/
typedef void (*otNetworkTimeSyncCallbackFn)(void *aCallbackContext);
@@ -89,7 +89,7 @@ otNetworkTimeStatus otNetworkTimeGet(otInstance *aInstance, uint64_t *aNetworkTi
/**
* Set the time synchronization period.
*
* This function can only be called while Thread protocols are disabled.
* Can only be called while Thread protocols are disabled.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aTimeSyncPeriod The time synchronization period, in seconds.
@@ -113,7 +113,7 @@ uint16_t otNetworkTimeGetSyncPeriod(otInstance *aInstance);
/**
* Set the time synchronization XTAL accuracy threshold for Router-Capable device.
*
* This function can only be called while Thread protocols are disabled.
* Can only be called while Thread protocols are disabled.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aXTALThreshold The XTAL accuracy threshold for Router, in PPM.
include/openthread/ping_sender.h
+7 -7
View File
@@ -56,7 +56,7 @@ extern "C" {
*/
/**
* This structure represents a ping reply.
* Represents a ping reply.
*
*/
typedef struct otPingSenderReply
@@ -69,7 +69,7 @@ typedef struct otPingSenderReply
} otPingSenderReply;
/**
* This structure represents statistics of a ping request.
* Represents statistics of a ping request.
*
*/
typedef struct otPingSenderStatistics
@@ -83,7 +83,7 @@ typedef struct otPingSenderStatistics
} otPingSenderStatistics;
/**
* This function pointer type specifies the callback to notify receipt of a ping reply.
* Pointer type specifies the callback to notify receipt of a ping reply.
*
* @param[in] aReply A pointer to a `otPingSenderReply` containing info about the received ping reply.
* @param[in] aContext A pointer to application-specific context.
@@ -92,7 +92,7 @@ typedef struct otPingSenderStatistics
typedef void (*otPingSenderReplyCallback)(const otPingSenderReply *aReply, void *aContext);
/**
* This function pointer type specifies the callback to report the ping statistics.
* Pointer type specifies the callback to report the ping statistics.
*
* @param[in] aStatistics A pointer to a `otPingSenderStatistics` containing info about the received ping
* statistics.
@@ -102,7 +102,7 @@ typedef void (*otPingSenderReplyCallback)(const otPingSenderReply *aReply, void
typedef void (*otPingSenderStatisticsCallback)(const otPingSenderStatistics *aStatistics, void *aContext);
/**
* This structure represents a ping request configuration.
* Represents a ping request configuration.
*
*/
typedef struct otPingSenderConfig
@@ -123,7 +123,7 @@ typedef struct otPingSenderConfig
} otPingSenderConfig;
/**
* This function starts a ping.
* Starts a ping.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aConfig The ping config to use.
@@ -137,7 +137,7 @@ typedef struct otPingSenderConfig
otError otPingSenderPing(otInstance *aInstance, const otPingSenderConfig *aConfig);
/**
* This function stops an ongoing ping.
* Stops an ongoing ping.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
include/openthread/platform/crypto.h
+13 -13
View File
@@ -55,7 +55,7 @@ extern "C" {
*/
/**
* This enumeration defines the key types.
* Defines the key types.
*
*/
typedef enum
@@ -67,7 +67,7 @@ typedef enum
} otCryptoKeyType;
/**
* This enumeration defines the key algorithms.
* Defines the key algorithms.
*
*/
typedef enum
@@ -79,7 +79,7 @@ typedef enum
} otCryptoKeyAlgorithm;
/**
* This enumeration defines the key usage flags.
* Defines the key usage flags.
*
*/
enum
@@ -93,7 +93,7 @@ enum
};
/**
* This enumeration defines the key storage types.
* Defines the key storage types.
*
*/
typedef enum
@@ -111,7 +111,7 @@ typedef uint32_t otCryptoKeyRef;
/**
* @struct otCryptoKey
*
* This structure represents the Key Material required for Crypto operations.
* Represents the Key Material required for Crypto operations.
*
*/
typedef struct otCryptoKey
@@ -124,7 +124,7 @@ typedef struct otCryptoKey
/**
* @struct otCryptoContext
*
* This structure stores the context object for platform APIs.
* Stores the context object for platform APIs.
*
*/
typedef struct otCryptoContext
@@ -142,7 +142,7 @@ typedef struct otCryptoContext
/**
* @struct otPlatCryptoSha256Hash
*
* This structure represents a SHA-256 hash.
* Represents a SHA-256 hash.
*
*/
OT_TOOL_PACKED_BEGIN
@@ -152,7 +152,7 @@ struct otPlatCryptoSha256Hash
} OT_TOOL_PACKED_END;
/**
* This structure represents a SHA-256 hash.
* Represents a SHA-256 hash.
*
*/
typedef struct otPlatCryptoSha256Hash otPlatCryptoSha256Hash;
@@ -166,7 +166,7 @@ typedef struct otPlatCryptoSha256Hash otPlatCryptoSha256Hash;
/**
* @struct otPlatCryptoEcdsaKeyPair
*
* This structure represents an ECDSA key pair (public and private keys).
* Represents an ECDSA key pair (public and private keys).
*
* The key pair is stored using Distinguished Encoding Rules (DER) format (per RFC 5915).
*
@@ -186,7 +186,7 @@ typedef struct otPlatCryptoEcdsaKeyPair
/**
* @struct otPlatCryptoEcdsaPublicKey
*
* This struct represents a ECDSA public key.
* Represents a ECDSA public key.
*
* The public key is stored as a byte sequence representation of an uncompressed curve point (RFC 6605 - sec 4).
*
@@ -208,7 +208,7 @@ typedef struct otPlatCryptoEcdsaPublicKey otPlatCryptoEcdsaPublicKey;
/**
* @struct otPlatCryptoEcdsaSignature
*
* This struct represents an ECDSA signature.
* Represents an ECDSA signature.
*
* The signature is encoded as the concatenated binary representation of two MPIs `r` and `s` which are calculated
* during signing (RFC 6605 - section 4).
@@ -616,7 +616,7 @@ otError otPlatCryptoEcdsaGetPublicKey(const otPlatCryptoEcdsaKeyPair *aKeyPair,
/**
* Calculate the ECDSA signature for a hashed message using the private key from the input context.
*
* This method uses the deterministic digital signature generation procedure from RFC 6979.
* Uses the deterministic digital signature generation procedure from RFC 6979.
*
* @param[in] aKeyPair A pointer to an ECDSA key-pair structure where the key-pair is stored.
* @param[in] aHash A pointer to a SHA-256 hash structure where the hash value for signature calculation
@@ -656,7 +656,7 @@ otError otPlatCryptoEcdsaVerify(const otPlatCryptoEcdsaPublicKey *aPublicKey,
/**
* Calculate the ECDSA signature for a hashed message using the Key reference passed.
*
* This method uses the deterministic digital signature generation procedure from RFC 6979.
* Uses the deterministic digital signature generation procedure from RFC 6979.
*
* @param[in] aKeyRef Key Reference to the slot where the key-pair is stored.
* @param[in] aHash A pointer to a SHA-256 hash structure where the hash value for signature calculation
include/openthread/platform/debug_uart.h
+3 -3
View File
@@ -104,7 +104,7 @@ void otPlatDebugUart_vprintf(const char *fmt, va_list ap);
* Platform specific write single byte to Debug Uart
* This should not perform CR/LF mapping.
*
* This function MUST be implemented by the platform
* MUST be implemented by the platform
*
* @param[in] c what to transmit
*/
@@ -114,7 +114,7 @@ void otPlatDebugUart_putchar_raw(int c);
* Poll/test debug uart if a key has been pressed.
* It would be common to a stub function that returns 0.
*
* This function MUST be implemented by the platform
* MUST be implemented by the platform
*
* @retval zero - nothing ready
* @retval nonzero - otPlatDebugUart_getc() will succeed.
@@ -124,7 +124,7 @@ int otPlatDebugUart_kbhit(void);
/**
* Poll/Read a byte from the debug uart
*
* This function MUST be implemented by the platform
* MUST be implemented by the platform
*
* @retval (negative) no data available, see otPlatDebugUart_kbhit()
* @retval (0x00..0x0ff) data byte value
include/openthread/platform/diag.h
+12 -12
View File
@@ -57,7 +57,7 @@ extern "C" {
*/
/**
* This enumeration defines the gpio modes.
* Defines the gpio modes.
*
*/
typedef enum
@@ -67,7 +67,7 @@ typedef enum
} otGpioMode;
/**
* This function processes a factory diagnostics command line.
* Processes a factory diagnostics command line.
*
* The output of this function (the content written to @p aOutput) MUST terminate with `\0` and the `\0` is within the
* output buffer.
@@ -90,7 +90,7 @@ otError otPlatDiagProcess(otInstance *aInstance,
size_t aOutputMaxLen);
/**
* This function enables/disables the factory diagnostics mode.
* Enables/disables the factory diagnostics mode.
*
* @param[in] aMode TRUE to enable diagnostics mode, FALSE otherwise.
*
@@ -98,7 +98,7 @@ otError otPlatDiagProcess(otInstance *aInstance,
void otPlatDiagModeSet(bool aMode);
/**
* This function indicates whether or not factory diagnostics mode is enabled.
* Indicates whether or not factory diagnostics mode is enabled.
*
* @returns TRUE if factory diagnostics mode is enabled, FALSE otherwise.
*
@@ -106,7 +106,7 @@ void otPlatDiagModeSet(bool aMode);
bool otPlatDiagModeGet(void);
/**
* This function sets the channel to use for factory diagnostics.
* Sets the channel to use for factory diagnostics.
*
* @param[in] aChannel The channel value.
*
@@ -114,7 +114,7 @@ bool otPlatDiagModeGet(void);
void otPlatDiagChannelSet(uint8_t aChannel);
/**
* This function sets the transmit power to use for factory diagnostics.
* Sets the transmit power to use for factory diagnostics.
*
* @param[in] aTxPower The transmit power value.
*
@@ -122,7 +122,7 @@ void otPlatDiagChannelSet(uint8_t aChannel);
void otPlatDiagTxPowerSet(int8_t aTxPower);
/**
* This function processes the received radio frame.
* Processes the received radio frame.
*
* @param[in] aInstance The OpenThread instance for current request.
* @param[in] aFrame The received radio frame.
@@ -132,7 +132,7 @@ void otPlatDiagTxPowerSet(int8_t aTxPower);
void otPlatDiagRadioReceived(otInstance *aInstance, otRadioFrame *aFrame, otError aError);
/**
* This function processes the alarm event.
* Processes the alarm event.
*
* @param[in] aInstance The OpenThread instance for current request.
*
@@ -140,7 +140,7 @@ void otPlatDiagRadioReceived(otInstance *aInstance, otRadioFrame *aFrame, otErro
void otPlatDiagAlarmCallback(otInstance *aInstance);
/**
* This function sets the gpio value.
* Sets the gpio value.
*
* @param[in] aGpio The gpio number.
* @param[in] aValue true to set the gpio to high level, or false otherwise.
@@ -155,7 +155,7 @@ void otPlatDiagAlarmCallback(otInstance *aInstance);
otError otPlatDiagGpioSet(uint32_t aGpio, bool aValue);
/**
* This function gets the gpio value.
* Gets the gpio value.
*
* @param[in] aGpio The gpio number.
* @param[out] aValue A pointer where to put gpio value.
@@ -170,7 +170,7 @@ otError otPlatDiagGpioSet(uint32_t aGpio, bool aValue);
otError otPlatDiagGpioGet(uint32_t aGpio, bool *aValue);
/**
* This function sets the gpio mode.
* Sets the gpio mode.
*
* @param[in] aGpio The gpio number.
* @param[out] aMode The gpio mode.
@@ -185,7 +185,7 @@ otError otPlatDiagGpioGet(uint32_t aGpio, bool *aValue);
otError otPlatDiagGpioSetMode(uint32_t aGpio, otGpioMode aMode);
/**
* This function gets the gpio mode.
* Gets the gpio mode.
*
* @param[in] aGpio The gpio number.
* @param[out] aMode A pointer where to put gpio mode.
include/openthread/platform/dso_transport.h
+15 -15
View File
@@ -47,7 +47,7 @@ extern "C" {
#endif
/**
* This structure represents a DSO connection.
* Represents a DSO connection.
*
* It is an opaque struct (the platform implementation only deals with pointers to this struct).
*
@@ -55,7 +55,7 @@ extern "C" {
typedef struct otPlatDsoConnection otPlatDsoConnection;
/**
* This function can be used by DSO platform implementation to get the the OpenThread instance associated with a
* Can be used by DSO platform implementation to get the the OpenThread instance associated with a
* connection instance.
*
* @param[in] aConnection A pointer to the DSO connection.
@@ -66,7 +66,7 @@ typedef struct otPlatDsoConnection otPlatDsoConnection;
extern otInstance *otPlatDsoGetInstance(otPlatDsoConnection *aConnection);
/**
* This function starts or stops listening for incoming connection requests on transport layer.
* Starts or stops listening for incoming connection requests on transport layer.
*
* For DNS-over-TLS, the transport layer MUST listen on port 853 and follow RFC 7858.
*
@@ -79,10 +79,10 @@ extern otInstance *otPlatDsoGetInstance(otPlatDsoConnection *aConnection);
void otPlatDsoEnableListening(otInstance *aInstance, bool aEnable);
/**
* This function is a callback from the DSO platform to indicate an incoming connection request when listening is
* Is a callback from the DSO platform to indicate an incoming connection request when listening is
* enabled.
*
* This function determines whether or not to accept the connection request. It returns a non-null `otPlatDsoConnection`
* Determines whether or not to accept the connection request. It returns a non-null `otPlatDsoConnection`
* pointer if the request is to be accepted, or `NULL` if the request is to be rejected.
*
* If a non-null connection pointer is returned, the platform layer MUST continue establishing the connection with the
@@ -98,7 +98,7 @@ void otPlatDsoEnableListening(otInstance *aInstance, bool aEnable);
extern otPlatDsoConnection *otPlatDsoAccept(otInstance *aInstance, const otSockAddr *aPeerSockAddr);
/**
* This function requests the platform layer to initiate establishing a connection with a peer.
* Requests the platform layer to initiate establishing a connection with a peer.
*
* The platform reports the outcome by invoking `otPlatDsoHandleConnected()` callback on success or
* `otPlatDsoHandleDisconnected()` callback (on failure).
@@ -110,7 +110,7 @@ extern otPlatDsoConnection *otPlatDsoAccept(otInstance *aInstance, const otSockA
void otPlatDsoConnect(otPlatDsoConnection *aConnection, const otSockAddr *aPeerSockAddr);
/**
* This function is a callback from the platform layer to indicate that a connection is successfully established.
* Is a callback from the platform layer to indicate that a connection is successfully established.
*
* It MUST be called either after accepting an incoming connection (`otPlatDsoAccept`) or after a `otPlatDsoConnect()`
* call.
@@ -123,12 +123,12 @@ void otPlatDsoConnect(otPlatDsoConnection *aConnection, const otSockAddr *aPeerS
extern void otPlatDsoHandleConnected(otPlatDsoConnection *aConnection);
/**
* This function sends a DSO message to the peer on a connection.
* Sends a DSO message to the peer on a connection.
*
* This function is used only after the connection is successfully established (after `otPlatDsoHandleConnected()`
* Is used only after the connection is successfully established (after `otPlatDsoHandleConnected()`
* callback).
*
* This function passes the ownership of the @p aMessage to the DSO platform layer, and the platform implementation is
* Passes the ownership of the @p aMessage to the DSO platform layer, and the platform implementation is
* expected to free the message once it is no longer needed.
*
* The @p aMessage contains the DNS message (starting with DNS header). Note that it does not contain the the length
@@ -142,12 +142,12 @@ extern void otPlatDsoHandleConnected(otPlatDsoConnection *aConnection);
void otPlatDsoSend(otPlatDsoConnection *aConnection, otMessage *aMessage);
/**
* This function is a callback from the platform layer to indicate that a DNS message was received over a connection.
* Is a callback from the platform layer to indicate that a DNS message was received over a connection.
*
* The platform MUST call this function only after the connection is successfully established (after callback
* `otPlatDsoHandleConnected()` is invoked).
*
* This function passes the ownership of the @p aMessage from the DSO platform layer to OpenThread. OpenThread will
* Passes the ownership of the @p aMessage from the DSO platform layer to OpenThread. OpenThread will
* free the message when no longer needed.
*
* The @p aMessage MUST contain the DNS message (starting with DNS header) and not include the length field that may
@@ -160,7 +160,7 @@ void otPlatDsoSend(otPlatDsoConnection *aConnection, otMessage *aMessage);
extern void otPlatDsoHandleReceive(otPlatDsoConnection *aConnection, otMessage *aMessage);
/**
* This enumeration defines disconnect modes.
* Defines disconnect modes.
*
*/
typedef enum
@@ -170,7 +170,7 @@ typedef enum
} otPlatDsoDisconnectMode;
/**
* This function requests a connection to be disconnected.
* Requests a connection to be disconnected.
*
* After calling this function, the DSO platform implementation MUST NOT maintain `aConnection` pointer (platform
* MUST NOT call any callbacks using this `Connection` pointer anymore). In particular, calling `otPlatDsoDisconnect()`
@@ -183,7 +183,7 @@ typedef enum
void otPlatDsoDisconnect(otPlatDsoConnection *aConnection, otPlatDsoDisconnectMode aMode);
/**
* This function is a callback from the platform layer to indicate that peer closed/aborted the connection or the
* Is a callback from the platform layer to indicate that peer closed/aborted the connection or the
* connection establishment failed (e.g., peer rejected a connection request).
*
* After calling this function, the DSO platform implementation MUST NOT maintain `aConnection` pointer (platform
include/openthread/platform/entropy.h
+1 -1
View File
@@ -56,7 +56,7 @@ extern "C" {
/**
* Fill buffer with entropy.
*
* This function MUST be implemented using a true random number generator (TRNG).
* MUST be implemented using a true random number generator (TRNG).
*
* @param[out] aOutput A pointer to where the true random values are placed. Must not be NULL.
* @param[in] aOutputLength Size of @p aBuffer.
include/openthread/platform/flash.h
+5 -5
View File
@@ -38,7 +38,7 @@ extern "C" {
#endif
/**
* This function initializes the flash driver.
* Initializes the flash driver.
*
* @param[in] aInstance The OpenThread instance structure.
*
@@ -46,7 +46,7 @@ extern "C" {
void otPlatFlashInit(otInstance *aInstance);
/**
* This function gets the size of the swap space.
* Gets the size of the swap space.
*
* @param[in] aInstance The OpenThread instance structure.
*
@@ -56,7 +56,7 @@ void otPlatFlashInit(otInstance *aInstance);
uint32_t otPlatFlashGetSwapSize(otInstance *aInstance);
/**
* This function erases the swap space indicated by @p aSwapIndex.
* Erases the swap space indicated by @p aSwapIndex.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aSwapIndex A value in [0, 1] that indicates the swap space.
@@ -65,7 +65,7 @@ uint32_t otPlatFlashGetSwapSize(otInstance *aInstance);
void otPlatFlashErase(otInstance *aInstance, uint8_t aSwapIndex);
/**
* This function reads @p aSize bytes into @p aData.
* Reads @p aSize bytes into @p aData.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aSwapIndex A value in [0, 1] that indicates the swap space.
@@ -77,7 +77,7 @@ void otPlatFlashErase(otInstance *aInstance, uint8_t aSwapIndex);
void otPlatFlashRead(otInstance *aInstance, uint8_t aSwapIndex, uint32_t aOffset, void *aData, uint32_t aSize);
/**
* This function writes @p aSize bytes from @p aData.
* Writes @p aSize bytes from @p aData.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aSwapIndex A value in [0, 1] that indicates the swap space.
include/openthread/platform/infra_if.h
+3 -3
View File
@@ -57,7 +57,7 @@ extern "C" {
*/
/**
* This method tells whether an infra interface has the given IPv6 address assigned.
* Tells whether an infra interface has the given IPv6 address assigned.
*
* @param[in] aInfraIfIndex The index of the infra interface.
* @param[in] aAddress The IPv6 address.
@@ -68,7 +68,7 @@ extern "C" {
bool otPlatInfraIfHasAddress(uint32_t aInfraIfIndex, const otIp6Address *aAddress);
/**
* This method sends an ICMPv6 Neighbor Discovery message on given infrastructure interface.
* Sends an ICMPv6 Neighbor Discovery message on given infrastructure interface.
*
* See RFC 4861: https://tools.ietf.org/html/rfc4861.
*
@@ -150,7 +150,7 @@ otError otPlatInfraIfDiscoverNat64Prefix(uint32_t aInfraIfIndex);
* The infra interface driver calls this method to notify OpenThread that
* the discovery of NAT64 prefix is done.
*
* This method is expected to be invoked after calling otPlatInfraIfDiscoverNat64Prefix.
* Is expected to be invoked after calling otPlatInfraIfDiscoverNat64Prefix.
* If no NAT64 prefix is discovered, @p aIp6Prefix shall point to an empty prefix with zero length.
*
* @param[in] aInstance The OpenThread instance structure.
include/openthread/platform/logging.h
+4 -4
View File
@@ -107,13 +107,13 @@ extern "C" {
#define OT_LOG_LEVEL_DEBG 5
/**
* This type represents the log level.
* Represents the log level.
*
*/
typedef int otLogLevel;
/**
* This enumeration represents log regions.
* Represents log regions.
*
* The support for log region is removed and instead each core module can define its own name to appended to the logs.
* However, the `otLogRegion` enumeration is still defined as before to help with platforms which we may be using it
@@ -148,7 +148,7 @@ typedef enum otLogRegion
} otLogRegion;
/**
* This function outputs logs.
* Outputs logs.
*
* Note that the support for log region is removed. The OT core will always emit all logs with `OT_LOG_REGION_CORE`
* as @p aLogRegion.
@@ -162,7 +162,7 @@ typedef enum otLogRegion
void otPlatLog(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, ...);
/**
* This function handles OpenThread log level changes.
* Handles OpenThread log level changes.
*
* This platform function is called whenever the OpenThread log level changes.
* This platform function is optional since an empty weak implementation has been provided.
include/openthread/platform/memory.h
+2 -2
View File
@@ -63,7 +63,7 @@ extern "C" {
* memory each and returns a pointer to the allocated memory. The allocated memory is filled with bytes
* of value zero."
*
* This function is required for OPENTHREAD_CONFIG_HEAP_EXTERNAL_ENABLE.
* Is required for OPENTHREAD_CONFIG_HEAP_EXTERNAL_ENABLE.
*
* @param[in] aNum The number of blocks to allocate
* @param[in] aSize The size of each block to allocate
@@ -76,7 +76,7 @@ void *otPlatCAlloc(size_t aNum, size_t aSize);
/**
* Frees memory that was dynamically allocated.
*
* This function is required for OPENTHREAD_CONFIG_HEAP_EXTERNAL_ENABLE.
* Is required for OPENTHREAD_CONFIG_HEAP_EXTERNAL_ENABLE.
*
* @param[in] aPtr A pointer the memory blocks to free. The pointer may be NULL.
*/
include/openthread/platform/messagepool.h
+6 -6
View File
@@ -54,7 +54,7 @@ extern "C" {
#endif
/**
* This struct represents an OpenThread message buffer.
* Represents an OpenThread message buffer.
*
*/
typedef struct otMessageBuffer
@@ -65,7 +65,7 @@ typedef struct otMessageBuffer
/**
* Initialize the platform implemented message pool.
*
* This function is used when `OPENTHREAD_CONFIG_PLATFORM_MESSAGE_MANAGEMENT` is enabled.
* Is used when `OPENTHREAD_CONFIG_PLATFORM_MESSAGE_MANAGEMENT` is enabled.
*
* @param[in] aInstance A pointer to the OpenThread instance.
* @param[in] aMinNumFreeBuffers An uint16 containing the minimum number of free buffers desired by OpenThread.
@@ -77,7 +77,7 @@ void otPlatMessagePoolInit(otInstance *aInstance, uint16_t aMinNumFreeBuffers, s
/**
* Allocate a buffer from the platform managed buffer pool.
*
* This function is used when `OPENTHREAD_CONFIG_PLATFORM_MESSAGE_MANAGEMENT` is enabled.
* Is used when `OPENTHREAD_CONFIG_PLATFORM_MESSAGE_MANAGEMENT` is enabled.
*
* The returned buffer instance MUST have at least `aBufferSize` bytes (as specified in `otPlatMessagePoolInit()`).
*
@@ -89,9 +89,9 @@ void otPlatMessagePoolInit(otInstance *aInstance, uint16_t aMinNumFreeBuffers, s
otMessageBuffer *otPlatMessagePoolNew(otInstance *aInstance);
/**
* This function is used to free a buffer back to the platform managed buffer pool.
* Is used to free a buffer back to the platform managed buffer pool.
*
* This function is used when `OPENTHREAD_CONFIG_PLATFORM_MESSAGE_MANAGEMENT` is enabled.
* Is used when `OPENTHREAD_CONFIG_PLATFORM_MESSAGE_MANAGEMENT` is enabled.
*
* @param[in] aInstance A pointer to the OpenThread instance.
* @param[in] aBuffer The buffer to free.
@@ -102,7 +102,7 @@ void otPlatMessagePoolFree(otInstance *aInstance, otMessageBuffer *aBuffer);
/**
* Get the number of free buffers.
*
* This function is used when `OPENTHREAD_CONFIG_PLATFORM_MESSAGE_MANAGEMENT` is enabled.
* Is used when `OPENTHREAD_CONFIG_PLATFORM_MESSAGE_MANAGEMENT` is enabled.
*
* @param[in] aInstance A pointer to the OpenThread instance.
*
include/openthread/platform/misc.h
+6 -6
View File
@@ -54,7 +54,7 @@ extern "C" {
*/
/**
* This function performs a software reset on the platform, if supported.
* Performs a software reset on the platform, if supported.
*
* @param[in] aInstance The OpenThread instance structure.
*
@@ -83,7 +83,7 @@ typedef enum
} otPlatResetReason;
/**
* This function returns the reason for the last platform reset.
* Returns the reason for the last platform reset.
*
* @param[in] aInstance The OpenThread instance structure.
*
@@ -91,7 +91,7 @@ typedef enum
otPlatResetReason otPlatGetResetReason(otInstance *aInstance);
/**
* This function provides a platform specific implementation for assert.
* Provides a platform specific implementation for assert.
*
* @param[in] aFilename The name of the file where the assert occurred.
* @param[in] aLineNumber The line number in the file where the assert occurred.
@@ -100,7 +100,7 @@ otPlatResetReason otPlatGetResetReason(otInstance *aInstance);
void otPlatAssertFail(const char *aFilename, int aLineNumber);
/**
* This function performs a platform specific operation to wake the host MCU.
* Performs a platform specific operation to wake the host MCU.
* This is used only for NCP configurations.
*
*/
@@ -163,7 +163,7 @@ typedef enum
} otPlatMcuPowerState;
/**
* This function sets the desired MCU power state.
* Sets the desired MCU power state.
*
* This is only applicable and used for NCP configuration when `OPENTHREAD_CONFIG_NCP_ENABLE_MCU_POWER_STATE_CONTROL`
* is enabled.
@@ -178,7 +178,7 @@ typedef enum
otError otPlatSetMcuPowerState(otInstance *aInstance, otPlatMcuPowerState aState);
/**
* This function gets the current desired MCU power state.
* Gets the current desired MCU power state.
*
* This is only applicable and used for NCP configuration when `OPENTHREAD_CONFIG_NCP_ENABLE_MCU_POWER_STATE_CONTROL`
* is enabled.
include/openthread/platform/otns.h
+1 -1
View File
@@ -54,7 +54,7 @@ extern "C" {
*/
/**
* This function exports status information to OTNS.
* Exports status information to OTNS.
*
* The status information is represented by a null-terminated string with format recognizable by OTNS.
* Each call to `otPlatOtnsStatus` can send multiple statuses, separated by ';', e.x. "parid=577fbc37;lrid=5".
include/openthread/platform/radio.h
+32 -32
View File
@@ -88,7 +88,7 @@ enum
};
/**
* This enumeration defines the channel page.
* Defines the channel page.
*
*/
enum
@@ -100,7 +100,7 @@ enum
};
/**
* This enumeration defines the frequency band channel range.
* Defines the frequency band channel range.
*
*/
enum
@@ -114,7 +114,7 @@ enum
};
/**
* This type represents radio capabilities.
* Represents radio capabilities.
*
* The value is a bit-field indicating the capabilities supported by the radio. See `OT_RADIO_CAPS_*` definitions.
*
@@ -122,7 +122,7 @@ enum
typedef uint8_t otRadioCaps;
/**
* This enumeration defines constants that are used to indicate different radio capabilities. See `otRadioCaps`.
* Defines constants that are used to indicate different radio capabilities. See `otRadioCaps`.
*
*/
enum
@@ -141,13 +141,13 @@ enum
#define OT_PANID_BROADCAST 0xffff ///< IEEE 802.15.4 Broadcast PAN ID
/**
* This type represents the IEEE 802.15.4 PAN ID.
* Represents the IEEE 802.15.4 PAN ID.
*
*/
typedef uint16_t otPanId;
/**
* This type represents the IEEE 802.15.4 Short Address.
* Represents the IEEE 802.15.4 Short Address.
*
*/
typedef uint16_t otShortAddress;
@@ -155,7 +155,7 @@ typedef uint16_t otShortAddress;
#define OT_EXT_ADDRESS_SIZE 8 ///< Size of an IEEE 802.15.4 Extended Address (bytes)
/**
* This enumeration defines constants about size of header IE in ACK.
* Defines constants about size of header IE in ACK.
*
*/
enum
@@ -172,7 +172,7 @@ enum
/**
* @struct otExtAddress
*
* This structure represents the IEEE 802.15.4 Extended Address.
* Represents the IEEE 802.15.4 Extended Address.
*
*/
OT_TOOL_PACKED_BEGIN
@@ -182,7 +182,7 @@ struct otExtAddress
} OT_TOOL_PACKED_END;
/**
* This structure represents the IEEE 802.15.4 Extended Address.
* Represents the IEEE 802.15.4 Extended Address.
*
*/
typedef struct otExtAddress otExtAddress;
@@ -192,7 +192,7 @@ typedef struct otExtAddress otExtAddress;
/**
* @struct otMacKey
*
* This structure represents a MAC Key.
* Represents a MAC Key.
*
*/
OT_TOOL_PACKED_BEGIN
@@ -202,13 +202,13 @@ struct otMacKey
} OT_TOOL_PACKED_END;
/**
* This structure represents a MAC Key.
* Represents a MAC Key.
*
*/
typedef struct otMacKey otMacKey;
/**
* This type represents a MAC Key Ref used by PSA.
* Represents a MAC Key Ref used by PSA.
*
*/
typedef otCryptoKeyRef otMacKeyRef;
@@ -216,7 +216,7 @@ typedef otCryptoKeyRef otMacKeyRef;
/**
* @struct otMacKeyMaterial
*
* This structure represents a MAC Key.
* Represents a MAC Key.
*
*/
typedef struct otMacKeyMaterial
@@ -229,7 +229,7 @@ typedef struct otMacKeyMaterial
} otMacKeyMaterial;
/**
* This enumeration defines constants about key types.
* Defines constants about key types.
*
*/
typedef enum
@@ -239,7 +239,7 @@ typedef enum
} otRadioKeyType;
/**
* This structure represents the IEEE 802.15.4 Header IE (Information Element) related information of a radio frame.
* Represents the IEEE 802.15.4 Header IE (Information Element) related information of a radio frame.
*/
typedef struct otRadioIeInfo
{
@@ -249,7 +249,7 @@ typedef struct otRadioIeInfo
} otRadioIeInfo;
/**
* This structure represents an IEEE 802.15.4 radio frame.
* Represents an IEEE 802.15.4 radio frame.
*/
typedef struct otRadioFrame
{
@@ -352,7 +352,7 @@ typedef struct otRadioFrame
} otRadioFrame;
/**
* This structure represents the state of a radio.
* Represents the state of a radio.
* Initially, a radio is in the Disabled state.
*/
typedef enum otRadioState
@@ -382,7 +382,7 @@ typedef enum otRadioState
*/
/**
* This structure represents radio coexistence metrics.
* Represents radio coexistence metrics.
*/
typedef struct otRadioCoexMetrics
{
@@ -408,7 +408,7 @@ typedef struct otRadioCoexMetrics
} otRadioCoexMetrics;
/**
* This structure represents what metrics are specified to query.
* Represents what metrics are specified to query.
*
*/
typedef struct otLinkMetrics
@@ -610,7 +610,7 @@ void otPlatRadioSetPromiscuous(otInstance *aInstance, bool aEnable);
/**
* Update MAC keys and key index
*
* This function is used when radio provides OT_RADIO_CAPS_TRANSMIT_SEC capability.
* Is used when radio provides OT_RADIO_CAPS_TRANSMIT_SEC capability.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aKeyIdMode The key ID mode.
@@ -630,9 +630,9 @@ void otPlatRadioSetMacKey(otInstance *aInstance,
otRadioKeyType aKeyType);
/**
* This method sets the current MAC frame counter value.
* Sets the current MAC frame counter value.
*
* This function is used when radio provides `OT_RADIO_CAPS_TRANSMIT_SEC` capability.
* Is used when radio provides `OT_RADIO_CAPS_TRANSMIT_SEC` capability.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aMacFrameCounter The MAC frame counter value.
@@ -641,9 +641,9 @@ void otPlatRadioSetMacKey(otInstance *aInstance,
void otPlatRadioSetMacFrameCounter(otInstance *aInstance, uint32_t aMacFrameCounter);
/**
* This method sets the current MAC frame counter value only if the new given value is larger than the current value.
* Sets the current MAC frame counter value only if the new given value is larger than the current value.
*
* This function is used when radio provides `OT_RADIO_CAPS_TRANSMIT_SEC` capability.
* Is used when radio provides `OT_RADIO_CAPS_TRANSMIT_SEC` capability.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aMacFrameCounter The MAC frame counter value.
@@ -693,7 +693,7 @@ uint32_t otPlatRadioGetBusSpeed(otInstance *aInstance);
/**
* Get current state of the radio.
*
* This function is not required by OpenThread. It may be used for debugging and/or application-specific purposes.
* Is not required by OpenThread. It may be used for debugging and/or application-specific purposes.
*
* @note This function may be not implemented. It does not affect OpenThread.
*
@@ -787,7 +787,7 @@ extern void otPlatRadioReceiveDone(otInstance *aInstance, otRadioFrame *aFrame,
/**
* The radio driver calls this method to notify OpenThread diagnostics module of a received frame.
*
* This function is used when diagnostics is enabled.
* Is used when diagnostics is enabled.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aFrame A pointer to the received frame or NULL if the receive operation failed.
@@ -864,7 +864,7 @@ extern void otPlatRadioTxDone(otInstance *aInstance, otRadioFrame *aFrame, otRad
/**
* The radio driver calls this method to notify OpenThread diagnostics module that the transmission has completed.
*
* This function is used when diagnostics is enabled.
* Is used when diagnostics is enabled.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aFrame A pointer to the frame that was transmitted.
@@ -888,7 +888,7 @@ int8_t otPlatRadioGetRssi(otInstance *aInstance);
/**
* Begin the energy scan sequence on the radio.
*
* This function is used when radio provides OT_RADIO_CAPS_ENERGY_SCAN capability.
* Is used when radio provides OT_RADIO_CAPS_ENERGY_SCAN capability.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aScanChannel The channel to perform the energy scan on.
@@ -904,7 +904,7 @@ otError otPlatRadioEnergyScan(otInstance *aInstance, uint8_t aScanChannel, uint1
/**
* The radio driver calls this method to notify OpenThread that the energy scan is complete.
*
* This function is used when radio provides OT_RADIO_CAPS_ENERGY_SCAN capability.
* Is used when radio provides OT_RADIO_CAPS_ENERGY_SCAN capability.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aEnergyScanMaxRssi The maximum RSSI encountered on the scanned channel.
@@ -1019,7 +1019,7 @@ uint32_t otPlatRadioGetPreferredChannelMask(otInstance *aInstance);
/**
* Enable the radio coex.
*
* This function is used when feature OPENTHREAD_CONFIG_PLATFORM_RADIO_COEX_ENABLE is enabled.
* Is used when feature OPENTHREAD_CONFIG_PLATFORM_RADIO_COEX_ENABLE is enabled.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aEnabled TRUE to enable the radio coex, FALSE otherwise.
@@ -1033,7 +1033,7 @@ otError otPlatRadioSetCoexEnabled(otInstance *aInstance, bool aEnabled);
/**
* Check whether radio coex is enabled or not.
*
* This function is used when feature OPENTHREAD_CONFIG_PLATFORM_RADIO_COEX_ENABLE is enabled.
* Is used when feature OPENTHREAD_CONFIG_PLATFORM_RADIO_COEX_ENABLE is enabled.
*
* @param[in] aInstance The OpenThread instance structure.
*
@@ -1045,7 +1045,7 @@ bool otPlatRadioIsCoexEnabled(otInstance *aInstance);
/**
* Get the radio coexistence metrics.
*
* This function is used when feature OPENTHREAD_CONFIG_PLATFORM_RADIO_COEX_ENABLE is enabled.
* Is used when feature OPENTHREAD_CONFIG_PLATFORM_RADIO_COEX_ENABLE is enabled.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[out] aCoexMetrics A pointer to the coexistence metrics structure.
include/openthread/platform/settings.h
+8 -8
View File
@@ -52,7 +52,7 @@ extern "C" {
*/
/**
* This enumeration defines the keys of settings.
* Defines the keys of settings.
*
* Note: When adding a new settings key, if the settings corresponding to the key contains security sensitive
* information, the developer MUST add the key to the array `aSensitiveKeys` which is passed in
@@ -90,7 +90,7 @@ enum
/**
* Performs any initialization for the settings subsystem, if necessary.
*
* This function also sets the sensitive keys that should be stored in the secure area.
* Also sets the sensitive keys that should be stored in the secure area.
*
* Note that the memory pointed by @p aSensitiveKeys MUST not be released before @p aInstance is destroyed.
*
@@ -113,13 +113,13 @@ void otPlatSettingsDeinit(otInstance *aInstance);
/**
* Fetches the value of a setting.
*
* This function fetches the value of the setting identified
* Fetches the value of the setting identified
* by @p aKey and write it to the memory pointed to by aValue.
* It then writes the length to the integer pointed to by
* @p aValueLength. The initial value of @p aValueLength is the
* maximum number of bytes to be written to @p aValue.
*
* This function can be used to check for the existence of
* Can be used to check for the existence of
* a key without fetching the value by setting @p aValue and
* @p aValueLength to NULL. You can also check the length of
* the setting without fetching it by setting only aValue
@@ -149,7 +149,7 @@ otError otPlatSettingsGet(otInstance *aInstance, uint16_t aKey, int aIndex, uint
/**
* Sets or replaces the value of a setting.
*
* This function sets or replaces the value of a setting
* Sets or replaces the value of a setting
* identified by @p aKey.
*
* Calling this function successfully may cause unrelated
@@ -178,7 +178,7 @@ otError otPlatSettingsSet(otInstance *aInstance, uint16_t aKey, const uint8_t *a
/**
* Adds a value to a setting.
*
* This function adds the value to a setting
* Adds the value to a setting
* identified by @p aKey, without replacing any existing
* values.
*
@@ -214,7 +214,7 @@ otError otPlatSettingsAdd(otInstance *aInstance, uint16_t aKey, const uint8_t *a
/**
* Removes a setting from the setting store.
*
* This function deletes a specific value from the
* Deletes a specific value from the
* setting identified by aKey from the settings store.
*
* Note that the underlying implementation is not required
@@ -235,7 +235,7 @@ otError otPlatSettingsDelete(otInstance *aInstance, uint16_t aKey, int aIndex);
/**
* Removes all settings from the setting store.
*
* This function deletes all settings from the settings
* Deletes all settings from the settings
* store, resetting it to its initial factory state.
*
* @param[in] aInstance The OpenThread instance structure.
include/openthread/platform/spi-slave.h
+1 -1
View File
@@ -126,7 +126,7 @@ void otPlatSpiSlaveDisable(void);
* Prepare data for the next SPI transaction. Data pointers MUST remain valid until the transaction complete callback
* is called by the SPI slave driver, or until after the next call to `otPlatSpiSlavePrepareTransaction()`.
*
* This function may be called more than once before the SPI master initiates the transaction. Each *successful* call
* May be called more than once before the SPI master initiates the transaction. Each *successful* call
* to this function will cause the previous values from earlier calls to be discarded.
*
* Not calling this function after a completed transaction is the same as if this function was previously called with
include/openthread/platform/toolchain.h
+2 -2
View File
@@ -113,10 +113,10 @@ extern "C" {
/**
* @def OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK
*
* This macro specifies that a function or method takes `printf` style arguments and should be type-checked against
* Specifies that a function or method takes `printf` style arguments and should be type-checked against
* a format string.
*
* This macro must be added after the function/method declaration. For example:
* Must be added after the function/method declaration. For example:
*
* `void MyPrintf(void *aObject, const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2, 3);`
*
include/openthread/platform/trel.h
+6 -6
View File
@@ -58,7 +58,7 @@ extern "C" {
*/
/**
* This function initializes and enables TREL platform layer.
* Initializes and enables TREL platform layer.
*
* Upon this call, the platform layer MUST perform the following:
*
@@ -87,7 +87,7 @@ extern "C" {
void otPlatTrelEnable(otInstance *aInstance, uint16_t *aUdpPort);
/**
* This function disables TREL platform layer.
* Disables TREL platform layer.
*
* After this call, the platform layer MUST stop DNS-SD browse on the service name "_trel._udp", stop advertising the
* TREL DNS-SD service (from `otPlatTrelRegisterService()`) and MUST close the UDP socket used to receive TREL messages.
@@ -98,7 +98,7 @@ void otPlatTrelEnable(otInstance *aInstance, uint16_t *aUdpPort);
void otPlatTrelDisable(otInstance *aInstance);
/**
* This structure represents a TREL peer info discovered using DNS-SD browse on the service name "_trel._udp".
* Represents a TREL peer info discovered using DNS-SD browse on the service name "_trel._udp".
*
*/
typedef struct otPlatTrelPeerInfo
@@ -145,7 +145,7 @@ typedef struct otPlatTrelPeerInfo
extern void otPlatTrelHandleDiscoveredPeerInfo(otInstance *aInstance, const otPlatTrelPeerInfo *aInfo);
/**
* This function registers a new service to be advertised using DNS-SD [RFC6763].
* Registers a new service to be advertised using DNS-SD [RFC6763].
*
* The service name is "_trel._udp". The platform should use its own hostname, which when combined with the service
* name and the local DNS-SD domain name will produce the full service instance name, for example
@@ -170,7 +170,7 @@ extern void otPlatTrelHandleDiscoveredPeerInfo(otInstance *aInstance, const otPl
void otPlatTrelRegisterService(otInstance *aInstance, uint16_t aPort, const uint8_t *aTxtData, uint8_t aTxtLength);
/**
* This function requests a TREL UDP packet to be sent to a given destination.
* Requests a TREL UDP packet to be sent to a given destination.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aUdpPayload A pointer to UDP payload.
@@ -184,7 +184,7 @@ void otPlatTrelSend(otInstance *aInstance,
const otSockAddr *aDestSockAddr);
/**
* This function is a callback from platform to notify of a received TREL UDP packet.
* Is a callback from platform to notify of a received TREL UDP packet.
*
* @note The buffer content (up to its specified length) may get changed during processing by OpenThread core (e.g.,
* decrypted in place), so the platform implementation should expect that after returning from this function the
include/openthread/platform/udp.h
+8 -8
View File
@@ -42,7 +42,7 @@ extern "C" {
#endif
/**
* This function initializes the UDP socket by platform.
* Initializes the UDP socket by platform.
*
* @param[in] aUdpSocket A pointer to the UDP socket.
*
@@ -53,7 +53,7 @@ extern "C" {
otError otPlatUdpSocket(otUdpSocket *aUdpSocket);
/**
* This function closes the UDP socket by platform.
* Closes the UDP socket by platform.
*
* @param[in] aUdpSocket A pointer to the UDP socket.
*
@@ -64,7 +64,7 @@ otError otPlatUdpSocket(otUdpSocket *aUdpSocket);
otError otPlatUdpClose(otUdpSocket *aUdpSocket);
/**
* This function binds the UDP socket by platform.
* Binds the UDP socket by platform.
*
* @param[in] aUdpSocket A pointer to the UDP socket.
*
@@ -75,7 +75,7 @@ otError otPlatUdpClose(otUdpSocket *aUdpSocket);
otError otPlatUdpBind(otUdpSocket *aUdpSocket);
/**
* This function binds the UDP socket to a platform network interface.
* Binds the UDP socket to a platform network interface.
*
* Note: only available when `OPENTHREAD_CONFIG_PLATFORM_UDP_ENABLE` is used.
*
@@ -89,7 +89,7 @@ otError otPlatUdpBind(otUdpSocket *aUdpSocket);
otError otPlatUdpBindToNetif(otUdpSocket *aUdpSocket, otNetifIdentifier aNetifIdentifier);
/**
* This function connects UDP socket by platform.
* Connects UDP socket by platform.
*
* @param[in] aUdpSocket A pointer to the UDP socket.
*
@@ -100,7 +100,7 @@ otError otPlatUdpBindToNetif(otUdpSocket *aUdpSocket, otNetifIdentifier aNetifId
otError otPlatUdpConnect(otUdpSocket *aUdpSocket);
/**
* This function sends UDP payload by platform.
* Sends UDP payload by platform.
*
* @param[in] aUdpSocket A pointer to the UDP socket.
* @param[in] aMessage A pointer to the message to send.
@@ -113,7 +113,7 @@ otError otPlatUdpConnect(otUdpSocket *aUdpSocket);
otError otPlatUdpSend(otUdpSocket *aUdpSocket, otMessage *aMessage, const otMessageInfo *aMessageInfo);
/**
* This function configures the UDP socket to join a UDP multicast group.
* Configures the UDP socket to join a UDP multicast group.
*
* Note: only available when `OPENTHREAD_CONFIG_PLATFORM_UDP_ENABLE` is used.
*
@@ -130,7 +130,7 @@ otError otPlatUdpJoinMulticastGroup(otUdpSocket *aUdpSocket,
const otIp6Address *aAddress);
/**
* This function configures the UDP socket to leave a UDP multicast group.
* Configures the UDP socket to leave a UDP multicast group.
*
* Note: only available when `OPENTHREAD_CONFIG_PLATFORM_UDP_ENABLE` is used.
*
include/openthread/random_crypto.h
+1 -1
View File
@@ -55,7 +55,7 @@ extern "C" {
*/
/**
* This function fills a given buffer with cryptographically secure random bytes.
* Fills a given buffer with cryptographically secure random bytes.
*
* @param[out] aBuffer A pointer to a buffer to fill with the random bytes.
* @param[in] aSize Size of buffer (number of bytes to fill).
include/openthread/random_noncrypto.h
+8 -8
View File
@@ -52,7 +52,7 @@ extern "C" {
*/
/**
* This function generates and returns a random `uint32_t` value.
* Generates and returns a random `uint32_t` value.
*
* @returns A random `uint32_t` value.
*
@@ -60,7 +60,7 @@ extern "C" {
uint32_t otRandomNonCryptoGetUint32(void);
/**
* This function generates and returns a random byte.
* Generates and returns a random byte.
*
* @returns A random `uint8_t` value.
*
@@ -68,7 +68,7 @@ uint32_t otRandomNonCryptoGetUint32(void);
uint8_t otRandomNonCryptoGetUint8(void);
/**
* This function generates and returns a random `uint16_t` value.
* Generates and returns a random `uint16_t` value.
*
* @returns A random `uint16_t` value.
*
@@ -76,7 +76,7 @@ uint8_t otRandomNonCryptoGetUint8(void);
uint16_t otRandomNonCryptoGetUint16(void);
/**
* This function generates and returns a random `uint8_t` value within a given range `[aMin, aMax)`.
* Generates and returns a random `uint8_t` value within a given range `[aMin, aMax)`.
*
* @param[in] aMin A minimum value (this value can be included in returned random result).
* @param[in] aMax A maximum value (this value is excluded from returned random result).
@@ -86,7 +86,7 @@ uint16_t otRandomNonCryptoGetUint16(void);
uint8_t otRandomNonCryptoGetUint8InRange(uint8_t aMin, uint8_t aMax);
/**
* This function generates and returns a random `uint16_t` value within a given range `[aMin, aMax)`.
* Generates and returns a random `uint16_t` value within a given range `[aMin, aMax)`.
*
* @note The returned random value can include the @p aMin value but excludes the @p aMax.
*
@@ -98,7 +98,7 @@ uint8_t otRandomNonCryptoGetUint8InRange(uint8_t aMin, uint8_t aMax);
uint16_t otRandomNonCryptoGetUint16InRange(uint16_t aMin, uint16_t aMax);
/**
* This function generates and returns a random `uint32_t` value within a given range `[aMin, aMax)`.
* Generates and returns a random `uint32_t` value within a given range `[aMin, aMax)`.
*
* @note The returned random value can include the @p aMin value but excludes the @p aMax.
*
@@ -111,7 +111,7 @@ uint16_t otRandomNonCryptoGetUint16InRange(uint16_t aMin, uint16_t aMax);
uint32_t otRandomNonCryptoGetUint32InRange(uint32_t aMin, uint32_t aMax);
/**
* This function fills a given buffer with random bytes.
* Fills a given buffer with random bytes.
*
* @param[out] aBuffer A pointer to a buffer to fill with the random bytes.
* @param[in] aSize Size of buffer (number of bytes to fill).
@@ -120,7 +120,7 @@ uint32_t otRandomNonCryptoGetUint32InRange(uint32_t aMin, uint32_t aMax);
void otRandomNonCryptoFillBuffer(uint8_t *aBuffer, uint16_t aSize);
/**
* This function adds a random jitter within a given range to a given value.
* Adds a random jitter within a given range to a given value.
*
* @param[in] aValue A value to which the random jitter is added.
* @param[in] aJitter Maximum jitter. Random jitter is selected from the range `[-aJitter, aJitter]`.
include/openthread/server.h
+2 -2
View File
@@ -52,7 +52,7 @@ extern "C" {
*/
/**
* This method provides a full or stable copy of the local Thread Network Data.
* Provides a full or stable copy of the local Thread Network Data.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aStable TRUE when copying the stable version, FALSE when copying the full version.
@@ -100,7 +100,7 @@ otError otServerRemoveService(otInstance *aInstance,
uint8_t aServiceDataLength);
/**
* This function gets the next service in the local Network Data.
* Gets the next service in the local Network Data.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in,out] aIterator A pointer to the Network Data iterator context. To get the first service entry
include/openthread/sntp.h
+5 -5
View File
@@ -57,7 +57,7 @@ extern "C" {
#define OT_SNTP_DEFAULT_SERVER_PORT 123 ///< Defines default SNTP Server port.
/**
* This structure implements SNTP Query parameters.
* Implements SNTP Query parameters.
*
*/
typedef struct otSntpQuery
@@ -66,7 +66,7 @@ typedef struct otSntpQuery
} otSntpQuery;
/**
* This function pointer is called when a SNTP response is received.
* Pointer is called when a SNTP response is received.
*
* @param[in] aContext A pointer to application-specific context.
* @param[in] aTime Specifies the time at the server when the response left for the client, in UNIX time.
@@ -83,9 +83,9 @@ typedef struct otSntpQuery
typedef void (*otSntpResponseHandler)(void *aContext, uint64_t aTime, otError aResult);
/**
* This function sends a SNTP query.
* Sends a SNTP query.
*
* This function is available only if feature `OPENTHREAD_CONFIG_SNTP_CLIENT_ENABLE` is enabled.
* Is available only if feature `OPENTHREAD_CONFIG_SNTP_CLIENT_ENABLE` is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aQuery A pointer to specify SNTP query parameters.
@@ -99,7 +99,7 @@ otError otSntpClientQuery(otInstance *aInstance,
void *aContext);
/**
* This function sets the unix era number.
* Sets the unix era number.
*
* The default value of unix era is set to 0. The subsequent eras start after year 2106.
*
include/openthread/srp_client.h
+40 -40
View File
@@ -53,7 +53,7 @@ extern "C" {
*/
/**
* This enumeration specifies an SRP client item (service or host info) state.
* Specifies an SRP client item (service or host info) state.
*
*/
typedef enum
@@ -69,7 +69,7 @@ typedef enum
} otSrpClientItemState;
/**
* This structure represents an SRP client host info.
* Represents an SRP client host info.
*
*/
typedef struct otSrpClientHostInfo
@@ -82,7 +82,7 @@ typedef struct otSrpClientHostInfo
} otSrpClientHostInfo;
/**
* This structure represents an SRP client service.
* Represents an SRP client service.
*
* The values in this structure, including the string buffers for the names and the TXT record entries, MUST persist
* and stay constant after an instance of this structure is passed to OpenThread from `otSrpClientAddService()` or
@@ -119,7 +119,7 @@ typedef struct otSrpClientService
} otSrpClientService;
/**
* This function pointer type defines the callback used by SRP client to notify user of changes/events/errors.
* Pointer type defines the callback used by SRP client to notify user of changes/events/errors.
*
* This callback is invoked on a successful registration of an update (i.e., add/remove of host-info and/or some
* service(s)) with the SRP server, or if there is a failure or error (e.g., server rejects a update request or client
@@ -180,7 +180,7 @@ typedef void (*otSrpClientCallback)(otError aError,
void *aContext);
/**
* This function pointer type defines the callback used by SRP client to notify user when it is auto-started or stopped.
* Pointer type defines the callback used by SRP client to notify user when it is auto-started or stopped.
*
* This is only used when auto-start feature `OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_API_ENABLE` is enabled.
*
@@ -195,7 +195,7 @@ typedef void (*otSrpClientCallback)(otError aError,
typedef void (*otSrpClientAutoStartCallback)(const otSockAddr *aServerSockAddr, void *aContext);
/**
* This function starts the SRP client operation.
* Starts the SRP client operation.
*
* SRP client will prepare and send "SRP Update" message to the SRP server once all the following conditions are met:
*
@@ -222,9 +222,9 @@ typedef void (*otSrpClientAutoStartCallback)(const otSockAddr *aServerSockAddr,
otError otSrpClientStart(otInstance *aInstance, const otSockAddr *aServerSockAddr);
/**
* This function stops the SRP client operation.
* Stops the SRP client operation.
*
* This function stops any further interactions with the SRP server. Note that it does not remove or clear host info
* Stops any further interactions with the SRP server. Note that it does not remove or clear host info
* and/or list of services. It marks all services to be added/removed again once the client is (re)started.
*
* @param[in] aInstance A pointer to the OpenThread instance.
@@ -233,7 +233,7 @@ otError otSrpClientStart(otInstance *aInstance, const otSockAddr *aServerSockAdd
void otSrpClientStop(otInstance *aInstance);
/**
* This function indicates whether the SRP client is running or not.
* Indicates whether the SRP client is running or not.
*
* @param[in] aInstance A pointer to the OpenThread instance.
*
@@ -243,7 +243,7 @@ void otSrpClientStop(otInstance *aInstance);
bool otSrpClientIsRunning(otInstance *aInstance);
/**
* This function gets the socket address (IPv6 address and port number) of the SRP server which is being used by SRP
* Gets the socket address (IPv6 address and port number) of the SRP server which is being used by SRP
* client.
*
* If the client is not running, the address is unspecified (all zero) with zero port number.
@@ -256,7 +256,7 @@ bool otSrpClientIsRunning(otInstance *aInstance);
const otSockAddr *otSrpClientGetServerAddress(otInstance *aInstance);
/**
* This function sets the callback to notify caller of events/changes from SRP client.
* Sets the callback to notify caller of events/changes from SRP client.
*
* The SRP client allows a single callback to be registered. So consecutive calls to this function will overwrite any
* previously set callback functions.
@@ -269,7 +269,7 @@ const otSockAddr *otSrpClientGetServerAddress(otInstance *aInstance);
void otSrpClientSetCallback(otInstance *aInstance, otSrpClientCallback aCallback, void *aContext);
/**
* This function enables the auto-start mode.
* Enables the auto-start mode.
*
* This is only available when auto-start feature `OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_API_ENABLE` is enabled.
*
@@ -310,7 +310,7 @@ void otSrpClientSetCallback(otInstance *aInstance, otSrpClientCallback aCallback
void otSrpClientEnableAutoStartMode(otInstance *aInstance, otSrpClientAutoStartCallback aCallback, void *aContext);
/**
* This function disables the auto-start mode.
* Disables the auto-start mode.
*
* This is only available when auto-start feature `OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_API_ENABLE` is enabled.
*
@@ -325,7 +325,7 @@ void otSrpClientEnableAutoStartMode(otInstance *aInstance, otSrpClientAutoStartC
void otSrpClientDisableAutoStartMode(otInstance *aInstance);
/**
* This function indicates the current state of auto-start mode (enabled or disabled).
* Indicates the current state of auto-start mode (enabled or disabled).
*
* This is only available when auto-start feature `OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_API_ENABLE` is enabled.
*
@@ -337,7 +337,7 @@ void otSrpClientDisableAutoStartMode(otInstance *aInstance);
bool otSrpClientIsAutoStartModeEnabled(otInstance *aInstance);
/**
* This function gets the TTL value in every record included in SRP update requests.
* Gets the TTL value in every record included in SRP update requests.
*
* Note that this is the TTL requested by the SRP client. The server may choose to accept a different TTL.
*
@@ -352,7 +352,7 @@ bool otSrpClientIsAutoStartModeEnabled(otInstance *aInstance);
uint32_t otSrpClientGetTtl(otInstance *aInstance);
/**
* This function sets the TTL value in every record included in SRP update requests.
* Sets the TTL value in every record included in SRP update requests.
*
* Changing the TTL does not impact the TTL of already registered services/host-info.
* It only affects future SRP update messages (i.e., adding new services and/or refreshes of the existing services).
@@ -365,7 +365,7 @@ uint32_t otSrpClientGetTtl(otInstance *aInstance);
void otSrpClientSetTtl(otInstance *aInstance, uint32_t aTtl);
/**
* This function gets the default lease interval used in SRP update requests.
* Gets the default lease interval used in SRP update requests.
*
* The default interval is used only for `otSrpClientService` instances with `mLease` set to zero.
*
@@ -380,7 +380,7 @@ void otSrpClientSetTtl(otInstance *aInstance, uint32_t aTtl);
uint32_t otSrpClientGetLeaseInterval(otInstance *aInstance);
/**
* This function sets the default lease interval used in SRP update requests.
* Sets the default lease interval used in SRP update requests.
*
* The default interval is used only for `otSrpClientService` instances with `mLease` set to zero.
*
@@ -395,7 +395,7 @@ uint32_t otSrpClientGetLeaseInterval(otInstance *aInstance);
void otSrpClientSetLeaseInterval(otInstance *aInstance, uint32_t aInterval);
/**
* This function gets the default key lease interval used in SRP update requests.
* Gets the default key lease interval used in SRP update requests.
*
* The default interval is used only for `otSrpClientService` instances with `mKeyLease` set to zero.
*
@@ -410,7 +410,7 @@ void otSrpClientSetLeaseInterval(otInstance *aInstance, uint32_t aInterval);
uint32_t otSrpClientGetKeyLeaseInterval(otInstance *aInstance);
/**
* This function sets the default key lease interval used in SRP update requests.
* Sets the default key lease interval used in SRP update requests.
*
* The default interval is used only for `otSrpClientService` instances with `mKeyLease` set to zero.
*
@@ -425,7 +425,7 @@ uint32_t otSrpClientGetKeyLeaseInterval(otInstance *aInstance);
void otSrpClientSetKeyLeaseInterval(otInstance *aInstance, uint32_t aInterval);
/**
* This function gets the host info.
* Gets the host info.
*
* @param[in] aInstance A pointer to the OpenThread instance.
*
@@ -435,7 +435,7 @@ void otSrpClientSetKeyLeaseInterval(otInstance *aInstance, uint32_t aInterval);
const otSrpClientHostInfo *otSrpClientGetHostInfo(otInstance *aInstance);
/**
* This function sets the host name label.
* Sets the host name label.
*
* After a successful call to this function, `otSrpClientCallback` will be called to report the status of host info
* registration with SRP server.
@@ -458,7 +458,7 @@ const otSrpClientHostInfo *otSrpClientGetHostInfo(otInstance *aInstance);
otError otSrpClientSetHostName(otInstance *aInstance, const char *aName);
/**
* This function enables auto host address mode.
* Enables auto host address mode.
*
* When enabled host IPv6 addresses are automatically set by SRP client using all the unicast addresses on Thread netif
* excluding all link-local and mesh-local addresses. If there is no valid address, then Mesh Local EID address is
@@ -479,7 +479,7 @@ otError otSrpClientSetHostName(otInstance *aInstance, const char *aName);
otError otSrpClientEnableAutoHostAddress(otInstance *aInstance);
/**
* This function sets/updates the list of host IPv6 address.
* Sets/updates the list of host IPv6 address.
*
* Host IPv6 addresses can be set/changed before start or during operation of SRP client (e.g. to add/remove or change
* a previously registered host address), except when the host info is being removed (client is busy handling a remove
@@ -508,7 +508,7 @@ otError otSrpClientEnableAutoHostAddress(otInstance *aInstance);
otError otSrpClientSetHostAddresses(otInstance *aInstance, const otIp6Address *aIp6Addresses, uint8_t aNumAddresses);
/**
* This function adds a service to be registered with server.
* Adds a service to be registered with server.
*
* After a successful call to this function, `otSrpClientCallback` will be called to report the status of the service
* addition/registration with SRP server.
@@ -535,7 +535,7 @@ otError otSrpClientSetHostAddresses(otInstance *aInstance, const otIp6Address *a
otError otSrpClientAddService(otInstance *aInstance, otSrpClientService *aService);
/**
* This function requests a service to be unregistered with server.
* Requests a service to be unregistered with server.
*
* After a successful call to this function, `otSrpClientCallback` will be called to report the status of remove
* request with SRP server.
@@ -556,14 +556,14 @@ otError otSrpClientAddService(otInstance *aInstance, otSrpClientService *aServic
otError otSrpClientRemoveService(otInstance *aInstance, otSrpClientService *aService);
/**
* This function clears a service, immediately removing it from the client service list.
* Clears a service, immediately removing it from the client service list.
*
* Unlike `otSrpClientRemoveService()` which sends an update message to the server to remove the service, this function
* clears the service from the client's service list without any interaction with the server. On a successful call to
* this function, the `otSrpClientCallback` will NOT be called and the @p aService entry can be reclaimed and re-used
* by the caller immediately.
*
* This function can be used along with a subsequent call to `otSrpClientAddService()` (potentially reusing the same @p
* Can be used along with a subsequent call to `otSrpClientAddService()` (potentially reusing the same @p
* aService entry with the same service and instance names) to update some of the parameters in an existing service.
*
* @param[in] aInstance A pointer to the OpenThread instance.
@@ -576,7 +576,7 @@ otError otSrpClientRemoveService(otInstance *aInstance, otSrpClientService *aSer
otError otSrpClientClearService(otInstance *aInstance, otSrpClientService *aService);
/**
* This function gets the list of services being managed by client.
* Gets the list of services being managed by client.
*
* @param[in] aInstance A pointer to the OpenThread instance.
*
@@ -586,7 +586,7 @@ otError otSrpClientClearService(otInstance *aInstance, otSrpClientService *aServ
const otSrpClientService *otSrpClientGetServices(otInstance *aInstance);
/**
* This function starts the remove process of the host info and all services.
* Starts the remove process of the host info and all services.
*
* After returning from this function, `otSrpClientCallback` will be called to report the status of remove request with
* SRP server.
@@ -619,7 +619,7 @@ const otSrpClientService *otSrpClientGetServices(otInstance *aInstance);
otError otSrpClientRemoveHostAndServices(otInstance *aInstance, bool aRemoveKeyLease, bool aSendUnregToServer);
/**
* This function clears all host info and all the services.
* Clears all host info and all the services.
*
* Unlike `otSrpClientRemoveHostAndServices()` which sends an update message to the server to remove all the info, this
* function clears all the info immediately without any interaction with the server.
@@ -630,9 +630,9 @@ otError otSrpClientRemoveHostAndServices(otInstance *aInstance, bool aRemoveKeyL
void otSrpClientClearHostAndServices(otInstance *aInstance);
/**
* This function gets the domain name being used by SRP client.
* Gets the domain name being used by SRP client.
*
* This function requires `OPENTHREAD_CONFIG_SRP_CLIENT_DOMAIN_NAME_API_ENABLE` to be enabled.
* Requires `OPENTHREAD_CONFIG_SRP_CLIENT_DOMAIN_NAME_API_ENABLE` to be enabled.
*
* If domain name is not set, "default.service.arpa" will be used.
*
@@ -644,9 +644,9 @@ void otSrpClientClearHostAndServices(otInstance *aInstance);
const char *otSrpClientGetDomainName(otInstance *aInstance);
/**
* This function sets the domain name to be used by SRP client.
* Sets the domain name to be used by SRP client.
*
* This function requires `OPENTHREAD_CONFIG_SRP_CLIENT_DOMAIN_NAME_API_ENABLE` to be enabled.
* Requires `OPENTHREAD_CONFIG_SRP_CLIENT_DOMAIN_NAME_API_ENABLE` to be enabled.
*
* If not set "default.service.arpa" will be used.
*
@@ -666,7 +666,7 @@ const char *otSrpClientGetDomainName(otInstance *aInstance);
otError otSrpClientSetDomainName(otInstance *aInstance, const char *aName);
/**
* This function converts a `otSrpClientItemState` to a string.
* Converts a `otSrpClientItemState` to a string.
*
* @param[in] aItemState An item state.
*
@@ -676,12 +676,12 @@ otError otSrpClientSetDomainName(otInstance *aInstance, const char *aName);
const char *otSrpClientItemStateToString(otSrpClientItemState aItemState);
/**
* This function enables/disables "service key record inclusion" mode.
* Enables/disables "service key record inclusion" mode.
*
* When enabled, SRP client will include KEY record in Service Description Instructions in the SRP update messages
* that it sends.
*
* This function is available when `OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE` configuration is enabled.
* Is available when `OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE` configuration is enabled.
*
* @note KEY record is optional in Service Description Instruction (it is required and always included in the Host
* Description Instruction). The default behavior of SRP client is to not include it. This function is intended to
@@ -694,9 +694,9 @@ const char *otSrpClientItemStateToString(otSrpClientItemState aItemState);
void otSrpClientSetServiceKeyRecordEnabled(otInstance *aInstance, bool aEnabled);
/**
* This method indicates whether the "service key record inclusion" mode is enabled or disabled.
* Indicates whether the "service key record inclusion" mode is enabled or disabled.
*
* This function is available when `OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE` configuration is enabled.
* Is available when `OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE` configuration is enabled.
*
* @param[in] aInstance A pointer to the OpenThread instance.
*
include/openthread/srp_client_buffers.h
+10 -10
View File
@@ -55,7 +55,7 @@ extern "C" {
*/
/**
* This struct represents a SRP client service pool entry.
* Represents a SRP client service pool entry.
*
*/
typedef struct otSrpClientBuffersServiceEntry
@@ -65,7 +65,7 @@ typedef struct otSrpClientBuffersServiceEntry
} otSrpClientBuffersServiceEntry;
/**
* This function gets the string buffer to use for SRP client host name.
* Gets the string buffer to use for SRP client host name.
*
* @param[in] aInstance A pointer to the OpenThread instance.
* @param[out] aSize Pointer to a variable to return the size (number of bytes) of the string buffer (MUST NOT be
@@ -77,7 +77,7 @@ typedef struct otSrpClientBuffersServiceEntry
char *otSrpClientBuffersGetHostNameString(otInstance *aInstance, uint16_t *aSize);
/**
* This function gets the array of IPv6 address entries to use as SRP client host address list.
* Gets the array of IPv6 address entries to use as SRP client host address list.
*
* @param[in] aInstance A pointer to the OpenThread instance.
* @param[out] aArrayLength Pointer to a variable to return the array length i.e., number of IPv6 address entries in
@@ -89,7 +89,7 @@ char *otSrpClientBuffersGetHostNameString(otInstance *aInstance, uint16_t *aSize
otIp6Address *otSrpClientBuffersGetHostAddressesArray(otInstance *aInstance, uint8_t *aArrayLength);
/**
* This function allocates a new service entry from the pool.
* Allocates a new service entry from the pool.
*
* The returned service entry instance will be initialized as follows:
*
@@ -115,7 +115,7 @@ otIp6Address *otSrpClientBuffersGetHostAddressesArray(otInstance *aInstance, uin
otSrpClientBuffersServiceEntry *otSrpClientBuffersAllocateService(otInstance *aInstance);
/**
* This function frees a previously allocated service entry.
* Frees a previously allocated service entry.
*
* The @p aService MUST be previously allocated using `otSrpClientBuffersAllocateService()` and not yet freed. Otherwise
* the behavior of this function is undefined.
@@ -127,7 +127,7 @@ otSrpClientBuffersServiceEntry *otSrpClientBuffersAllocateService(otInstance *aI
void otSrpClientBuffersFreeService(otInstance *aInstance, otSrpClientBuffersServiceEntry *aService);
/**
* This function frees all previously allocated service entries.
* Frees all previously allocated service entries.
*
* @param[in] aInstance A pointer to the OpenThread instance.
*
@@ -135,7 +135,7 @@ void otSrpClientBuffersFreeService(otInstance *aInstance, otSrpClientBuffersServ
void otSrpClientBuffersFreeAllServices(otInstance *aInstance);
/**
* This function gets the string buffer for service name from a service entry.
* Gets the string buffer for service name from a service entry.
*
* @param[in] aEntry A pointer to a previously allocated service entry (MUST NOT be NULL).
* @param[out] aSize A pointer to a variable to return the size (number of bytes) of the string buffer (MUST NOT be
@@ -147,7 +147,7 @@ void otSrpClientBuffersFreeAllServices(otInstance *aInstance);
char *otSrpClientBuffersGetServiceEntryServiceNameString(otSrpClientBuffersServiceEntry *aEntry, uint16_t *aSize);
/**
* This function gets the string buffer for service instance name from a service entry.
* Gets the string buffer for service instance name from a service entry.
*
* @param[in] aEntry A pointer to a previously allocated service entry (MUST NOT be NULL).
* @param[out] aSize A pointer to a variable to return the size (number of bytes) of the string buffer (MUST NOT be
@@ -159,7 +159,7 @@ char *otSrpClientBuffersGetServiceEntryServiceNameString(otSrpClientBuffersServi
char *otSrpClientBuffersGetServiceEntryInstanceNameString(otSrpClientBuffersServiceEntry *aEntry, uint16_t *aSize);
/**
* This function gets the buffer for TXT record from a service entry.
* Gets the buffer for TXT record from a service entry.
*
* @param[in] aEntry A pointer to a previously allocated service entry (MUST NOT be NULL).
* @param[out] aSize A pointer to a variable to return the size (number of bytes) of the buffer (MUST NOT be NULL).
@@ -170,7 +170,7 @@ char *otSrpClientBuffersGetServiceEntryInstanceNameString(otSrpClientBuffersServ
uint8_t *otSrpClientBuffersGetServiceEntryTxtBuffer(otSrpClientBuffersServiceEntry *aEntry, uint16_t *aSize);
/**
* This function gets the array for service subtype labels from the service entry.
* Gets the array for service subtype labels from the service entry.
*
* @param[in] aEntry A pointer to a previously allocated service entry (MUST NOT be NULL).
* @param[out] aArrayLength A pointer to a variable to return the array length (MUST NOT be NULL).
include/openthread/srp_server.h
+50 -50
View File
@@ -132,7 +132,7 @@ enum
};
/**
* This enumeration represents the state of the SRP server.
* Represents the state of the SRP server.
*
*/
typedef enum
@@ -143,7 +143,7 @@ typedef enum
} otSrpServerState;
/**
* This enumeration represents the address mode used by the SRP server.
* Represents the address mode used by the SRP server.
*
* Address mode specifies how the address and port number are determined by the SRP server and how this info is
* published in the Thread Network Data.
@@ -156,7 +156,7 @@ typedef enum otSrpServerAddressMode
} otSrpServerAddressMode;
/**
* This structure includes SRP server TTL configurations.
* Includes SRP server TTL configurations.
*
*/
typedef struct otSrpServerTtlConfig
@@ -166,7 +166,7 @@ typedef struct otSrpServerTtlConfig
} otSrpServerTtlConfig;
/**
* This structure includes SRP server LEASE and KEY-LEASE configurations.
* Includes SRP server LEASE and KEY-LEASE configurations.
*
*/
typedef struct otSrpServerLeaseConfig
@@ -178,7 +178,7 @@ typedef struct otSrpServerLeaseConfig
} otSrpServerLeaseConfig;
/**
* This structure includes SRP server lease information of a host/service.
* Includes SRP server lease information of a host/service.
*
*/
typedef struct otSrpServerLeaseInfo
@@ -190,7 +190,7 @@ typedef struct otSrpServerLeaseInfo
} otSrpServerLeaseInfo;
/**
* This structure includes the statistics of SRP server responses.
* Includes the statistics of SRP server responses.
*
*/
typedef struct otSrpServerResponseCounters
@@ -204,7 +204,7 @@ typedef struct otSrpServerResponseCounters
} otSrpServerResponseCounters;
/**
* This function returns the domain authorized to the SRP server.
* Returns the domain authorized to the SRP server.
*
* If the domain if not set by SetDomain, "default.service.arpa." will be returned.
* A trailing dot is always appended even if the domain is set without it.
@@ -217,10 +217,10 @@ typedef struct otSrpServerResponseCounters
const char *otSrpServerGetDomain(otInstance *aInstance);
/**
* This function sets the domain on the SRP server.
* Sets the domain on the SRP server.
*
* A trailing dot will be appended to @p aDomain if it is not already there.
* This function should only be called before the SRP server is enabled.
* Should only be called before the SRP server is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aDomain The domain to be set. MUST NOT be NULL.
@@ -234,7 +234,7 @@ const char *otSrpServerGetDomain(otInstance *aInstance);
otError otSrpServerSetDomain(otInstance *aInstance, const char *aDomain);
/**
* This function returns the state of the SRP server.
* Returns the state of the SRP server.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -244,7 +244,7 @@ otError otSrpServerSetDomain(otInstance *aInstance, const char *aDomain);
otSrpServerState otSrpServerGetState(otInstance *aInstance);
/**
* This function returns the port the SRP server is listening to.
* Returns the port the SRP server is listening to.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -254,7 +254,7 @@ otSrpServerState otSrpServerGetState(otInstance *aInstance);
uint16_t otSrpServerGetPort(otInstance *aInstance);
/**
* This function returns the address mode being used by the SRP server.
* Returns the address mode being used by the SRP server.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -264,7 +264,7 @@ uint16_t otSrpServerGetPort(otInstance *aInstance);
otSrpServerAddressMode otSrpServerGetAddressMode(otInstance *aInstance);
/**
* This function sets the address mode to be used by the SRP server.
* Sets the address mode to be used by the SRP server.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aMode The address mode to use.
@@ -276,7 +276,7 @@ otSrpServerAddressMode otSrpServerGetAddressMode(otInstance *aInstance);
otError otSrpServerSetAddressMode(otInstance *aInstance, otSrpServerAddressMode aMode);
/**
* This function returns the sequence number used with anycast address mode.
* Returns the sequence number used with anycast address mode.
*
* The sequence number is included in "DNS/SRP Service Anycast Address" entry published in the Network Data.
*
@@ -288,7 +288,7 @@ otError otSrpServerSetAddressMode(otInstance *aInstance, otSrpServerAddressMode
uint8_t otSrpServerGetAnycastModeSequenceNumber(otInstance *aInstance);
/**
* This function sets the sequence number used with anycast address mode.
* Sets the sequence number used with anycast address mode.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aSequenceNumber The sequence number to use.
@@ -300,7 +300,7 @@ uint8_t otSrpServerGetAnycastModeSequenceNumber(otInstance *aInstance);
otError otSrpServerSetAnycastModeSequenceNumber(otInstance *aInstance, uint8_t aSequenceNumber);
/**
* This function enables/disables the SRP server.
* Enables/disables the SRP server.
*
* On a Border Router, it is recommended to use `otSrpServerSetAutoEnableMode()` instead.
*
@@ -311,9 +311,9 @@ otError otSrpServerSetAnycastModeSequenceNumber(otInstance *aInstance, uint8_t a
void otSrpServerSetEnabled(otInstance *aInstance, bool aEnabled);
/**
* This function enables/disables the auto-enable mode on SRP server.
* Enables/disables the auto-enable mode on SRP server.
*
* This function requires `OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE` feature.
* Requires `OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE` feature.
*
* When this mode is enabled, the Border Routing Manager controls if/when to enable or disable the SRP server.
* SRP sever is auto-enabled if/when Border Routing is started and it is done with the initial prefix and route
@@ -333,9 +333,9 @@ void otSrpServerSetEnabled(otInstance *aInstance, bool aEnabled);
void otSrpServerSetAutoEnableMode(otInstance *aInstance, bool aEnabled);
/**
* This function indicates whether the auto-enable mode is enabled or disabled.
* Indicates whether the auto-enable mode is enabled or disabled.
*
* This function requires `OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE` feature.
* Requires `OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE` feature.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -346,7 +346,7 @@ void otSrpServerSetAutoEnableMode(otInstance *aInstance, bool aEnabled);
bool otSrpServerIsAutoEnableMode(otInstance *aInstance);
/**
* This function returns SRP server TTL configuration.
* Returns SRP server TTL configuration.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[out] aTtlConfig A pointer to an `otSrpServerTtlConfig` instance.
@@ -355,7 +355,7 @@ bool otSrpServerIsAutoEnableMode(otInstance *aInstance);
void otSrpServerGetTtlConfig(otInstance *aInstance, otSrpServerTtlConfig *aTtlConfig);
/**
* This function sets SRP server TTL configuration.
* Sets SRP server TTL configuration.
*
* The granted TTL will always be no greater than the max lease interval configured via `otSrpServerSetLeaseConfig()`,
* regardless of the minimum and maximum TTL configuration.
@@ -370,7 +370,7 @@ void otSrpServerGetTtlConfig(otInstance *aInstance, otSrpServerTtlConfig *aTtlCo
otError otSrpServerSetTtlConfig(otInstance *aInstance, const otSrpServerTtlConfig *aTtlConfig);
/**
* This function returns SRP server LEASE and KEY-LEASE configurations.
* Returns SRP server LEASE and KEY-LEASE configurations.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[out] aLeaseConfig A pointer to an `otSrpServerLeaseConfig` instance.
@@ -379,7 +379,7 @@ otError otSrpServerSetTtlConfig(otInstance *aInstance, const otSrpServerTtlConfi
void otSrpServerGetLeaseConfig(otInstance *aInstance, otSrpServerLeaseConfig *aLeaseConfig);
/**
* This function sets SRP server LEASE and KEY-LEASE configurations.
* Sets SRP server LEASE and KEY-LEASE configurations.
*
* When a non-zero LEASE time is requested from a client, the granted value will be
* limited in range [aMinLease, aMaxLease]; and a non-zero KEY-LEASE will be granted
@@ -396,9 +396,9 @@ void otSrpServerGetLeaseConfig(otInstance *aInstance, otSrpServerLeaseConfig *aL
otError otSrpServerSetLeaseConfig(otInstance *aInstance, const otSrpServerLeaseConfig *aLeaseConfig);
/**
* This function handles SRP service updates.
* Handles SRP service updates.
*
* This function is called by the SRP server to notify that a SRP host and possibly SRP services
* Is called by the SRP server to notify that a SRP host and possibly SRP services
* are being updated. It is important that the SRP updates are not committed until the handler
* returns the result by calling otSrpServerHandleServiceUpdateResult or times out after @p aTimeout.
*
@@ -434,7 +434,7 @@ typedef void (*otSrpServerServiceUpdateHandler)(otSrpServerServiceUpdateId aId,
void *aContext);
/**
* This function sets the SRP service updates handler on SRP server.
* Sets the SRP service updates handler on SRP server.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aServiceHandler A pointer to a service handler. Use NULL to remove the handler.
@@ -447,7 +447,7 @@ void otSrpServerSetServiceUpdateHandler(otInstance *aInstanc
void *aContext);
/**
* This function reports the result of processing a SRP update to the SRP server.
* Reports the result of processing a SRP update to the SRP server.
*
* The Service Update Handler should call this function to return the result of its
* processing of a SRP update.
@@ -462,7 +462,7 @@ void otSrpServerSetServiceUpdateHandler(otInstance *aInstanc
void otSrpServerHandleServiceUpdateResult(otInstance *aInstance, otSrpServerServiceUpdateId aId, otError aError);
/**
* This function returns the next registered host on the SRP server.
* Returns the next registered host on the SRP server.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aHost A pointer to current host; use NULL to get the first host.
@@ -473,7 +473,7 @@ void otSrpServerHandleServiceUpdateResult(otInstance *aInstance, otSrpServerServ
const otSrpServerHost *otSrpServerGetNextHost(otInstance *aInstance, const otSrpServerHost *aHost);
/**
* This function returns the response counters of the SRP server.
* Returns the response counters of the SRP server.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -483,7 +483,7 @@ const otSrpServerHost *otSrpServerGetNextHost(otInstance *aInstance, const otSrp
const otSrpServerResponseCounters *otSrpServerGetResponseCounters(otInstance *aInstance);
/**
* This function tells if the SRP service host has been deleted.
* Tells if the SRP service host has been deleted.
*
* A SRP service host can be deleted but retains its name for future uses.
* In this case, the host instance is not removed from the SRP server/registry.
@@ -496,7 +496,7 @@ const otSrpServerResponseCounters *otSrpServerGetResponseCounters(otInstance *aI
bool otSrpServerHostIsDeleted(const otSrpServerHost *aHost);
/**
* This function returns the full name of the host.
* Returns the full name of the host.
*
* @param[in] aHost A pointer to the SRP service host.
*
@@ -506,7 +506,7 @@ bool otSrpServerHostIsDeleted(const otSrpServerHost *aHost);
const char *otSrpServerHostGetFullName(const otSrpServerHost *aHost);
/**
* This function returns the addresses of given host.
* Returns the addresses of given host.
*
* @param[in] aHost A pointer to the SRP service host.
* @param[out] aAddressesNum A pointer to where we should output the number of the addresses to.
@@ -517,7 +517,7 @@ const char *otSrpServerHostGetFullName(const otSrpServerHost *aHost);
const otIp6Address *otSrpServerHostGetAddresses(const otSrpServerHost *aHost, uint8_t *aAddressesNum);
/**
* This function returns the LEASE and KEY-LEASE information of a given host.
* Returns the LEASE and KEY-LEASE information of a given host.
*
* @param[in] aHost A pointer to the SRP server host.
* @param[out] aLeaseInfo A pointer to where to output the LEASE and KEY-LEASE information.
@@ -526,7 +526,7 @@ const otIp6Address *otSrpServerHostGetAddresses(const otSrpServerHost *aHost, ui
void otSrpServerHostGetLeaseInfo(const otSrpServerHost *aHost, otSrpServerLeaseInfo *aLeaseInfo);
/**
* This function returns the next service (excluding any sub-type services) of given host.
* Returns the next service (excluding any sub-type services) of given host.
*
* @note This function is being deprecated and will be removed. `otSrpServerHostFindNextService()` can be used
* instead.
@@ -541,7 +541,7 @@ const otSrpServerService *otSrpServerHostGetNextService(const otSrpServerHost
const otSrpServerService *aService);
/**
* This function finds the next matching service on the host.
* Finds the next matching service on the host.
*
* The combination of flags and service and instance names enables iterating over the full list of services and/or a
* subset of them matching certain conditions, or finding a specific service.
@@ -579,7 +579,7 @@ const otSrpServerService *otSrpServerHostFindNextService(const otSrpServerHost
const char *aInstanceName);
/**
* This function indicates whether or not the SRP service has been deleted.
* Indicates whether or not the SRP service has been deleted.
*
* A SRP service can be deleted but retains its name for future uses.
* In this case, the service instance is not removed from the SRP server/registry.
@@ -593,7 +593,7 @@ const otSrpServerService *otSrpServerHostFindNextService(const otSrpServerHost
bool otSrpServerServiceIsDeleted(const otSrpServerService *aService);
/**
* This function indicates whether or not the SRP service is sub-type.
* Indicates whether or not the SRP service is sub-type.
*
* @param[in] aService A pointer to the SRP service.
*
@@ -603,7 +603,7 @@ bool otSrpServerServiceIsDeleted(const otSrpServerService *aService);
bool otSrpServerServiceIsSubType(const otSrpServerService *aService);
/**
* This function returns the full service instance name of the service.
* Returns the full service instance name of the service.
*
* @note This function is being deprecated and will be removed. `otSrpServerServiceGetInstanceName()` can be used
* instead.
@@ -616,7 +616,7 @@ bool otSrpServerServiceIsSubType(const otSrpServerService *aService);
const char *otSrpServerServiceGetFullName(const otSrpServerService *aService);
/**
* This function returns the full service instance name of the service.
* Returns the full service instance name of the service.
*
* @param[in] aService A pointer to the SRP service.
*
@@ -626,7 +626,7 @@ const char *otSrpServerServiceGetFullName(const otSrpServerService *aService);
const char *otSrpServerServiceGetInstanceName(const otSrpServerService *aService);
/**
* This function returns the full service name of the service.
* Returns the full service name of the service.
*
* @param[in] aService A pointer to the SRP service.
*
@@ -636,9 +636,9 @@ const char *otSrpServerServiceGetInstanceName(const otSrpServerService *aService
const char *otSrpServerServiceGetServiceName(const otSrpServerService *aService);
/**
* This function gets the sub-type label from service name.
* Gets the sub-type label from service name.
*
* This function is intended to be used when the @p aService is a sub-type, i.e., `otSrpServerServiceIsSubType()` for
* Is intended to be used when the @p aService is a sub-type, i.e., `otSrpServerServiceIsSubType()` for
* the service returns TRUE. If it is not a sub-type this function returns `OT_ERROR_INVALID_ARGS`.
*
* The full service name for a sub-type service follows "<sub-label>._sub.<service-labels>.<domain>.". This function
@@ -659,7 +659,7 @@ const char *otSrpServerServiceGetServiceName(const otSrpServerService *aService)
otError otSrpServerServiceGetServiceSubTypeLabel(const otSrpServerService *aService, char *aLabel, uint8_t aMaxSize);
/**
* This function returns the port of the service instance.
* Returns the port of the service instance.
*
* @param[in] aService A pointer to the SRP service.
*
@@ -669,7 +669,7 @@ otError otSrpServerServiceGetServiceSubTypeLabel(const otSrpServerService *aServ
uint16_t otSrpServerServiceGetPort(const otSrpServerService *aService);
/**
* This function returns the weight of the service instance.
* Returns the weight of the service instance.
*
* @param[in] aService A pointer to the SRP service.
*
@@ -679,7 +679,7 @@ uint16_t otSrpServerServiceGetPort(const otSrpServerService *aService);
uint16_t otSrpServerServiceGetWeight(const otSrpServerService *aService);
/**
* This function returns the priority of the service instance.
* Returns the priority of the service instance.
*
* @param[in] aService A pointer to the SRP service.
*
@@ -689,7 +689,7 @@ uint16_t otSrpServerServiceGetWeight(const otSrpServerService *aService);
uint16_t otSrpServerServiceGetPriority(const otSrpServerService *aService);
/**
* This function returns the TTL of the service instance.
* Returns the TTL of the service instance.
*
* @param[in] aService A pointer to the SRP service.
*
@@ -699,7 +699,7 @@ uint16_t otSrpServerServiceGetPriority(const otSrpServerService *aService);
uint32_t otSrpServerServiceGetTtl(const otSrpServerService *aService);
/**
* This function returns the TXT record data of the service instance.
* Returns the TXT record data of the service instance.
*
* @param[in] aService A pointer to the SRP service.
* @param[out] aDataLength A pointer to return the TXT record data length. MUST NOT be NULL.
@@ -710,7 +710,7 @@ uint32_t otSrpServerServiceGetTtl(const otSrpServerService *aService);
const uint8_t *otSrpServerServiceGetTxtData(const otSrpServerService *aService, uint16_t *aDataLength);
/**
* This function returns the host which the service instance reside on.
* Returns the host which the service instance reside on.
*
* @param[in] aService A pointer to the SRP service.
*
@@ -720,7 +720,7 @@ const uint8_t *otSrpServerServiceGetTxtData(const otSrpServerService *aService,
const otSrpServerHost *otSrpServerServiceGetHost(const otSrpServerService *aService);
/**
* This function returns the LEASE and KEY-LEASE information of a given service.
* Returns the LEASE and KEY-LEASE information of a given service.
*
* @param[in] aService A pointer to the SRP server service.
* @param[out] aLeaseInfo A pointer to where to output the LEASE and KEY-LEASE information.
include/openthread/tcp.h
+7 -7
View File
@@ -229,7 +229,7 @@ typedef void (*otTcpDisconnected)(otTcpEndpoint *aEndpoint, otTcpDisconnectedRea
#define OT_TCP_ENDPOINT_TCB_NUM_PTR 36
/**
* This structure represents a TCP endpoint.
* Represents a TCP endpoint.
*
* An TCP endpoint acts an endpoint of TCP connection. It can be used to
* initiate TCP connections, and, once a TCP connection is established, send
@@ -266,7 +266,7 @@ struct otTcpEndpoint
};
/**
* This structure contains arguments to the otTcpEndpointInitialize() function.
* Contains arguments to the otTcpEndpointInitialize() function.
*
*/
typedef struct otTcpEndpointInitializeArgs
@@ -390,7 +390,7 @@ const otSockAddr *otTcpGetPeerAddress(const otTcpEndpoint *aEndpoint);
otError otTcpBind(otTcpEndpoint *aEndpoint, const otSockAddr *aSockName);
/**
* This enumeration defines flags passed to otTcpConnect().
* Defines flags passed to otTcpConnect().
*
*/
enum
@@ -418,7 +418,7 @@ enum
otError otTcpConnect(otTcpEndpoint *aEndpoint, const otSockAddr *aSockName, uint32_t aFlags);
/**
* This enumeration defines flags passed to @p otTcpSendByReference.
* Defines flags passed to @p otTcpSendByReference.
*
*/
enum
@@ -582,7 +582,7 @@ struct otTcpListener;
typedef struct otTcpListener otTcpListener;
/**
* This enumeration defines incoming connection actions.
* Defines incoming connection actions.
*
* This is used in otTcpAcceptReady() callback.
*
@@ -656,7 +656,7 @@ typedef void (*otTcpAcceptDone)(otTcpListener *aListener, otTcpEndpoint *aEndpoi
#define OT_TCP_LISTENER_TCB_NUM_PTR 3
/**
* This structure represents a TCP listener.
* Represents a TCP listener.
*
* A TCP listener is used to listen for and accept incoming TCP connections.
*
@@ -681,7 +681,7 @@ struct otTcpListener
};
/**
* This structure contains arguments to the otTcpListenerInitialize() function.
* Contains arguments to the otTcpListenerInitialize() function.
*
*/
typedef struct otTcpListenerInitializeArgs
include/openthread/tcp_ext.h
+2 -2
View File
@@ -53,7 +53,7 @@ extern "C" {
*/
/**
* This structure represents a circular send buffer for use with a TCP endpoint.
* Represents a circular send buffer for use with a TCP endpoint.
*
* Using a circular send buffer is optional. Applications can use a TCP
* endpoint to send data by managing otLinkedBuffers directly. However, some
@@ -108,7 +108,7 @@ typedef struct otTcpCircularSendBuffer
void otTcpCircularSendBufferInitialize(otTcpCircularSendBuffer *aSendBuffer, void *aDataBuffer, size_t aCapacity);
/**
* This enumeration defines flags passed to @p otTcpCircularSendBufferWrite.
* Defines flags passed to @p otTcpCircularSendBufferWrite.
*
*/
enum
include/openthread/thread.h
+44 -44
View File
@@ -74,7 +74,7 @@ typedef enum
} otDeviceRole;
/**
* This structure represents an MLE Link Mode configuration.
* Represents an MLE Link Mode configuration.
*/
typedef struct otLinkModeConfig
{
@@ -84,7 +84,7 @@ typedef struct otLinkModeConfig
} otLinkModeConfig;
/**
* This structure holds diagnostic information for a neighboring Thread node
* Holds diagnostic information for a neighboring Thread node
*
*/
typedef struct
@@ -113,7 +113,7 @@ typedef struct
typedef int16_t otNeighborInfoIterator; ///< Used to iterate through neighbor table.
/**
* This structure represents the Thread Leader Data.
* Represents the Thread Leader Data.
*
*/
typedef struct otLeaderData
@@ -126,7 +126,7 @@ typedef struct otLeaderData
} otLeaderData;
/**
* This structure holds diagnostic information for a Thread Router
* Holds diagnostic information for a Thread Router
*
*/
typedef struct
@@ -152,7 +152,7 @@ typedef struct
} otRouterInfo;
/**
* This structure represents the IP level counters.
* Represents the IP level counters.
*
*/
typedef struct otIpCounters
@@ -164,7 +164,7 @@ typedef struct otIpCounters
} otIpCounters;
/**
* This structure represents the Thread MLE counters.
* Represents the Thread MLE counters.
*
*/
typedef struct otMleCounters
@@ -203,7 +203,7 @@ typedef struct otMleCounters
} otMleCounters;
/**
* This structure represents the MLE Parent Response data.
* Represents the MLE Parent Response data.
*
*/
typedef struct otThreadParentResponseInfo
@@ -227,7 +227,7 @@ typedef struct otThreadParentResponseInfo
typedef void (*otDetachGracefullyCallback)(void *aContext);
/**
* This function starts Thread protocol operation.
* Starts Thread protocol operation.
*
* The interface must be up when calling this function.
*
@@ -244,7 +244,7 @@ typedef void (*otDetachGracefullyCallback)(void *aContext);
otError otThreadSetEnabled(otInstance *aInstance, bool aEnabled);
/**
* This function gets the Thread protocol version.
* Gets the Thread protocol version.
*
* @returns the Thread protocol version.
*
@@ -252,7 +252,7 @@ otError otThreadSetEnabled(otInstance *aInstance, bool aEnabled);
uint16_t otThreadGetVersion(void);
/**
* This function indicates whether a node is the only router on the network.
* Indicates whether a node is the only router on the network.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -263,7 +263,7 @@ uint16_t otThreadGetVersion(void);
bool otThreadIsSingleton(otInstance *aInstance);
/**
* This function starts a Thread Discovery scan.
* Starts a Thread Discovery scan.
*
* @note A successful call to this function enables the rx-on-when-idle mode for the entire scan procedure.
*
@@ -291,7 +291,7 @@ otError otThreadDiscover(otInstance *aInstance,
void *aCallbackContext);
/**
* This function determines if an MLE Thread Discovery is currently in progress.
* Determines if an MLE Thread Discovery is currently in progress.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -299,7 +299,7 @@ otError otThreadDiscover(otInstance *aInstance,
bool otThreadIsDiscoverInProgress(otInstance *aInstance);
/**
* This method sets the Thread Joiner Advertisement when discovering Thread network.
* Sets the Thread Joiner Advertisement when discovering Thread network.
*
* Thread Joiner Advertisement is used to allow a Joiner to advertise its own application-specific information
* (such as Vendor ID, Product ID, Discriminator, etc.) via a newly-proposed Joiner Advertisement TLV,
@@ -376,7 +376,7 @@ const otExtendedPanId *otThreadGetExtendedPanId(otInstance *aInstance);
otError otThreadSetExtendedPanId(otInstance *aInstance, const otExtendedPanId *aExtendedPanId);
/**
* This function returns a pointer to the Leader's RLOC.
* Returns a pointer to the Leader's RLOC.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[out] aLeaderRloc A pointer to the Leader's RLOC.
@@ -427,7 +427,7 @@ void otThreadGetNetworkKey(otInstance *aInstance, otNetworkKey *aNetworkKey);
/**
* Get the `otNetworkKeyRef` for Thread Network Key.
*
* This function requires the build-time feature `OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE` to be enabled.
* Requires the build-time feature `OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE` to be enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -441,7 +441,7 @@ otNetworkKeyRef otThreadGetNetworkKeyRef(otInstance *aInstance);
/**
* Set the Thread Network Key.
*
* This function succeeds only when Thread protocols are disabled. A successful
* Succeeds only when Thread protocols are disabled. A successful
* call to this function invalidates the Active and Pending Operational Datasets in
* non-volatile memory.
*
@@ -459,11 +459,11 @@ otError otThreadSetNetworkKey(otInstance *aInstance, const otNetworkKey *aKey);
/**
* Set the Thread Network Key as a `otNetworkKeyRef`.
*
* This function succeeds only when Thread protocols are disabled. A successful
* Succeeds only when Thread protocols are disabled. A successful
* call to this function invalidates the Active and Pending Operational Datasets in
* non-volatile memory.
*
* This function requires the build-time feature `OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE` to be enabled.
* Requires the build-time feature `OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE` to be enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aKeyRef Reference to the Thread Network Key.
@@ -497,7 +497,7 @@ const otIp6Address *otThreadGetRloc(otInstance *aInstance);
const otIp6Address *otThreadGetMeshLocalEid(otInstance *aInstance);
/**
* This function returns a pointer to the Mesh Local Prefix.
* Returns a pointer to the Mesh Local Prefix.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -507,9 +507,9 @@ const otIp6Address *otThreadGetMeshLocalEid(otInstance *aInstance);
const otMeshLocalPrefix *otThreadGetMeshLocalPrefix(otInstance *aInstance);
/**
* This function sets the Mesh Local Prefix.
* Sets the Mesh Local Prefix.
*
* This function succeeds only when Thread protocols are disabled. A successful
* Succeeds only when Thread protocols are disabled. A successful
* call to this function invalidates the Active and Pending Operational Datasets in
* non-volatile memory.
*
@@ -569,7 +569,7 @@ const otIp6Address *otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstanc
const otIp6Address *otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance);
/**
* This function retrieves the Service ALOC for given Service ID.
* Retrieves the Service ALOC for given Service ID.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aServiceId Service ID to get ALOC for.
@@ -595,7 +595,7 @@ const char *otThreadGetNetworkName(otInstance *aInstance);
/**
* Set the Thread Network Name.
*
* This function succeeds only when Thread protocols are disabled. A successful
* Succeeds only when Thread protocols are disabled. A successful
* call to this function invalidates the Active and Pending Operational Datasets in
* non-volatile memory.
*
@@ -751,7 +751,7 @@ otError otThreadBecomeDetached(otInstance *aInstance);
otError otThreadBecomeChild(otInstance *aInstance);
/**
* This function gets the next neighbor information. It is used to go through the entries of
* Gets the next neighbor information. It is used to go through the entries of
* the neighbor table.
*
* @param[in] aInstance A pointer to an OpenThread instance.
@@ -791,7 +791,7 @@ otDeviceRole otThreadGetDeviceRole(otInstance *aInstance);
const char *otThreadDeviceRoleToString(otDeviceRole aRole);
/**
* This function get the Thread Leader Data.
* Get the Thread Leader Data.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[out] aLeaderData A pointer to where the leader data is placed.
@@ -921,7 +921,7 @@ const otMleCounters *otThreadGetMleCounters(otInstance *aInstance);
void otThreadResetMleCounters(otInstance *aInstance);
/**
* This function pointer is called every time an MLE Parent Response message is received.
* Pointer is called every time an MLE Parent Response message is received.
*
* This is used in `otThreadRegisterParentResponseCallback()`.
*
@@ -932,9 +932,9 @@ void otThreadResetMleCounters(otInstance *aInstance);
typedef void (*otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext);
/**
* This function registers a callback to receive MLE Parent Response data.
* Registers a callback to receive MLE Parent Response data.
*
* This function requires `OPENTHREAD_CONFIG_MLE_PARENT_RESPONSE_CALLBACK_API_ENABLE`.
* Requires `OPENTHREAD_CONFIG_MLE_PARENT_RESPONSE_CALLBACK_API_ENABLE`.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aCallback A pointer to a function that is called upon receiving an MLE Parent Response message.
@@ -946,7 +946,7 @@ void otThreadRegisterParentResponseCallback(otInstance *aInst
void *aContext);
/**
* This structure represents the Thread Discovery Request data.
* Represents the Thread Discovery Request data.
*
*/
typedef struct otThreadDiscoveryRequestInfo
@@ -957,7 +957,7 @@ typedef struct otThreadDiscoveryRequestInfo
} otThreadDiscoveryRequestInfo;
/**
* This function pointer is called every time an MLE Discovery Request message is received.
* Pointer is called every time an MLE Discovery Request message is received.
*
* @param[in] aInfo A pointer to the Discovery Request info data.
* @param[in] aContext A pointer to callback application-specific context.
@@ -966,7 +966,7 @@ typedef struct otThreadDiscoveryRequestInfo
typedef void (*otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext);
/**
* This function sets a callback to receive MLE Discovery Request data.
* Sets a callback to receive MLE Discovery Request data.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aCallback A pointer to a function that is called upon receiving an MLE Discovery Request message.
@@ -978,7 +978,7 @@ void otThreadSetDiscoveryRequestCallback(otInstance *aInsta
void *aContext);
/**
* This function pointer type defines the callback to notify the outcome of a `otThreadLocateAnycastDestination()`
* Pointer type defines the callback to notify the outcome of a `otThreadLocateAnycastDestination()`
* request.
*
* @param[in] aContext A pointer to an arbitrary context (provided when callback is registered).
@@ -996,9 +996,9 @@ typedef void (*otThreadAnycastLocatorCallback)(void *aContext,
uint16_t aRloc16);
/**
* This function requests the closest destination of a given anycast address to be located.
* Requests the closest destination of a given anycast address to be located.
*
* This function is only available when `OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE` is enabled.
* Is only available when `OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE` is enabled.
*
* If a previous request is ongoing, a subsequent call to this function will cancel and replace the earlier request.
*
@@ -1018,9 +1018,9 @@ otError otThreadLocateAnycastDestination(otInstance *aInstanc
void *aContext);
/**
* This function indicates whether an anycast locate request is currently in progress.
* Indicates whether an anycast locate request is currently in progress.
*
* This function is only available when `OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE` is enabled.
* Is only available when `OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE` is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -1030,9 +1030,9 @@ otError otThreadLocateAnycastDestination(otInstance *aInstanc
bool otThreadIsAnycastLocateInProgress(otInstance *aInstance);
/**
* This function sends a Proactive Address Notification (ADDR_NTF.ntf) message.
* Sends a Proactive Address Notification (ADDR_NTF.ntf) message.
*
* This function is only available when `OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE` is enabled.
* Is only available when `OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE` is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aDestination The destination to send the ADDR_NTF.ntf message.
@@ -1046,9 +1046,9 @@ void otThreadSendAddressNotification(otInstance *aInstance,
otIp6InterfaceIdentifier *aMlIid);
/**
* This function sends a Proactive Backbone Notification (PRO_BB.ntf) message on the Backbone link.
* Sends a Proactive Backbone Notification (PRO_BB.ntf) message on the Backbone link.
*
* This function is only available when `OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE` is enabled.
* Is only available when `OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE` is enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aTarget The target address of the PRO_BB.ntf message.
@@ -1065,7 +1065,7 @@ otError otThreadSendProactiveBackboneNotification(otInstance *aIns
uint32_t aTimeSinceLastTransaction);
/**
* This function notifies other nodes in the network (if any) and then stops Thread protocol operation.
* Notifies other nodes in the network (if any) and then stops Thread protocol operation.
*
* It sends an Address Release if it's a router, or sets its child timeout to 0 if it's a child.
*
@@ -1082,9 +1082,9 @@ otError otThreadDetachGracefully(otInstance *aInstance, otDetachGracefullyCallba
#define OT_DURATION_STRING_SIZE 21 ///< Recommended size for string representation of `uint32_t` duration in seconds.
/**
* This function converts an `uint32_t` duration (in seconds) to a human-readable string.
* Converts an `uint32_t` duration (in seconds) to a human-readable string.
*
* This function requires `OPENTHREAD_CONFIG_UPTIME_ENABLE` to be enabled.
* Requires `OPENTHREAD_CONFIG_UPTIME_ENABLE` to be enabled.
*
* The string follows the format "<hh>:<mm>:<ss>" for hours, minutes, seconds (if duration is shorter than one day) or
* "<dd>d.<hh>:<mm>:<ss>" (if longer than a day).
@@ -1092,7 +1092,7 @@ otError otThreadDetachGracefully(otInstance *aInstance, otDetachGracefullyCallba
* If the resulting string does not fit in @p aBuffer (within its @p aSize characters), the string will be truncated
* but the outputted string is always null-terminated.
*
* This function is intended for use with `mAge` or `mConnectionTime` in `otNeighborInfo` or `otChildInfo` structures.
* Is intended for use with `mAge` or `mConnectionTime` in `otNeighborInfo` or `otChildInfo` structures.
*
* @param[in] aDuration A duration interval in seconds.
* @param[out] aBuffer A pointer to a char array to output the string.
include/openthread/thread_ftd.h
+26 -26
View File
@@ -51,7 +51,7 @@ extern "C" {
*/
/**
* This structure holds diagnostic information for a Thread Child
* Holds diagnostic information for a Thread Child
*
*/
typedef struct
@@ -83,7 +83,7 @@ typedef struct
typedef uint16_t otChildIp6AddressIterator; ///< Used to iterate through IPv6 addresses of a Thread Child entry.
/**
* This enumeration defines the EID cache entry state.
* Defines the EID cache entry state.
*
*/
typedef enum otCacheEntryState
@@ -95,7 +95,7 @@ typedef enum otCacheEntryState
} otCacheEntryState;
/**
* This structure represents an EID cache entry.
* Represents an EID cache entry.
*
*/
typedef struct otCacheEntryInfo
@@ -112,7 +112,7 @@ typedef struct otCacheEntryInfo
} otCacheEntryInfo;
/**
* This type represents an iterator used for iterating through the EID cache table entries.
* Represents an iterator used for iterating through the EID cache table entries.
*
* To initialize the iterator and start from the first entry in the cache table, set all its fields in the structure to
* zero (e.g., `memset` the iterator to zero).
@@ -153,7 +153,7 @@ uint16_t otThreadGetMaxAllowedChildren(otInstance *aInstance);
otError otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren);
/**
* This method indicates whether or not the device is router-eligible.
* Indicates whether or not the device is router-eligible.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -164,7 +164,7 @@ otError otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildr
bool otThreadIsRouterEligible(otInstance *aInstance);
/**
* This function sets whether or not the device is router-eligible.
* Sets whether or not the device is router-eligible.
*
* If @p aEligible is false and the device is currently operating as a router, this call will cause the device to
* detach and attempt to reattach as a child.
@@ -198,7 +198,7 @@ otError otThreadSetRouterEligible(otInstance *aInstance, bool aEligible);
otError otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId);
/**
* This enumeration represents the power supply property on a device.
* Represents the power supply property on a device.
*
* This is used as a property in `otDeviceProperties` to calculate the leader weight.
*
@@ -212,7 +212,7 @@ typedef enum
} otPowerSupply;
/**
* This structure represents the device properties which are used for calculating the local leader weight on a
* Represents the device properties which are used for calculating the local leader weight on a
* device.
*
* The parameters are set based on device's capability, whether acting as border router, its power supply config, etc.
@@ -266,7 +266,7 @@ uint8_t otThreadGetLocalLeaderWeight(otInstance *aInstance);
/**
* Sets the Thread Leader Weight used when operating in the Leader role.
*
* This function directly sets the Leader Weight to the new value, replacing its previous value (which may have been
* Directly sets the Leader Weight to the new value, replacing its previous value (which may have been
* determined from the current `otDeviceProperties`).
*
* @param[in] aInstance A pointer to an OpenThread instance.
@@ -570,7 +570,7 @@ otError otThreadGetChildInfoById(otInstance *aInstance, uint16_t aChildId, otChi
otError otThreadGetChildInfoByIndex(otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo);
/**
* This function gets the next IPv6 address (using an iterator) for a given child.
* Gets the next IPv6 address (using an iterator) for a given child.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aChildIndex The child index.
@@ -626,7 +626,7 @@ uint8_t otThreadGetMaxRouterId(otInstance *aInstance);
otError otThreadGetRouterInfo(otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo);
/**
* This function gets the next EID cache entry (using an iterator).
* Gets the next EID cache entry (using an iterator).
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[out] aEntryInfo A pointer to where the EID cache entry information is placed.
@@ -654,7 +654,7 @@ void otThreadGetPskc(otInstance *aInstance, otPskc *aPskc);
/**
* Get Key Reference to Thread PSKc stored
*
* This function requires the build-time feature `OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE` to be enabled.
* Requires the build-time feature `OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE` to be enabled.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -668,7 +668,7 @@ otPskcRef otThreadGetPskcRef(otInstance *aInstance);
/**
* Set the Thread PSKc
*
* This function will only succeed when Thread protocols are disabled. A successful
* Will only succeed when Thread protocols are disabled. A successful
* call to this function will also invalidate the Active and Pending Operational Datasets in
* non-volatile memory.
*
@@ -686,9 +686,9 @@ otError otThreadSetPskc(otInstance *aInstance, const otPskc *aPskc);
/**
* Set the Thread PSKc
*
* This function requires the build-time feature `OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE` to be enabled.
* Requires the build-time feature `OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE` to be enabled.
*
* This function will only succeed when Thread protocols are disabled. A successful
* Will only succeed when Thread protocols are disabled. A successful
* call to this function will also invalidate the Active and Pending Operational Datasets in
* non-volatile memory.
*
@@ -768,7 +768,7 @@ uint8_t otThreadGetMaxChildIpAddresses(otInstance *aInstance);
otError otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses);
/**
* This enumeration defines the constants used in `otNeighborTableCallback` to indicate changes in neighbor table.
* Defines the constants used in `otNeighborTableCallback` to indicate changes in neighbor table.
*
*/
typedef enum
@@ -781,7 +781,7 @@ typedef enum
} otNeighborTableEvent;
/**
* This type represent a neighbor table entry info (child or router) and is used as a parameter in the neighbor table
* Represent a neighbor table entry info (child or router) and is used as a parameter in the neighbor table
* callback `otNeighborTableCallback`.
*
*/
@@ -796,7 +796,7 @@ typedef struct
} otNeighborTableEntryInfo;
/**
* This function pointer is called to notify that there is a change in the neighbor table.
* Pointer is called to notify that there is a change in the neighbor table.
*
* @param[in] aEvent A event flag.
* @param[in] aEntryInfo A pointer to table entry info.
@@ -805,7 +805,7 @@ typedef struct
typedef void (*otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo);
/**
* This function registers a neighbor table callback function.
* Registers a neighbor table callback function.
*
* The provided callback (if non-NULL) will be invoked when there is a change in the neighbor table (e.g., a child or a
* router neighbor entry is being added/removed or an existing child's mode is changed).
@@ -820,7 +820,7 @@ typedef void (*otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNei
void otThreadRegisterNeighborTableCallback(otInstance *aInstance, otNeighborTableCallback aCallback);
/**
* This function sets whether the device was commissioned using CCM.
* Sets whether the device was commissioned using CCM.
*
* @note This API requires `OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE`, and is only used by Thread Test Harness
* to indicate whether this device was commissioned using CCM.
@@ -832,7 +832,7 @@ void otThreadRegisterNeighborTableCallback(otInstance *aInstance, otNeighborTabl
void otThreadSetCcmEnabled(otInstance *aInstance, bool aEnabled);
/**
* This function sets whether the Security Policy TLV version-threshold for routing (VR field) is enabled.
* Sets whether the Security Policy TLV version-threshold for routing (VR field) is enabled.
*
* @note This API requires `OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE`, and is only used by Thread Test Harness
* to indicate that thread protocol version check VR should be skipped.
@@ -844,7 +844,7 @@ void otThreadSetCcmEnabled(otInstance *aInstance, bool aEnabled);
void otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled);
/**
* This function gets the range of router IDs that are allowed to assign to nodes within the thread network.
* Gets the range of router IDs that are allowed to assign to nodes within the thread network.
*
* @note This API requires `OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE`, and is only used for test purpose. All the
* router IDs in the range [aMinRouterId, aMaxRouterId] are allowed.
@@ -859,7 +859,7 @@ void otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled);
void otThreadGetRouterIdRange(otInstance *aInstance, uint8_t *aMinRouterId, uint8_t *aMaxRouterId);
/**
* This function sets the range of router IDs that are allowed to assign to nodes within the thread network.
* Sets the range of router IDs that are allowed to assign to nodes within the thread network.
*
* @note This API requires `OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE`, and is only used for test purpose. All the
* router IDs in the range [aMinRouterId, aMaxRouterId] are allowed.
@@ -877,7 +877,7 @@ void otThreadGetRouterIdRange(otInstance *aInstance, uint8_t *aMinRouterId, uint
otError otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId);
/**
* This function indicates whether or not a Router ID is currently allocated.
* Indicates whether or not a Router ID is currently allocated.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aRouterId The router ID to check.
@@ -889,9 +889,9 @@ otError otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, ui
bool otThreadIsRouterIdAllocated(otInstance *aInstance, uint8_t aRouterId);
/**
* This function gets the next hop and path cost towards a given RLOC16 destination.
* Gets the next hop and path cost towards a given RLOC16 destination.
*
* This function can be used with either @p aNextHopRloc16 or @p aPathCost being NULL indicating caller does not want
* Can be used with either @p aNextHopRloc16 or @p aPathCost being NULL indicating caller does not want
* to get the value.
*
* @param[in] aInstance A pointer to an OpenThread instance.
include/openthread/trel.h
+7 -7
View File
@@ -57,7 +57,7 @@ extern "C" {
*/
/**
* This struct represents a TREL peer.
* Represents a TREL peer.
*
*/
typedef struct otTrelPeer
@@ -68,7 +68,7 @@ typedef struct otTrelPeer
} otTrelPeer;
/**
* This type represents an iterator for iterating over TREL peer table entries.
* Represents an iterator for iterating over TREL peer table entries.
*
*/
typedef uint16_t otTrelPeerIterator;
@@ -93,7 +93,7 @@ typedef uint16_t otTrelPeerIterator;
void otTrelSetEnabled(otInstance *aInstance, bool aEnable);
/**
* This function indicates whether the TREL operation is enabled.
* Indicates whether the TREL operation is enabled.
*
* @param[in] aInstance The OpenThread instance.
*
@@ -104,7 +104,7 @@ void otTrelSetEnabled(otInstance *aInstance, bool aEnable);
bool otTrelIsEnabled(otInstance *aInstance);
/**
* This function initializes a peer table iterator.
* Initializes a peer table iterator.
*
* @param[in] aInstance The OpenThread instance.
* @param[in] aIterator The iterator to initialize.
@@ -113,7 +113,7 @@ bool otTrelIsEnabled(otInstance *aInstance);
void otTrelInitPeerIterator(otInstance *aInstance, otTrelPeerIterator *aIterator);
/**
* This function iterates over the peer table entries and get the next entry from the table
* Iterates over the peer table entries and get the next entry from the table
*
* @param[in] aInstance The OpenThread instance.
* @param[in] aIterator The iterator. MUST be initialized.
@@ -124,7 +124,7 @@ void otTrelInitPeerIterator(otInstance *aInstance, otTrelPeerIterator *aIterator
const otTrelPeer *otTrelGetNextPeer(otInstance *aInstance, otTrelPeerIterator *aIterator);
/**
* This function sets the filter mode (enables/disables filtering).
* Sets the filter mode (enables/disables filtering).
*
* When filter mode is enabled, any rx and tx traffic through TREL interface is silently dropped. This is mainly
* intended for use during testing.
@@ -139,7 +139,7 @@ const otTrelPeer *otTrelGetNextPeer(otInstance *aInstance, otTrelPeerIterator *a
void otTrelSetFilterEnabled(otInstance *aInstance, bool aEnable);
/**
* This function indicates whether or not the filter mode is enabled.
* Indicates whether or not the filter mode is enabled.
*
* @param[in] aInstance The OpenThread instance.
*
include/openthread/udp.h
+8 -8
View File
@@ -63,7 +63,7 @@ extern "C" {
typedef bool (*otUdpHandler)(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo);
/**
* This structure represents a UDP receiver.
* Represents a UDP receiver.
*
*/
typedef struct otUdpReceiver
@@ -74,7 +74,7 @@ typedef struct otUdpReceiver
} otUdpReceiver;
/**
* This function adds a UDP receiver.
* Adds a UDP receiver.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aUdpReceiver A pointer to the UDP receiver.
@@ -86,7 +86,7 @@ typedef struct otUdpReceiver
otError otUdpAddReceiver(otInstance *aInstance, otUdpReceiver *aUdpReceiver);
/**
* This function removes a UDP receiver.
* Removes a UDP receiver.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aUdpReceiver A pointer to the UDP receiver.
@@ -98,7 +98,7 @@ otError otUdpAddReceiver(otInstance *aInstance, otUdpReceiver *aUdpReceiver);
otError otUdpRemoveReceiver(otInstance *aInstance, otUdpReceiver *aUdpReceiver);
/**
* This function sends a UDP message without socket.
* Sends a UDP message without socket.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aMessage A pointer to a message without UDP header.
@@ -117,7 +117,7 @@ otError otUdpSendDatagram(otInstance *aInstance, otMessage *aMessage, otMessageI
typedef void (*otUdpReceive)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo);
/**
* This structure represents a UDP socket.
* Represents a UDP socket.
*
*/
typedef struct otUdpSocket
@@ -131,7 +131,7 @@ typedef struct otUdpSocket
} otUdpSocket;
/**
* This enumeration defines the OpenThread network interface identifiers.
* Defines the OpenThread network interface identifiers.
*
*/
typedef enum otNetifIdentifier
@@ -241,7 +241,7 @@ otError otUdpConnect(otInstance *aInstance, otUdpSocket *aSocket, const otSockAd
otError otUdpSend(otInstance *aInstance, otUdpSocket *aSocket, otMessage *aMessage, const otMessageInfo *aMessageInfo);
/**
* This function gets the head of linked list of UDP Sockets.
* Gets the head of linked list of UDP Sockets.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -269,7 +269,7 @@ otUdpSocket *otUdpGetSockets(otInstance *aInstance);
*/
/**
* This function pointer delivers the UDP packet to host and host should send the packet through its own network stack.
* Pointer delivers the UDP packet to host and host should send the packet through its own network stack.
*
* @param[in] aMessage A pointer to the UDP Message.
* @param[in] aPeerPort The destination UDP port.
src/cli/cli.hpp
+12 -12
View File
@@ -101,7 +101,7 @@ extern "C" void otCliOutputBytes(const uint8_t *aBytes, uint8_t aLength);
extern "C" void otCliOutputFormat(const char *aFmt, ...);
/**
* This class implements the CLI interpreter.
* Implements the CLI interpreter.
*
*/
class Interpreter : public OutputImplementer, public Output
@@ -132,7 +132,7 @@ public:
explicit Interpreter(Instance *aInstance, otCliOutputCallback aCallback, void *aContext);
/**
* This method returns a reference to the interpreter object.
* Returns a reference to the interpreter object.
*
* @returns A reference to the interpreter object.
*
@@ -145,7 +145,7 @@ public:
}
/**
* This method initializes the Console interpreter.
* Initializes the Console interpreter.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aCallback A pointer to a callback method.
@@ -155,7 +155,7 @@ public:
static void Initialize(otInstance *aInstance, otCliOutputCallback aCallback, void *aContext);
/**
* This method returns whether the interpreter is initialized.
* Returns whether the interpreter is initialized.
*
* @returns Whether the interpreter is initialized.
*
@@ -163,7 +163,7 @@ public:
static bool IsInitialized(void) { return sInterpreter != nullptr; }
/**
* This method interprets a CLI command.
* Interprets a CLI command.
*
* @param[in] aBuf A pointer to a string.
*
@@ -171,7 +171,7 @@ public:
void ProcessLine(char *aBuf);
/**
* This static method checks a given argument string against "enable" or "disable" commands.
* Checks a given argument string against "enable" or "disable" commands.
*
* @param[in] aArg The argument string to parse.
* @param[out] aEnable Boolean variable to return outcome on success.
@@ -184,7 +184,7 @@ public:
static otError ParseEnableOrDisable(const Arg &aArg, bool &aEnable);
/**
* This method adds commands to the user command table.
* Adds commands to the user command table.
*
* @param[in] aCommands A pointer to an array with user commands.
* @param[in] aLength @p aUserCommands length.
@@ -198,7 +198,7 @@ public:
static constexpr uint8_t kLinkModeStringSize = sizeof("rdn"); ///< Size of string buffer for a MLE Link Mode.
/**
* This method converts a given MLE Link Mode to flag string.
* Converts a given MLE Link Mode to flag string.
*
* The characters 'r', 'd', and 'n' are respectively used for `mRxOnWhenIdle`, `mDeviceType` and `mNetworkData`
* flags. If all flags are `false`, then "-" is returned.
@@ -212,7 +212,7 @@ public:
static const char *LinkModeToString(const otLinkModeConfig &aLinkMode, char (&aStringBuffer)[kLinkModeStringSize]);
/**
* This method converts an IPv6 address origin `OT_ADDRESS_ORIGIN_*` value to human-readable string.
* Converts an IPv6 address origin `OT_ADDRESS_ORIGIN_*` value to human-readable string.
*
* @param[in] aOrigin The IPv6 address origin to convert.
*
@@ -222,7 +222,7 @@ public:
static const char *AddressOriginToString(uint8_t aOrigin);
/**
* This static method parses a given argument string as a route preference comparing it against "high", "med", or
* Parses a given argument string as a route preference comparing it against "high", "med", or
* "low".
*
* @param[in] aArg The argument string to parse.
@@ -235,7 +235,7 @@ public:
static otError ParsePreference(const Arg &aArg, otRoutePreference &aPreference);
/**
* This static method converts a route preference value to human-readable string.
* Converts a route preference value to human-readable string.
*
* @param[in] aPreference The preference value to convert (`OT_ROUTE_PREFERENCE_*` values).
*
@@ -245,7 +245,7 @@ public:
static const char *PreferenceToString(signed int aPreference);
/**
* This method parses the argument as an IP address.
* Parses the argument as an IP address.
*
* If the argument string is an IPv4 address, this method will try to synthesize an IPv6 address using preferred
* NAT64 prefix in the network data.
src/cli/cli_br.hpp
+2 -2
View File
@@ -45,7 +45,7 @@ namespace ot {
namespace Cli {
/**
* This class implements the Border Router CLI interpreter.
* Implements the Border Router CLI interpreter.
*
*/
class Br : private Output
@@ -66,7 +66,7 @@ public:
}
/**
* This method processes a CLI sub-command.
* Processes a CLI sub-command.
*
* @param[in] aArgs An array of command line arguments.
*
src/cli/cli_coap.hpp
+2 -2
View File
@@ -46,7 +46,7 @@ namespace ot {
namespace Cli {
/**
* This class implements the CLI CoAP server and client.
* Implements the CLI CoAP server and client.
*
*/
class Coap : private Output
@@ -64,7 +64,7 @@ public:
Coap(otInstance *aInstance, OutputImplementer &aOutputImplementer);
/**
* This method processes a CLI sub-command.
* Processes a CLI sub-command.
*
* @param[in] aArgs An array of command line arguments.
*
src/cli/cli_coap_secure.hpp
+2 -2
View File
@@ -52,7 +52,7 @@ namespace ot {
namespace Cli {
/**
* This class implements the CLI CoAP Secure server and client.
* Implements the CLI CoAP Secure server and client.
*
*/
class CoapSecure : private Output
@@ -70,7 +70,7 @@ public:
CoapSecure(otInstance *aInstance, OutputImplementer &aOutputImplementer);
/**
* This method processes a CLI sub-command.
* Processes a CLI sub-command.
*
* @param[in] aArgs An array of command line arguments.
*
src/cli/cli_commissioner.hpp
+2 -2
View File
@@ -46,7 +46,7 @@ namespace ot {
namespace Cli {
/**
* This class implements the Commissioner CLI interpreter.
* Implements the Commissioner CLI interpreter.
*
*/
class Commissioner : private Output
@@ -67,7 +67,7 @@ public:
}
/**
* This method processes a CLI sub-command.
* Processes a CLI sub-command.
*
* @param[in] aArgs An array of command line arguments.
*
src/cli/cli_dataset.hpp
+2 -2
View File
@@ -46,7 +46,7 @@ namespace ot {
namespace Cli {
/**
* This class implements the Dataset CLI interpreter.
* Implements the Dataset CLI interpreter.
*
*/
class Dataset : private Output
@@ -60,7 +60,7 @@ public:
}
/**
* This method processes a CLI sub-command.
* Processes a CLI sub-command.
*
* @param[in] aArgs An array of command line arguments.
*
src/cli/cli_dns.hpp
+2 -2
View File
@@ -60,7 +60,7 @@ namespace ot {
namespace Cli {
/**
* This class implements the DNS CLI interpreter.
* Implements the DNS CLI interpreter.
*
*/
class Dns : private Output
@@ -81,7 +81,7 @@ public:
}
/**
* This method processes a CLI sub-command.
* Processes a CLI sub-command.
*
* @param[in] aArgs An array of command line arguments.
*
src/cli/cli_history.hpp
+2 -2
View File
@@ -47,7 +47,7 @@ namespace ot {
namespace Cli {
/**
* This class implements the History Tracker CLI interpreter.
* Implements the History Tracker CLI interpreter.
*
*/
class History : private Output
@@ -68,7 +68,7 @@ public:
}
/**
* This method processes a CLI sub-command.
* Processes a CLI sub-command.
*
* @param[in] aArgs An array of command line arguments.
*
src/cli/cli_joiner.hpp
+2 -2
View File
@@ -46,7 +46,7 @@ namespace ot {
namespace Cli {
/**
* This class implements the Joiner CLI interpreter.
* Implements the Joiner CLI interpreter.
*
*/
class Joiner : private Output
@@ -67,7 +67,7 @@ public:
}
/**
* This method processes a CLI sub-command.
* Processes a CLI sub-command.
*
* @param[in] aArgs An array of command line arguments.
*
src/cli/cli_mac_filter.hpp
+2 -2
View File
@@ -47,7 +47,7 @@ namespace ot {
namespace Cli {
/**
* This class implements the MAC Filter CLI interpreter.
* Implements the MAC Filter CLI interpreter.
*
*/
class MacFilter : private Output
@@ -68,7 +68,7 @@ public:
}
/**
* This method processes a CLI sub-command.
* Processes a CLI sub-command.
*
* @param[in] aArgs An array of command line arguments.
*
src/cli/cli_network_data.hpp
+7 -7
View File
@@ -44,7 +44,7 @@ namespace ot {
namespace Cli {
/**
* This class implements the Network Data CLI.
* Implements the Network Data CLI.
*
*/
class NetworkData : private Output
@@ -77,7 +77,7 @@ public:
}
/**
* This method processes a CLI sub-command.
* Processes a CLI sub-command.
*
* @param[in] aArgs An array of command line arguments.
*
@@ -91,7 +91,7 @@ public:
otError Process(Arg aArgs[]);
/**
* This method outputs the prefix config.
* Outputs the prefix config.
*
* @param[in] aConfig The prefix config.
*
@@ -99,7 +99,7 @@ public:
void OutputPrefix(const otBorderRouterConfig &aConfig);
/**
* This method outputs the route config.
* Outputs the route config.
*
* @param[in] aConfig The route config.
*
@@ -107,7 +107,7 @@ public:
void OutputRoute(const otExternalRouteConfig &aConfig);
/**
* This method outputs the service config.
* Outputs the service config.
*
* @param[in] aConfig The service config.
*
@@ -115,7 +115,7 @@ public:
void OutputService(const otServiceConfig &aConfig);
/**
* This method converts the flags from a given prefix config to string.
* Converts the flags from a given prefix config to string.
*
* @param[in] aConfig The prefix config.
* @param[out] aString The string to populate from @a Config flags.
@@ -124,7 +124,7 @@ public:
static void PrefixFlagsToString(const otBorderRouterConfig &aConfig, FlagsString &aString);
/**
* This method converts the flags from a given route config to string.
* Converts the flags from a given route config to string.
*
* @param[in] aConfig The route config.
* @param[out] aString The string to populate from @a Config flags.
src/cli/cli_output.hpp
+39 -39
View File
@@ -51,7 +51,7 @@ namespace ot {
namespace Cli {
/**
* This type represents a ID number value associated with a CLI command string.
* Represents a ID number value associated with a CLI command string.
*
*/
typedef uint64_t CommandId;
@@ -72,7 +72,7 @@ constexpr static CommandId Cmd(const char *aString)
class Output;
/**
* This class implements the basic output functions.
* Implements the basic output functions.
*
*/
class OutputImplementer
@@ -81,7 +81,7 @@ class OutputImplementer
public:
/**
* This constructor initializes the `OutputImplementer` object.
* Initializes the `OutputImplementer` object.
*
* @param[in] aCallback A pointer to an `otCliOutputCallback` to deliver strings to the CLI console.
* @param[in] aCallbackContext An arbitrary context to pass in when invoking @p aCallback.
@@ -110,7 +110,7 @@ private:
};
/**
* This class provides CLI output helper methods.
* Provides CLI output helper methods.
*
*/
class Output
@@ -119,7 +119,7 @@ public:
typedef Utils::CmdLineParser::Arg Arg; ///< An argument
/**
* This structure represent a CLI command table entry, mapping a command with `aName` to a handler method.
* Represent a CLI command table entry, mapping a command with `aName` to a handler method.
*
* @tparam Cli The CLI module type.
*
@@ -129,7 +129,7 @@ public:
typedef otError (Cli::*Handler)(Arg aArgs[]); ///< The handler method pointer type.
/**
* This method compares the entry's name with a given name.
* Compares the entry's name with a given name.
*
* @param aName The name string to compare with.
*
@@ -183,7 +183,7 @@ public:
}
/**
* This constructor initializes the `Output` object.
* Initializes the `Output` object.
*
* @param[in] aInstance A pointer to OpenThread instance.
* @param[in] aImplementer An `OutputImplementer`.
@@ -196,7 +196,7 @@ public:
}
/**
* This method returns the pointer to OpenThread instance.
* Returns the pointer to OpenThread instance.
*
* @returns The pointer to the OpenThread instance.
*
@@ -204,7 +204,7 @@ public:
otInstance *GetInstancePtr(void) { return mInstance; }
/**
* This structure represents a buffer which is used when converting a `uint64` value to string in decimal format.
* Represents a buffer which is used when converting a `uint64` value to string in decimal format.
*
*/
struct Uint64StringBuffer
@@ -215,7 +215,7 @@ public:
};
/**
* This static method converts a `uint64_t` value to a decimal format string.
* Converts a `uint64_t` value to a decimal format string.
*
* @param[in] aUint64 The `uint64_t` value to convert.
* @param[in] aBuffer A buffer to allocate the string from.
@@ -226,7 +226,7 @@ public:
static const char *Uint64ToString(uint64_t aUint64, Uint64StringBuffer &aBuffer);
/**
* This method delivers a formatted output string to the CLI console.
* Delivers a formatted output string to the CLI console.
*
* @param[in] aFormat A pointer to the format string.
* @param[in] ... A variable list of arguments to format.
@@ -235,7 +235,7 @@ public:
void OutputFormat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2, 3);
/**
* This method delivers a formatted output string to the CLI console (to which it prepends a given number
* Delivers a formatted output string to the CLI console (to which it prepends a given number
* indentation space chars).
*
* @param[in] aIndentSize Number of indentation space chars to prepend to the string.
@@ -246,7 +246,7 @@ public:
void OutputFormat(uint8_t aIndentSize, const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(3, 4);
/**
* This method delivers a formatted output string to the CLI console (to which it also appends newline "\r\n").
* Delivers a formatted output string to the CLI console (to which it also appends newline "\r\n").
*
* @param[in] aFormat A pointer to the format string.
* @param[in] ... A variable list of arguments to format.
@@ -255,7 +255,7 @@ public:
void OutputLine(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2, 3);
/**
* This method delivers a formatted output string to the CLI console (to which it prepends a given number
* Delivers a formatted output string to the CLI console (to which it prepends a given number
* indentation space chars and appends newline "\r\n").
*
* @param[in] aIndentSize Number of indentation space chars to prepend to the string.
@@ -266,13 +266,13 @@ public:
void OutputLine(uint8_t aIndentSize, const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(3, 4);
/**
* This method delivered newline "\r\n" to the CLI console.
* Delivered newline "\r\n" to the CLI console.
*
*/
void OutputNewLine(void);
/**
* This method outputs a given number of space chars to the CLI console.
* Outputs a given number of space chars to the CLI console.
*
* @param[in] aCount Number of space chars to output.
*
@@ -280,7 +280,7 @@ public:
void OutputSpaces(uint8_t aCount);
/**
* This method outputs a number of bytes to the CLI console as a hex string.
* Outputs a number of bytes to the CLI console as a hex string.
*
* @param[in] aBytes A pointer to data which should be printed.
* @param[in] aLength @p aBytes length.
@@ -289,7 +289,7 @@ public:
void OutputBytes(const uint8_t *aBytes, uint16_t aLength);
/**
* This method outputs a number of bytes to the CLI console as a hex string and at the end it also outputs newline
* Outputs a number of bytes to the CLI console as a hex string and at the end it also outputs newline
* "\r\n".
*
* @param[in] aBytes A pointer to data which should be printed.
@@ -299,7 +299,7 @@ public:
void OutputBytesLine(const uint8_t *aBytes, uint16_t aLength);
/**
* This method outputs a number of bytes to the CLI console as a hex string.
* Outputs a number of bytes to the CLI console as a hex string.
*
* @tparam kBytesLength The length of @p aBytes array.
*
@@ -312,7 +312,7 @@ public:
}
/**
* This method outputs a number of bytes to the CLI console as a hex string and at the end it also outputs newline
* Outputs a number of bytes to the CLI console as a hex string and at the end it also outputs newline
* "\r\n".
*
* @tparam kBytesLength The length of @p aBytes array.
@@ -326,7 +326,7 @@ public:
}
/**
* This method outputs an Extended MAC Address to the CLI console.
* Outputs an Extended MAC Address to the CLI console.
*
* param[in] aExtAddress The Extended MAC Address to output.
*
@@ -334,7 +334,7 @@ public:
void OutputExtAddress(const otExtAddress &aExtAddress) { OutputBytes(aExtAddress.m8); }
/**
* This method outputs an Extended MAC Address to the CLI console and at the end it also outputs newline "\r\n".
* Outputs an Extended MAC Address to the CLI console and at the end it also outputs newline "\r\n".
*
* param[in] aExtAddress The Extended MAC Address to output.
*
@@ -342,7 +342,7 @@ public:
void OutputExtAddressLine(const otExtAddress &aExtAddress) { OutputBytesLine(aExtAddress.m8); }
/**
* This method outputs a `uint64_t` value in decimal format.
* Outputs a `uint64_t` value in decimal format.
*
* @param[in] aUint64 The `uint64_t` value to output.
*
@@ -350,7 +350,7 @@ public:
void OutputUint64(uint64_t aUint64);
/**
* This method outputs a `uint64_t` value in decimal format and at the end it also outputs newline "\r\n".
* Outputs a `uint64_t` value in decimal format and at the end it also outputs newline "\r\n".
*
* @param[in] aUint64 The `uint64_t` value to output.
*
@@ -358,7 +358,7 @@ public:
void OutputUint64Line(uint64_t aUint64);
/**
* This method outputs "Enabled" or "Disabled" status to the CLI console (it also appends newline "\r\n").
* Outputs "Enabled" or "Disabled" status to the CLI console (it also appends newline "\r\n").
*
* @param[in] aEnabled A boolean indicating the status. TRUE outputs "Enabled", FALSE outputs "Disabled".
*
@@ -368,7 +368,7 @@ public:
#if OPENTHREAD_FTD || OPENTHREAD_MTD
/**
* This method outputs an IPv6 address to the CLI console.
* Outputs an IPv6 address to the CLI console.
*
* @param[in] aAddress A reference to the IPv6 address.
*
@@ -376,7 +376,7 @@ public:
void OutputIp6Address(const otIp6Address &aAddress);
/**
* This method outputs an IPv6 address to the CLI console and at the end it also outputs newline "\r\n".
* Outputs an IPv6 address to the CLI console and at the end it also outputs newline "\r\n".
*
* @param[in] aAddress A reference to the IPv6 address.
*
@@ -384,7 +384,7 @@ public:
void OutputIp6AddressLine(const otIp6Address &aAddress);
/**
* This method outputs an IPv6 prefix to the CLI console.
* Outputs an IPv6 prefix to the CLI console.
*
* @param[in] aPrefix A reference to the IPv6 prefix.
*
@@ -392,7 +392,7 @@ public:
void OutputIp6Prefix(const otIp6Prefix &aPrefix);
/**
* This method outputs an IPv6 prefix to the CLI console and at the end it also outputs newline "\r\n".
* Outputs an IPv6 prefix to the CLI console and at the end it also outputs newline "\r\n".
*
* @param[in] aPrefix A reference to the IPv6 prefix.
*
@@ -400,7 +400,7 @@ public:
void OutputIp6PrefixLine(const otIp6Prefix &aPrefix);
/**
* This method outputs an IPv6 network prefix to the CLI console.
* Outputs an IPv6 network prefix to the CLI console.
*
* @param[in] aPrefix A reference to the IPv6 network prefix.
*
@@ -408,7 +408,7 @@ public:
void OutputIp6Prefix(const otIp6NetworkPrefix &aPrefix);
/**
* This method outputs an IPv6 network prefix to the CLI console and at the end it also outputs newline "\r\n".
* Outputs an IPv6 network prefix to the CLI console and at the end it also outputs newline "\r\n".
*
* @param[in] aPrefix A reference to the IPv6 network prefix.
*
@@ -416,7 +416,7 @@ public:
void OutputIp6PrefixLine(const otIp6NetworkPrefix &aPrefix);
/**
* This method outputs an IPv6 socket address to the CLI console.
* Outputs an IPv6 socket address to the CLI console.
*
* @param[in] aSockAddr A reference to the IPv6 socket address.
*
@@ -424,7 +424,7 @@ public:
void OutputSockAddr(const otSockAddr &aSockAddr);
/**
* This method outputs an IPv6 socket address to the CLI console and at the end it also outputs newline "\r\n".
* Outputs an IPv6 socket address to the CLI console and at the end it also outputs newline "\r\n".
*
* @param[in] aSockAddr A reference to the IPv6 socket address.
*
@@ -432,7 +432,7 @@ public:
void OutputSockAddrLine(const otSockAddr &aSockAddr);
/**
* This method outputs DNS TXT data to the CLI console.
* Outputs DNS TXT data to the CLI console.
*
* @param[in] aTxtData A pointer to a buffer containing the DNS TXT data.
* @param[in] aTxtDataLength The length of @p aTxtData (in bytes).
@@ -441,7 +441,7 @@ public:
void OutputDnsTxtData(const uint8_t *aTxtData, uint16_t aTxtDataLength);
/**
* This structure represents a buffer which is used when converting an encoded rate value to percentage string.
* Represents a buffer which is used when converting an encoded rate value to percentage string.
*
*/
struct PercentageStringBuffer
@@ -452,7 +452,7 @@ public:
};
/**
* This static method converts an encoded value to a percentage representation.
* Converts an encoded value to a percentage representation.
*
* The encoded @p aValue is assumed to be linearly scaled such that `0` maps to 0% and `0xffff` maps to 100%.
*
@@ -469,7 +469,7 @@ public:
#endif // OPENTHREAD_FTD || OPENTHREAD_MTD
/**
* This method outputs a table header to the CLI console.
* Outputs a table header to the CLI console.
*
* An example of the table header format:
*
@@ -492,7 +492,7 @@ public:
}
/**
* This method outputs a table separator to the CLI console.
* Outputs a table separator to the CLI console.
*
* An example of the table separator:
*
@@ -511,7 +511,7 @@ public:
}
/**
* This method outputs the list of commands from a given command table.
* Outputs the list of commands from a given command table.
*
* @tparam Cli The CLI module type.
* @tparam kLength The length of command table array.
src/cli/cli_srp_client.hpp
+2 -2
View File
@@ -48,7 +48,7 @@ namespace ot {
namespace Cli {
/**
* This class implements the SRP Client CLI interpreter.
* Implements the SRP Client CLI interpreter.
*
*/
class SrpClient : private Output
@@ -66,7 +66,7 @@ public:
SrpClient(otInstance *aInstance, OutputImplementer &aOutputImplementer);
/**
* This method processes a CLI sub-command.
* Processes a CLI sub-command.
*
* @param[in] aArgs An array of command line arguments.
*
src/cli/cli_srp_server.hpp
+2 -2
View File
@@ -46,7 +46,7 @@ namespace ot {
namespace Cli {
/**
* This class implements the SRP Server CLI interpreter.
* Implements the SRP Server CLI interpreter.
*
*/
class SrpServer : private Output
@@ -67,7 +67,7 @@ public:
}
/**
* This method processes a CLI sub-command.
* Processes a CLI sub-command.
*
* @param[in] aArgs An array of command line arguments.
*
src/cli/cli_tcp.hpp
+2 -2
View File
@@ -56,7 +56,7 @@ namespace ot {
namespace Cli {
/**
* This class implements a CLI-based TCP example.
* Implements a CLI-based TCP example.
*
*/
class TcpExample : private Output
@@ -74,7 +74,7 @@ public:
TcpExample(otInstance *aInstance, OutputImplementer &aOutputImplementer);
/**
* This method processes a CLI sub-command.
* Processes a CLI sub-command.
*
* @param[in] aArgs An array of command line arguments.
*
src/cli/cli_udp.hpp
+2 -2
View File
@@ -44,7 +44,7 @@ namespace ot {
namespace Cli {
/**
* This class implements a CLI-based UDP example.
* Implements a CLI-based UDP example.
*
*/
class UdpExample : private Output
@@ -62,7 +62,7 @@ public:
UdpExample(otInstance *aInstance, OutputImplementer &aOutputImplementer);
/**
* This method processes a CLI sub-command.
* Processes a CLI sub-command.
*
* @param[in] aArgs An array of command line arguments.
*
src/core/backbone_router/backbone_tmf.hpp
+6 -6
View File
@@ -47,14 +47,14 @@ namespace BackboneRouter {
constexpr uint16_t kBackboneUdpPort = 61631; ///< Backbone TMF UDP Port
/**
* This class implements functionality of the Backbone TMF agent.
* Implements functionality of the Backbone TMF agent.
*
*/
class BackboneTmfAgent : public Coap::Coap
{
public:
/**
* This constructor initializes the object.
* Initializes the object.
*
* @param[in] aInstance A reference to the OpenThread instance.
*
@@ -62,7 +62,7 @@ public:
explicit BackboneTmfAgent(Instance &aInstance);
/**
* This method starts the Backbone TMF agent.
* Starts the Backbone TMF agent.
*
* @retval kErrorNone Successfully started the CoAP service.
* @retval kErrorFailed Failed to start the Backbone TMF agent.
@@ -71,7 +71,7 @@ public:
Error Start(void);
/**
* This method returns whether @p aMessageInfo meets Backbone Thread Management Framework Addressing Rules.
* Returns whether @p aMessageInfo meets Backbone Thread Management Framework Addressing Rules.
*
* @retval true Thread Management Framework Addressing Rules are met.
* @retval false Thread Management Framework Addressing Rules are not met.
@@ -80,7 +80,7 @@ public:
bool IsBackboneTmfMessage(const Ip6::MessageInfo &aMessageInfo) const;
/**
* This method subscribes the Backbone TMF socket to a given IPv6 multicast group on the Backbone network.
* Subscribes the Backbone TMF socket to a given IPv6 multicast group on the Backbone network.
*
* @param[in] aAddress The IPv6 multicast group address.
*
@@ -88,7 +88,7 @@ public:
void SubscribeMulticast(const Ip6::Address &aAddress);
/**
* This method unsubscribes the Backbone TMF socket from a given IPv6 multicast group on the Backbone network.
* Unsubscribes the Backbone TMF socket from a given IPv6 multicast group on the Backbone network.
*
* @param[in] aAddress The IPv6 multicast group address.
*
src/core/backbone_router/bbr_leader.hpp
+11 -11
View File
@@ -55,7 +55,7 @@ namespace BackboneRouter {
typedef otBackboneRouterConfig Config;
/**
* This class implements the basic Primary Backbone Router service operations.
* Implements the basic Primary Backbone Router service operations.
*
*/
class Leader : public InstanceLocator, private NonCopyable
@@ -84,7 +84,7 @@ public:
};
/**
* This constructor initializes the `Leader`.
* Initializes the `Leader`.
*
* @param[in] aInstance A reference to the OpenThread instance.
*
@@ -92,19 +92,19 @@ public:
explicit Leader(Instance &aInstance);
/**
* This method resets the cached Primary Backbone Router.
* Resets the cached Primary Backbone Router.
*
*/
void Reset(void);
/**
* This method updates the cached Primary Backbone Router if any when new network data is available.
* Updates the cached Primary Backbone Router if any when new network data is available.
*
*/
void Update(void);
/**
* This method gets the Primary Backbone Router in the Thread Network.
* Gets the Primary Backbone Router in the Thread Network.
*
* @param[out] aConfig The Primary Backbone Router information.
*
@@ -115,7 +115,7 @@ public:
Error GetConfig(Config &aConfig) const;
/**
* This method gets the Backbone Router Service ID.
* Gets the Backbone Router Service ID.
*
* @param[out] aServiceId The reference whether to put the Backbone Router Service ID.
*
@@ -126,7 +126,7 @@ public:
Error GetServiceId(uint8_t &aServiceId) const;
/**
* This method gets the short address of the Primary Backbone Router.
* Gets the short address of the Primary Backbone Router.
*
* @returns short address of Primary Backbone Router, or Mac::kShortAddrInvalid if no Primary Backbone Router.
*
@@ -134,7 +134,7 @@ public:
uint16_t GetServer16(void) const { return mConfig.mServer16; }
/**
* This method indicates whether or not there is Primary Backbone Router.
* Indicates whether or not there is Primary Backbone Router.
*
* @retval TRUE If there is Primary Backbone Router.
* @retval FALSE If there is no Primary Backbone Router.
@@ -143,7 +143,7 @@ public:
bool HasPrimary(void) const { return mConfig.mServer16 != Mac::kShortAddrInvalid; }
/**
* This method gets the Domain Prefix in the Thread Network.
* Gets the Domain Prefix in the Thread Network.
*
* @retval A pointer to the Domain Prefix or nullptr if there is no Domain Prefix.
*
@@ -154,7 +154,7 @@ public:
}
/**
* This method indicates whether or not the Domain Prefix is available in the Thread Network.
* Indicates whether or not the Domain Prefix is available in the Thread Network.
*
* @retval TRUE If there is Domain Prefix.
* @retval FALSE If there is no Domain Prefix.
@@ -163,7 +163,7 @@ public:
bool HasDomainPrefix(void) const { return (mDomainPrefix.GetLength() > 0); }
/**
* This method indicates whether or not the address is a Domain Unicast Address.
* Indicates whether or not the address is a Domain Unicast Address.
*
* @param[in] aAddress A reference to the address.
*
src/core/backbone_router/bbr_local.hpp
+22 -22
View File
@@ -67,14 +67,14 @@ namespace ot {
namespace BackboneRouter {
/**
* This class implements the definitions for local Backbone Router service.
* Implements the definitions for local Backbone Router service.
*
*/
class Local : public InstanceLocator, private NonCopyable
{
public:
/**
* This enumeration represents Backbone Router state.
* Represents Backbone Router state.
*
*/
enum State : uint8_t
@@ -85,7 +85,7 @@ public:
};
/**
* This constructor initializes the local Backbone Router.
* Initializes the local Backbone Router.
*
* @param[in] aInstance A reference to the OpenThread instance.
*
@@ -93,7 +93,7 @@ public:
explicit Local(Instance &aInstance);
/**
* This method enables/disables Backbone function.
* Enables/disables Backbone function.
*
* @param[in] aEnable TRUE to enable the backbone function, FALSE otherwise.
*
@@ -101,7 +101,7 @@ public:
void SetEnabled(bool aEnable);
/**
* This method retrieves the Backbone Router state.
* Retrieves the Backbone Router state.
*
*
* @returns The current state of Backbone Router.
@@ -110,13 +110,13 @@ public:
State GetState(void) const { return mState; }
/**
* This method resets the local Thread Network Data.
* Resets the local Thread Network Data.
*
*/
void Reset(void);
/**
* This method gets local Backbone Router configuration.
* Gets local Backbone Router configuration.
*
* @param[out] aConfig The local Backbone Router configuration.
*
@@ -124,7 +124,7 @@ public:
void GetConfig(Config &aConfig) const;
/**
* This method sets local Backbone Router configuration.
* Sets local Backbone Router configuration.
*
* @param[in] aConfig The configuration to set.
*
@@ -135,7 +135,7 @@ public:
Error SetConfig(const Config &aConfig);
/**
* This method registers Backbone Router Dataset to Leader.
* Registers Backbone Router Dataset to Leader.
*
* @param[in] aForce True to force registration regardless of current state.
* False to decide based on current state.
@@ -149,7 +149,7 @@ public:
Error AddService(bool aForce = false);
/**
* This method indicates whether or not the Backbone Router is Primary.
* Indicates whether or not the Backbone Router is Primary.
*
* @retval True if the Backbone Router is Primary.
* @retval False if the Backbone Router is not Primary.
@@ -158,7 +158,7 @@ public:
bool IsPrimary(void) const { return mState == kStatePrimary; }
/**
* This method indicates whether or not the Backbone Router is enabled.
* Indicates whether or not the Backbone Router is enabled.
*
* @retval True if the Backbone Router is enabled.
* @retval False if the Backbone Router is not enabled.
@@ -167,7 +167,7 @@ public:
bool IsEnabled(void) const { return mState != kStateDisabled; }
/**
* This method sets the Backbone Router registration jitter value.
* Sets the Backbone Router registration jitter value.
*
* @param[in] aRegistrationJitter the Backbone Router registration jitter value to set.
*
@@ -175,7 +175,7 @@ public:
void SetRegistrationJitter(uint8_t aRegistrationJitter) { mRegistrationJitter = aRegistrationJitter; }
/**
* This method returns the Backbone Router registration jitter value.
* Returns the Backbone Router registration jitter value.
*
* @returns The Backbone Router registration jitter value.
*
@@ -183,7 +183,7 @@ public:
uint8_t GetRegistrationJitter(void) const { return mRegistrationJitter; }
/**
* This method notifies Primary Backbone Router status.
* Notifies Primary Backbone Router status.
*
* @param[in] aState The state or state change of Primary Backbone Router.
* @param[in] aConfig The Primary Backbone Router service.
@@ -192,7 +192,7 @@ public:
void HandleBackboneRouterPrimaryUpdate(Leader::State aState, const Config &aConfig);
/**
* This method gets the Domain Prefix configuration.
* Gets the Domain Prefix configuration.
*
* @param[out] aConfig A reference to the Domain Prefix configuration.
*
@@ -203,7 +203,7 @@ public:
Error GetDomainPrefix(NetworkData::OnMeshPrefixConfig &aConfig);
/**
* This method removes the local Domain Prefix configuration.
* Removes the local Domain Prefix configuration.
*
* @param[in] aPrefix A reference to the IPv6 Domain Prefix.
*
@@ -215,7 +215,7 @@ public:
Error RemoveDomainPrefix(const Ip6::Prefix &aPrefix);
/**
* This method sets the local Domain Prefix configuration.
* Sets the local Domain Prefix configuration.
*
* @param[in] aConfig A reference to the Domain Prefix configuration.
*
@@ -226,7 +226,7 @@ public:
Error SetDomainPrefix(const NetworkData::OnMeshPrefixConfig &aConfig);
/**
* This method returns a reference to the All Network Backbone Routers Multicast Address.
* Returns a reference to the All Network Backbone Routers Multicast Address.
*
* @returns A reference to the All Network Backbone Routers Multicast Address.
*
@@ -234,7 +234,7 @@ public:
const Ip6::Address &GetAllNetworkBackboneRoutersAddress(void) const { return mAllNetworkBackboneRouters; }
/**
* This method returns a reference to the All Domain Backbone Routers Multicast Address.
* Returns a reference to the All Domain Backbone Routers Multicast Address.
*
* @returns A reference to the All Domain Backbone Routers Multicast Address.
*
@@ -242,13 +242,13 @@ public:
const Ip6::Address &GetAllDomainBackboneRoutersAddress(void) const { return mAllDomainBackboneRouters; }
/**
* This method applies the Mesh Local Prefix.
* Applies the Mesh Local Prefix.
*
*/
void ApplyMeshLocalPrefix(void);
/**
* This method updates the subscription of All Domain Backbone Routers Multicast Address.
* Updates the subscription of All Domain Backbone Routers Multicast Address.
*
* @param[in] aState The Domain Prefix state or state change.
*
@@ -256,7 +256,7 @@ public:
void HandleDomainPrefixUpdate(Leader::DomainPrefixState aState);
/**
* This method sets the Domain Prefix callback.
* Sets the Domain Prefix callback.
*
* @param[in] aCallback The callback function.
* @param[in] aContext A user context pointer.
src/core/backbone_router/bbr_manager.hpp
+10 -10
View File
@@ -56,7 +56,7 @@ namespace ot {
namespace BackboneRouter {
/**
* This class implements the definitions for Backbone Router management.
* Implements the definitions for Backbone Router management.
*
*/
class Manager : public InstanceLocator, private NonCopyable
@@ -67,7 +67,7 @@ class Manager : public InstanceLocator, private NonCopyable
public:
/**
* This constructor initializes the Backbone Router manager.
* Initializes the Backbone Router manager.
*
* @param[in] aInstance A reference to the OpenThread instance.
*
@@ -76,7 +76,7 @@ public:
#if OPENTHREAD_CONFIG_BACKBONE_ROUTER_DUA_NDPROXYING_ENABLE
/**
* This method returns the NdProxy Table.
* Returns the NdProxy Table.
*
* @returns The NdProxy Table.
*
@@ -86,7 +86,7 @@ public:
#if OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
/**
* This method configures response status for next DUA registration.
* Configures response status for next DUA registration.
*
* Note: available only when `OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE` is enabled.
* Only used for test and certification.
@@ -100,7 +100,7 @@ public:
#if OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE
/**
* This method configures response status for next Multicast Listener Registration.
* Configures response status for next Multicast Listener Registration.
*
* Note: available only when `OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE` is enabled.
* Only used for test and certification.
@@ -114,7 +114,7 @@ public:
#if OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE
/**
* This method gets the Multicast Listeners Table.
* Gets the Multicast Listeners Table.
*
* @returns The Multicast Listeners Table.
*
@@ -123,7 +123,7 @@ public:
#endif
/**
* This method returns if messages destined to a given Domain Unicast Address should be forwarded to the Backbone
* Returns if messages destined to a given Domain Unicast Address should be forwarded to the Backbone
* link.
*
* @param aAddress The Domain Unicast Address.
@@ -135,7 +135,7 @@ public:
bool ShouldForwardDuaToBackbone(const Ip6::Address &aAddress);
/**
* This method returns a reference to the Backbone TMF agent.
* Returns a reference to the Backbone TMF agent.
*
* @returns A reference to the Backbone TMF agent.
*
@@ -143,7 +143,7 @@ public:
BackboneTmfAgent &GetBackboneTmfAgent(void) { return mBackboneTmfAgent; }
/**
* This method sends BB.qry on the Backbone link.
* Sends BB.qry on the Backbone link.
*
* @param[in] aDua The Domain Unicast Address to query.
* @param[in] aRloc16 The short address of the address resolution initiator or `Mac::kShortAddrInvalid` for
@@ -157,7 +157,7 @@ public:
Error SendBackboneQuery(const Ip6::Address &aDua, uint16_t aRloc16 = Mac::kShortAddrInvalid);
/**
* This method send a Proactive Backbone Notification (PRO_BB.ntf) on the Backbone link.
* Send a Proactive Backbone Notification (PRO_BB.ntf) on the Backbone link.
*
* @param[in] aDua The Domain Unicast Address to notify.
* @param[in] aMeshLocalIid The Mesh-Local IID to notify.

Some files were not shown because too many files have changed in this diff Show More