General
Este módulo incluye funciones para todos los roles de Thread.
Resumen
Network Data Publisher proporciona mecanismos para limitar la cantidad de entradas similares de servicio y/o prefijo (prefijo en malla o ruta externa) en los datos de red de subprocesos al monitorear los datos de red y administrar si se agregan o eliminan entradas o cuándo.
Todas las funciones de este módulo requieren que OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE
esté habilitado.
definiciones de tipo | |
---|---|
otBorderRouterConfig | definición de tipostruct otBorderRouterConfig Esta estructura representa una configuración de enrutador de borde. |
otExternalRouteConfig | definición de tipostruct otExternalRouteConfig Esta estructura representa una configuración de ruta externa. |
otIpCounters | definición de tipostruct otIpCounters Esta estructura representa los contadores de nivel de IP. |
otLeaderData | definición de tipostruct otLeaderData Esta estructura representa los datos del líder del subproceso. |
otLinkModeConfig | definición de tipostruct otLinkModeConfig Esta estructura representa una configuración de modo de enlace MLE. |
otMleCounters | definición de tipostruct otMleCounters Esta estructura representa los contadores Thread MLE. |
otNeighborInfoIterator | definición de tipoint16_t Se utiliza para iterar a través de la tabla vecina. |
otNetDataDnsSrpServicePublisherCallback )(otNetDataPublisherEvent aEvent, void *aContext) | definición de tipovoid(* Este tipo de puntero de función define la devolución de llamada utilizada para notificar cuando se agrega o elimina una entrada de "Servicio DNS/SRP" de los datos de red de subprocesos. |
otNetDataPrefixPublisherCallback )(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) | definición de tipovoid(* Este tipo de puntero de función define la devolución de llamada utilizada para notificar cuando se agrega o elimina una entrada de prefijo (en malla o ruta externa) de los datos de red de subprocesos. |
otNetDataPublisherEvent | definición de tipo Esta enumeración representa los eventos notificados por las devoluciones de llamada de Publisher. |
otNetworkDataIterator | definición de tipouint32_t Se utiliza para iterar a través de la información de datos de red. |
otNetworkDiagChildEntry | definición de tipostruct otNetworkDiagChildEntry Esta estructura representa una entrada de tabla secundaria de diagnóstico de red. |
otNetworkDiagConnectivity | definición de tipostruct otNetworkDiagConnectivity Esta estructura representa un valor de conectividad de diagnóstico de red. |
otNetworkDiagIterator | definición de tipouint16_t Se utiliza para iterar a través del TLV de diagnóstico de red. |
otNetworkDiagMacCounters | definición de tipostruct otNetworkDiagMacCounters Esta estructura representa un valor de contadores Mac de diagnóstico de red. |
otNetworkDiagRoute | definición de tipostruct otNetworkDiagRoute Esta estructura representa un valor TLV de ruta de diagnóstico de red. |
otNetworkDiagRouteData | definición de tipostruct otNetworkDiagRouteData Esta estructura representa los datos de una ruta de diagnóstico de red. |
otNetworkDiagTlv | definición de tipostruct otNetworkDiagTlv Esta estructura representa un TLV de diagnóstico de red. |
otReceiveDiagnosticGetCallback )(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) | definición de tipovoid(* Se llama a este puntero de función cuando se recibe la respuesta Obtener diagnóstico de red. |
otRoutePreference | definición de tipoenum otRoutePreference |
otServerConfig | definición de tipostruct otServerConfig Esta estructura representa una configuración de servidor. |
otServiceConfig | definición de tipostruct otServiceConfig Esta estructura representa una configuración de Servicio. |
otThreadAnycastLocatorCallback )(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) | definición de tipovoid(* Este tipo de puntero de función define la devolución de llamada para notificar el resultado de una solicitud otThreadLocateAnycastDestination() . |
otThreadDiscoveryRequestCallback )(const otThreadDiscoveryRequestInfo *aInfo, void *aContext) | definición de tipovoid(* Este puntero de función se llama cada vez que se recibe un mensaje de solicitud de descubrimiento MLE. |
otThreadDiscoveryRequestInfo | definición de tipostruct otThreadDiscoveryRequestInfo Esta estructura representa los datos de la solicitud de detección de subprocesos. |
otThreadParentResponseCallback )(otThreadParentResponseInfo *aInfo, void *aContext) | definición de tipovoid(* Este puntero de función se llama cada vez que se recibe un mensaje de respuesta principal de MLE. |
otThreadParentResponseInfo | definición de tipostruct otThreadParentResponseInfo Esta estructura representa los datos de respuesta de los padres de MLE. |
Funciones | |
---|---|
otNetDataContainsOmrPrefix ( otInstance *aInstance, const otIp6Prefix *aPrefix) | bool Esta función verifica si un Prefijo dado puede actuar como un prefijo OMR válido y también los Datos de la Red del Líder contienen este prefijo. |
otNetDataGet ( otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength) | Este método proporciona una copia completa o estable de los datos de red de subprocesos de la partición. |
otNetDataGetNextOnMeshPrefix ( otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig) | Esta función obtiene el siguiente prefijo en malla en los datos de red de la partición. |
otNetDataGetNextRoute ( otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig) | Esta función obtiene la siguiente ruta externa en los datos de red de la partición. |
otNetDataGetNextService ( otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig) | Esta función obtiene el siguiente servicio en los datos de red de la partición. |
otNetDataGetStableVersion ( otInstance *aInstance) | uint8_t Obtenga la versión de datos de red estable. |
otNetDataGetVersion ( otInstance *aInstance) | uint8_t Obtenga la versión de datos de red. |
otNetDataIsDnsSrpServiceAdded ( otInstance *aInstance) | bool Esta función indica si actualmente la entrada "Servicio DNS/SRP" se agrega o no a los Datos de red de subprocesos. |
otNetDataIsPrefixAdded ( otInstance *aInstance, const otIp6Prefix *aPrefix) | bool Esta función indica si una entrada de prefijo publicada actualmente (en malla o ruta externa) se agrega o no a los datos de red de subprocesos. |
otNetDataPublishDnsSrpServiceAnycast ( otInstance *aInstance, uint8_t aSequenceNUmber) | void Esta función solicita que se publique "Dirección Anycast del servicio DNS/SRP" en los datos de la red de subprocesos. |
otNetDataPublishDnsSrpServiceUnicast ( otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort) | void Esta función solicita que se publique "Dirección de unidifusión del servicio DNS/SRP" en los datos de la red de subprocesos. |
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid ( otInstance *aInstance, uint16_t aPort) | void Esta función solicita que se publique "Dirección de unidifusión del servicio DNS/SRP" en los datos de la red de subprocesos. |
otNetDataPublishExternalRoute ( otInstance *aInstance, const otExternalRouteConfig *aConfig) | Esta función solicita que se publique un prefijo de ruta externo en los datos de la red de subprocesos. |
otNetDataPublishOnMeshPrefix ( otInstance *aInstance, const otBorderRouterConfig *aConfig) | Esta función solicita que se publique un prefijo en la malla en los datos de la red de subprocesos. |
otNetDataSetDnsSrpServicePublisherCallback ( otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext) | void Esta función establece una devolución de llamada para notificar cuando un "Servicio DNS/SRP" publicado se agrega o elimina de los Datos de red de subprocesos. |
otNetDataSetPrefixPublisherCallback ( otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext) | void Esta función establece una devolución de llamada para notificar cuando una entrada de prefijo publicada se agrega o elimina de los datos de red de subprocesos. |
otNetDataSteeringDataCheckJoiner ( otInstance *aInstance, const otExtAddress *aEui64) | Compruebe si los datos de dirección incluyen un carpintero. |
otNetDataSteeringDataCheckJoinerWithDiscerner ( otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner) | Compruebe si los datos de dirección incluyen un ensamblador con un valor de discernidor determinado. |
otNetDataUnpublishDnsSrpService ( otInstance *aInstance) | void Esta función anula la publicación de cualquier entrada de "Servicio DNS/SRP (Anycast o Unicast)" agregada previamente de los datos de red de subprocesos. |
otNetDataUnpublishPrefix ( otInstance *aInstance, const otIp6Prefix *aPrefix) | Esta función anula la publicación de un prefijo publicado previamente (en malla o ruta externa). |
otThreadBecomeChild ( otInstance *aInstance) | Intento de volver a conectar como un niño. |
otThreadBecomeDetached ( otInstance *aInstance) | Separarse de la red Thread. |
otThreadDeviceRoleToString ( otDeviceRole aRole) | const char * Convierta la función del dispositivo en una cadena legible por humanos. |
otThreadDiscover ( otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext) | Esta función inicia un análisis de detección de subprocesos. |
otThreadGetChildTimeout ( otInstance *aInstance) | uint32_t Obtener el tiempo de espera secundario del subproceso utilizado cuando se opera en el rol secundario. |
otThreadGetDeviceRole ( otInstance *aInstance) | Obtenga la función del dispositivo. |
otThreadGetDomainName ( otInstance *aInstance) | const char * Obtenga el nombre de dominio del subproceso. |
otThreadGetExtendedPanId ( otInstance *aInstance) | const otExtendedPanId * Obtenga el ID de PAN extendido IEEE 802.15.4. |
otThreadGetFixedDuaInterfaceIdentifier ( otInstance *aInstance) | const otIp6InterfaceIdentifier * Obtenga el identificador de interfaz especificado manualmente para la dirección de unidifusión del dominio de subprocesos. |
otThreadGetIp6Counters ( otInstance *aInstance) | const otIpCounters * Obtenga los contadores de IPv6. |
otThreadGetKeySequenceCounter ( otInstance *aInstance) | uint32_t Obtenga el thrKeySequenceCounter. |
otThreadGetKeySwitchGuardTime ( otInstance *aInstance) | uint32_t Obtenga el thrKeySwitchGuardTime. |
otThreadGetLeaderData ( otInstance *aInstance, otLeaderData *aLeaderData) | Esta función obtiene los datos del líder del subproceso. |
otThreadGetLeaderRloc ( otInstance *aInstance, otIp6Address *aLeaderRloc) | Esta función devuelve un puntero al RLOC del líder. |
otThreadGetLeaderRouterId ( otInstance *aInstance) | uint8_t Obtenga la identificación del enrutador del líder. |
otThreadGetLeaderWeight ( otInstance *aInstance) | uint8_t Obtenga el peso del líder. |
otThreadGetLinkLocalAllThreadNodesMulticastAddress ( otInstance *aInstance) | const otIp6Address * Esta función devuelve la dirección de multidifusión Thread Link-Local All Thread Nodes. |
otThreadGetLinkLocalIp6Address ( otInstance *aInstance) | const otIp6Address * Esta función devuelve la dirección IPv6 local del enlace de subproceso. |
otThreadGetLinkMode ( otInstance *aInstance) | Obtenga la configuración del modo de enlace MLE. |
otThreadGetMeshLocalEid ( otInstance *aInstance) | const otIp6Address * Esta función devuelve un puntero a la dirección EID local de malla. |
otThreadGetMeshLocalPrefix ( otInstance *aInstance) | const otMeshLocalPrefix * Esta función devuelve un puntero al prefijo local de malla. |
otThreadGetMleCounters ( otInstance *aInstance) | const otMleCounters * Obtenga los contadores Thread MLE. |
otThreadGetNetworkKey ( otInstance *aInstance, otNetworkKey *aNetworkKey) | void Obtenga la clave de red de subprocesos. |
otThreadGetNetworkKeyRef ( otInstance *aInstance) | Obtenga otNetworkKeyRef para la clave de red de subprocesos. |
otThreadGetNetworkName ( otInstance *aInstance) | const char * Obtenga el nombre de la red del subproceso. |
otThreadGetNextDiagnosticTlv (const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv) | Esta función obtiene el siguiente TLV de diagnóstico de red en el mensaje. |
otThreadGetNextNeighborInfo ( otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo) | Esta función obtiene la siguiente información del vecino. |
otThreadGetParentAverageRssi ( otInstance *aInstance, int8_t *aParentRssi) | La función recupera el RSSI promedio para Thread Parent. |
otThreadGetParentInfo ( otInstance *aInstance, otRouterInfo *aParentInfo) | La función recupera información de diagnóstico para un Thread Router como padre. |
otThreadGetParentLastRssi ( otInstance *aInstance, int8_t *aLastRssi) | La función recupera el RSSI del último paquete del Thread Parent. |
otThreadGetPartitionId ( otInstance *aInstance) | uint32_t Obtenga la identificación de la partición. |
otThreadGetRealmLocalAllThreadNodesMulticastAddress ( otInstance *aInstance) | const otIp6Address * Esta función devuelve la dirección de multidifusión Thread Realm-Local All Thread Nodes. |
otThreadGetRloc ( otInstance *aInstance) | const otIp6Address * Esta función devuelve un puntero a la dirección del localizador de enrutamiento de subprocesos (RLOC). |
otThreadGetRloc16 ( otInstance *aInstance) | uint16_t Obtenga el RLOC16. |
otThreadGetServiceAloc ( otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc) | Esta función recupera el ALOC del servicio para el ID de servicio dado. |
otThreadGetVersion (void) | uint16_t Esta función obtiene la versión del protocolo Thread. |
otThreadIsAnycastLocateInProgress ( otInstance *aInstance) | bool Esta función indica si una solicitud de localización anycast está actualmente en curso. |
otThreadIsDiscoverInProgress ( otInstance *aInstance) | bool Esta función determina si un descubrimiento de subprocesos MLE está actualmente en curso. |
otThreadIsSingleton ( otInstance *aInstance) | bool Esta función indica si un nodo es el único enrutador de la red. |
otThreadLocateAnycastDestination ( otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext) | Esta función solicita que se localice el destino más cercano de una determinada dirección anycast. |
otThreadRegisterParentResponseCallback ( otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext) | void Esta función registra una devolución de llamada para recibir datos de respuesta de padres MLE. |
otThreadResetIp6Counters ( otInstance *aInstance) | void Restablezca los contadores de IPv6. |
otThreadResetMleCounters ( otInstance *aInstance) | void Restablezca los contadores Thread MLE. |
otThreadSendAddressNotification ( otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid) | void Esta función envía un mensaje de notificación de dirección proactiva (ADDR_NTF.ntf). |
otThreadSendDiagnosticGet ( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext) | Envíe una solicitud de obtención de diagnóstico de red. |
otThreadSendDiagnosticReset ( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount) | Envíe una solicitud de restablecimiento de diagnóstico de red. |
otThreadSendProactiveBackboneNotification ( otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction) | Esta función envía un mensaje de notificación proactiva de red troncal (PRO_BB.ntf) en el enlace de red troncal. |
otThreadSetChildTimeout ( otInstance *aInstance, uint32_t aTimeout) | void Establezca el tiempo de espera secundario del subproceso que se usa cuando se opera en el rol secundario. |
otThreadSetDiscoveryRequestCallback ( otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext) | void Esta función establece una devolución de llamada para recibir datos de solicitud de descubrimiento de MLE. |
otThreadSetDomainName ( otInstance *aInstance, const char *aDomainName) | Establezca el nombre de dominio del subproceso. |
otThreadSetEnabled ( otInstance *aInstance, bool aEnabled) | Esta función inicia la operación del protocolo Thread. |
otThreadSetExtendedPanId ( otInstance *aInstance, const otExtendedPanId *aExtendedPanId) | Establezca el ID de PAN extendido IEEE 802.15.4. |
otThreadSetFixedDuaInterfaceIdentifier ( otInstance *aInstance, const otIp6InterfaceIdentifier *aIid) | Establezca/borre el identificador de interfaz especificado manualmente para la dirección de unidifusión del dominio de subprocesos. |
otThreadSetJoinerAdvertisement ( otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength) | Este método establece el anuncio de combinación de subprocesos al descubrir la red de subprocesos. |
otThreadSetKeySequenceCounter ( otInstance *aInstance, uint32_t aKeySequenceCounter) | void Configure el thrKeySequenceCounter. |
otThreadSetKeySwitchGuardTime ( otInstance *aInstance, uint32_t aKeySwitchGuardTime) | void Configure el thrKeySwitchGuardTime. |
otThreadSetLinkMode ( otInstance *aInstance, otLinkModeConfig aConfig) | Establezca la configuración del modo de enlace MLE. |
otThreadSetMeshLocalPrefix ( otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix) | Esta función establece el prefijo local de la malla. |
otThreadSetNetworkKey ( otInstance *aInstance, const otNetworkKey *aKey) | Establezca la clave de red de subprocesos. |
otThreadSetNetworkKeyRef ( otInstance *aInstance, otNetworkKeyRef aKeyRef) | Establezca la clave de red de subprocesos como otNetworkKeyRef . |
otThreadSetNetworkName ( otInstance *aInstance, const char *aNetworkName) | Establezca el nombre de la red de subprocesos. |
estructuras | |
---|---|
otBorderRouterConfig | Esta estructura representa una configuración de enrutador de borde. |
otExternalRouteConfig | Esta estructura representa una configuración de ruta externa. |
Contadores otIp | Esta estructura representa los contadores de nivel de IP. |
otLeaderData | Esta estructura representa los datos del líder del subproceso. |
otLinkModeConfig | Esta estructura representa una configuración de modo de enlace MLE. |
otMleContadores | Esta estructura representa los contadores Thread MLE. |
otNeighborInfo | Esta estructura contiene información de diagnóstico para un nodo Thread vecino. |
otNetworkDiagChildEntry | Esta estructura representa una entrada de tabla secundaria de diagnóstico de red. |
otNetworkDiagConectividad | Esta estructura representa un valor de conectividad de diagnóstico de red. |
otNetworkDiagMacContadores | Esta estructura representa un valor de contadores Mac de diagnóstico de red. |
otNetworkDiagRoute | Esta estructura representa un valor TLV de ruta de diagnóstico de red. |
otNetworkDiagRouteData | Esta estructura representa los datos de una ruta de diagnóstico de red. |
otNetworkDiagTlv | Esta estructura representa un TLV de diagnóstico de red. |
otRouterInfo | Esta estructura contiene información de diagnóstico para un enrutador de subprocesos. |
otServerConfig | Esta estructura representa una configuración de servidor. |
otServiceConfig | Esta estructura representa una configuración de Servicio. |
otThreadDiscoveryRequestInfo | Esta estructura representa los datos de la solicitud de detección de subprocesos. |
otThreadParentResponseInfo | Esta estructura representa los datos de respuesta de los padres de MLE. |
enumeraciones
enumeración anónima
anonymous enum
otDeviceRole
otDeviceRole
Representa una función de dispositivo de subproceso.
otNetDataPublisherEvent
otNetDataPublisherEvent
Esta enumeración representa los eventos notificados por las devoluciones de llamada de Publisher.
otRoutePreference
otRoutePreference
Define valores válidos para mPreference
en otExternalRouteConfig
y otBorderRouterConfig
.
Propiedades | |
---|---|
OT_ROUTE_PREFERENCE_HIGH | Alta preferencia de ruta. |
OT_ROUTE_PREFERENCE_LOW | Preferencia de ruta baja. |
OT_ROUTE_PREFERENCE_MED | Preferencia de ruta media. |
definiciones de tipo
otBorderRouterConfig
struct otBorderRouterConfig otBorderRouterConfig
Esta estructura representa una configuración de enrutador de borde.
otExternalRouteConfig
struct otExternalRouteConfig otExternalRouteConfig
Esta estructura representa una configuración de ruta externa.
Contadores otIp
struct otIpCounters otIpCounters
Esta estructura representa los contadores de nivel de IP.
otLeaderData
struct otLeaderData otLeaderData
Esta estructura representa los datos del líder del subproceso.
otLinkModeConfig
struct otLinkModeConfig otLinkModeConfig
Esta estructura representa una configuración de modo de enlace MLE.
otMleContadores
struct otMleCounters otMleCounters
Esta estructura representa los contadores Thread MLE.
otNeighborInfoIterator
int16_t otNeighborInfoIterator
Se utiliza para iterar a través de la tabla vecina.
otNetDataDnsSrpServicePublisherCallback
void(* otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)
Este tipo de puntero de función define la devolución de llamada utilizada para notificar cuando se agrega o elimina una entrada de "Servicio DNS/SRP" de los datos de red de subprocesos.
Al eliminar, se invoca la devolución de llamada independientemente de si Publisher
eliminó la entrada (por ejemplo, cuando ya hay demasiadas entradas similares presentes en los datos de red) o mediante una llamada explícita para anular la publicación de la entrada (es decir, una llamada a otNetDataUnpublishDnsSrpService()
).
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otNetDataPrefixPublisherCallback
void(* otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)
Este tipo de puntero de función define la devolución de llamada utilizada para notificar cuando se agrega o elimina una entrada de prefijo (en malla o ruta externa) de los datos de red de subprocesos.
Al eliminar, se invoca la devolución de llamada independientemente de si el Publisher
elimina la entrada (por ejemplo, cuando ya hay demasiadas entradas similares presentes en los datos de red) o mediante una llamada explícita para anular la publicación de la entrada.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
otNetDataPublisherEvent
enum otNetDataPublisherEvent otNetDataPublisherEvent
Esta enumeración representa los eventos notificados por las devoluciones de llamada de Publisher.
otNetworkDataIterator
uint32_t otNetworkDataIterator
Se utiliza para iterar a través de la información de datos de red.
otNetworkDiagChildEntry
struct otNetworkDiagChildEntry otNetworkDiagChildEntry
Esta estructura representa una entrada de tabla secundaria de diagnóstico de red.
otNetworkDiagConectividad
struct otNetworkDiagConnectivity otNetworkDiagConnectivity
Esta estructura representa un valor de conectividad de diagnóstico de red.
otNetworkDiagIterator
uint16_t otNetworkDiagIterator
Se utiliza para iterar a través del TLV de diagnóstico de red.
otNetworkDiagMacContadores
struct otNetworkDiagMacCounters otNetworkDiagMacCounters
Esta estructura representa un valor de contadores Mac de diagnóstico de red.
Consulte RFC 2863 para conocer las definiciones de los campos de miembros.
otNetworkDiagRoute
struct otNetworkDiagRoute otNetworkDiagRoute
Esta estructura representa un valor TLV de ruta de diagnóstico de red.
otNetworkDiagRouteData
struct otNetworkDiagRouteData otNetworkDiagRouteData
Esta estructura representa los datos de una ruta de diagnóstico de red.
otNetworkDiagTlv
struct otNetworkDiagTlv otNetworkDiagTlv
Esta estructura representa un TLV de diagnóstico de red.
otReceiveDiagnosticGetCallback
void(* otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)
Se llama a este puntero de función cuando se recibe la respuesta Obtener diagnóstico de red.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
otRoutePreference
enum otRoutePreference otRoutePreference
Define valores válidos para mPreference
en otExternalRouteConfig
y otBorderRouterConfig
.
otServerConfig
struct otServerConfig otServerConfig
Esta estructura representa una configuración de servidor.
otServiceConfig
struct otServiceConfig otServiceConfig
Esta estructura representa una configuración de Servicio.
otThreadAnycastLocatorCallback
void(* otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)
Este tipo de puntero de función define la devolución de llamada para notificar el resultado de una solicitud otThreadLocateAnycastDestination()
.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
otThreadDiscoveryRequestCallback
void(* otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)
Este puntero de función se llama cada vez que se recibe un mensaje de solicitud de descubrimiento MLE.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otThreadDiscoveryRequestInfo
struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo
Esta estructura representa los datos de la solicitud de detección de subprocesos.
otThreadParentResponseCallback
void(* otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)
Este puntero de función se llama cada vez que se recibe un mensaje de respuesta principal de MLE.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otThreadParentResponseInfo
struct otThreadParentResponseInfo otThreadParentResponseInfo
Esta estructura representa los datos de respuesta de los padres de MLE.
Funciones
otNetDataContainsOmrPrefix
bool otNetDataContainsOmrPrefix( otInstance *aInstance, const otIp6Prefix *aPrefix )
Esta función verifica si un Prefijo dado puede actuar como un prefijo OMR válido y también los Datos de la Red del Líder contienen este prefijo.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
| ||||
Devoluciones | Si aPrefix es un prefijo OMR válido y los datos de la red del líder contienen el prefijo OMR aPrefix . |
otNetDataGet
otError otNetDataGet( otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength )
Este método proporciona una copia completa o estable de los datos de red de subprocesos de la partición.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
otNetDataGetNextOnMeshPrefix
otError otNetDataGetNextOnMeshPrefix( otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig )
Esta función obtiene el siguiente prefijo en malla en los datos de red de la partición.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Valores devueltos |
|
otNetDataGetNextRoute
otError otNetDataGetNextRoute( otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig )
Esta función obtiene la siguiente ruta externa en los datos de red de la partición.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Valores devueltos |
|
otNetDataGetNextService
otError otNetDataGetNextService( otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig )
Esta función obtiene el siguiente servicio en los datos de red de la partición.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Valores devueltos |
|
otNetDataGetStableVersion
uint8_t otNetDataGetStableVersion( otInstance *aInstance )
Obtenga la versión de datos de red estable.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | La versión de datos de red estable. |
otNetDataGetVersion
uint8_t otNetDataGetVersion( otInstance *aInstance )
Obtenga la versión de datos de red.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | La versión de datos de red. |
otNetDataIsDnsSrpServiceAdded
bool otNetDataIsDnsSrpServiceAdded( otInstance *aInstance )
Esta función indica si actualmente la entrada "Servicio DNS/SRP" se agrega o no a los Datos de red de subprocesos.
Esta función requiere que la función OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
esté habilitada.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
| ||||
Valores devueltos |
|
otNetDataIsPrefixAdded
bool otNetDataIsPrefixAdded( otInstance *aInstance, const otIp6Prefix *aPrefix )
Esta función indica si una entrada de prefijo publicada actualmente (en malla o ruta externa) se agrega o no a los datos de red de subprocesos.
Esta función requiere que la característica OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
esté habilitada.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
| ||||
Valores devueltos |
|
otNetDataPublishDnsSrpServiceAnycast
void otNetDataPublishDnsSrpServiceAnycast( otInstance *aInstance, uint8_t aSequenceNUmber )
Esta función solicita que se publique "Dirección Anycast del servicio DNS/SRP" en los datos de la red de subprocesos.
Esta función requiere que la función OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
esté habilitada.
Una llamada a esta función eliminará y reemplazará cualquier entrada anterior de "Servicio DNS/SRP" que se haya publicado (desde una llamada anterior a cualquiera de las otNetDataPublishDnsSrpService{Type}()
).
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otNetDataPublishDnsSrpServiceUnicast
void otNetDataPublishDnsSrpServiceUnicast( otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort )
Esta función solicita que se publique "Dirección de unidifusión del servicio DNS/SRP" en los datos de la red de subprocesos.
Esta función requiere que la función OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
esté habilitada.
Una llamada a esta función eliminará y reemplazará cualquier entrada anterior de "Servicio DNS/SRP" que se haya publicado (desde una llamada anterior a cualquiera de las otNetDataPublishDnsSrpService{Type}()
).
Esta función publica la "Dirección de unidifusión del servicio DNS/SRP" al incluir la dirección y la información del puerto en los datos TLV del servicio.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid
void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid( otInstance *aInstance, uint16_t aPort )
Esta función solicita que se publique "Dirección de unidifusión del servicio DNS/SRP" en los datos de la red de subprocesos.
Esta función requiere que la función OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
esté habilitada.
Una llamada a esta función eliminará y reemplazará cualquier entrada anterior de "Servicio DNS/SRP" que se haya publicado (desde una llamada anterior a cualquiera de las otNetDataPublishDnsSrpService{Type}()
).
A diferencia otNetDataPublishDnsSrpServiceUnicast()
, que requiere que se proporcione la dirección publicada e incluye la información en los datos TLV del servicio, esta función utiliza el EID local de malla del dispositivo e incluye la información en los datos TLV del servidor.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otNetDataPublishExternalRoute
otError otNetDataPublishExternalRoute( otInstance *aInstance, const otExternalRouteConfig *aConfig )
Esta función solicita que se publique un prefijo de ruta externo en los datos de la red de subprocesos.
Esta función requiere que la característica OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
esté habilitada.
Solo se pueden publicar entradas estables (es decir, aConfig.mStable
DEBE ser VERDADERO).
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
| ||||||||
Valores devueltos |
|
otNetDataPublishOnMeshPrefix
otError otNetDataPublishOnMeshPrefix( otInstance *aInstance, const otBorderRouterConfig *aConfig )
Esta función solicita que se publique un prefijo en la malla en los datos de la red de subprocesos.
Esta función requiere que la característica OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
esté habilitada.
Solo se pueden publicar entradas estables (es decir, aConfig.mStable
DEBE ser VERDADERO).
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
| ||||||||
Valores devueltos |
|
otNetDataSetDnsSrpServicePublisherCallback
void otNetDataSetDnsSrpServicePublisherCallback( otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext )
Esta función establece una devolución de llamada para notificar cuando un "Servicio DNS/SRP" publicado se agrega o elimina de los Datos de red de subprocesos.
Una llamada posterior a esta función reemplaza cualquier función de devolución de llamada establecida previamente.
Esta función requiere que la función OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
esté habilitada.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
otNetDataSetPrefixPublisherCallback
void otNetDataSetPrefixPublisherCallback( otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext )
Esta función establece una devolución de llamada para notificar cuando una entrada de prefijo publicada se agrega o elimina de los datos de red de subprocesos.
Una llamada posterior a esta función reemplaza cualquier función de devolución de llamada establecida previamente.
Esta función requiere que la característica OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
esté habilitada.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
otNetDataSteeringDataCheckJoiner
otError otNetDataSteeringDataCheckJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
Compruebe si los datos de dirección incluyen un carpintero.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Valores devueltos |
|
otNetDataSteeringDataCheckJoinerWithDiscerner
otError otNetDataSteeringDataCheckJoinerWithDiscerner( otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner )
Compruebe si los datos de dirección incluyen un ensamblador con un valor de discernidor dado.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Valores devueltos |
|
otNetDataUnpublishDnsSrpService
void otNetDataUnpublishDnsSrpService( otInstance *aInstance )
Esta función anula la publicación de cualquier entrada de "Servicio DNS/SRP (Anycast o Unicast)" agregada previamente de los datos de red de subprocesos.
Esta función requiere que la función OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
esté habilitada.
Detalles | |||
---|---|---|---|
Parámetros |
|
otNetDataUnpublishPrefix
otError otNetDataUnpublishPrefix( otInstance *aInstance, const otIp6Prefix *aPrefix )
Esta función anula la publicación de un prefijo publicado previamente (en malla o ruta externa).
Esta función requiere que la característica OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
esté habilitada.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
| ||||
Valores devueltos |
|
otSubprocesoConvertirse en niño
otError otThreadBecomeChild( otInstance *aInstance )
Intento de volver a conectar como un niño.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
| ||||
Valores devueltos |
|
otThreadBecomeDetached
otError otThreadBecomeDetached( otInstance *aInstance )
Separarse de la red Thread.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
| ||||
Valores devueltos |
|
otThreadDeviceRoleToString
const char * otThreadDeviceRoleToString( otDeviceRole aRole )
Convierta la función del dispositivo en una cadena legible por humanos.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | Una cadena que representa aRole . |
otThreadDiscover
otError otThreadDiscover( otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext )
Esta función inicia un análisis de detección de subprocesos.
Detalles | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parámetros |
| ||||||||||||||
Valores devueltos |
|
otThreadGetChildTimeout
uint32_t otThreadGetChildTimeout( otInstance *aInstance )
Obtener el tiempo de espera secundario del subproceso utilizado cuando se opera en el rol secundario.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | El valor de Tiempo de espera secundario de subproceso en segundos. |
otThreadSetChildTimeout
otThreadGetDeviceRole
otDeviceRole otThreadGetDeviceRole( otInstance *aInstance )
Obtenga la función del dispositivo.
Detalles | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parámetros |
| ||||||||||
Valores devueltos |
|
otThreadGetDomainName
const char * otThreadGetDomainName( otInstance *aInstance )
Obtenga el nombre de dominio del subproceso.
Esta función solo está disponible desde Thread 1.2.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | Un puntero al nombre de dominio del subproceso. |
otThreadSetDomainName
otThreadGetExtendedPanId
const otExtendedPanId * otThreadGetExtendedPanId( otInstance *aInstance )
Obtenga el ID de PAN extendido IEEE 802.15.4.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | Un puntero a IEEE 802.15.4 Extended PAN ID. |
otThreadSetExtendedPanId
otThreadGetFixedDuaInterfaceIdentifier
const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier( otInstance *aInstance )
Obtenga el identificador de interfaz especificado manualmente para la dirección de unidifusión del dominio de subprocesos.
Esta función solo está disponible desde el subproceso 1.2 cuando OPENTHREAD_CONFIG_DUA_ENABLE
está habilitado.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | Un puntero al Identificador de interfaz que se configuró manualmente, o NULL si no se configuró ninguno. |
otThreadSetFixedDuaInterfaceIdentifier
otThreadGetIp6Contadores
const otIpCounters * otThreadGetIp6Counters( otInstance *aInstance )
Obtenga los contadores de IPv6.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | Un puntero a los contadores de IPv6. |
otThreadGetKeySequenceCounter
uint32_t otThreadGetKeySequenceCounter( otInstance *aInstance )
Obtenga el thrKeySequenceCounter.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | El valor de thrKeySequenceCounter. |
otThreadSetKeySequenceCounter
otThreadGetKeySwitchGuardTime
uint32_t otThreadGetKeySwitchGuardTime( otInstance *aInstance )
Obtenga el thrKeySwitchGuardTime.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | El valor thrKeySwitchGuardTime (en horas). |
otThreadSetKeySwitchGuardTime
otThreadGetLeaderData
otError otThreadGetLeaderData( otInstance *aInstance, otLeaderData *aLeaderData )
Esta función obtiene los datos del líder del subproceso.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
| ||||
Valores devueltos |
|
otThreadGetLeaderRloc
otError otThreadGetLeaderRloc( otInstance *aInstance, otIp6Address *aLeaderRloc )
Esta función devuelve un puntero al RLOC del líder.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Valores devueltos |
|
otThreadGetLeaderRouterId
uint8_t otThreadGetLeaderRouterId( otInstance *aInstance )
Obtenga la identificación del enrutador del líder.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | El ID del enrutador del líder. |
otThreadGetLeaderWeight
uint8_t otThreadGetLeaderWeight( otInstance *aInstance )
Obtenga el peso del líder.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | El peso del líder. |
otThreadGetLinkLocalAllThreadNodesMulticastAddress
const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress( otInstance *aInstance )
Esta función devuelve la dirección de multidifusión Thread Link-Local All Thread Nodes.
La dirección es una dirección de multidifusión basada en prefijo de unidifusión local de enlace [RFC 3306], con:
- flgs establecidos en 3 (P = 1 y T = 1)
- alcance establecido en 2
- pleno establecido en 64
- prefijo de red establecido en el prefijo local de malla
- ID de grupo establecido en 1
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | Un puntero a la dirección de multidifusión Thread Link-Local All Thread Nodes. |
otThreadGetLinkLocalIp6Address
const otIp6Address * otThreadGetLinkLocalIp6Address( otInstance *aInstance )
Esta función devuelve la dirección IPv6 local del enlace de subproceso.
La dirección local del enlace de subproceso se obtiene utilizando la dirección extendida IEEE802.15.4 como identificador de interfaz.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | Un puntero a la dirección IPv6 local de enlace de subproceso. |
otThreadGetLinkMode
otLinkModeConfig otThreadGetLinkMode( otInstance *aInstance )
Obtenga la configuración del modo de enlace MLE.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | La configuración del modo de enlace MLE. |
otThreadSetLinkMode
otThreadGetMeshLocalEid
const otIp6Address * otThreadGetMeshLocalEid( otInstance *aInstance )
Esta función devuelve un puntero a la dirección EID local de malla.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | Un puntero a la dirección EID local de malla. |
otThreadGetMeshLocalPrefix
const otMeshLocalPrefix * otThreadGetMeshLocalPrefix( otInstance *aInstance )
Esta función devuelve un puntero al prefijo local de malla.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | Un puntero al prefijo local de malla. |
otThreadGetMleCounters
const otMleCounters * otThreadGetMleCounters( otInstance *aInstance )
Obtenga los contadores Thread MLE.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | Un puntero a los contadores Thread MLE. |
otThreadGetNetworkKey
void otThreadGetNetworkKey( otInstance *aInstance, otNetworkKey *aNetworkKey )
Obtenga la clave de red de subprocesos.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otThreadSetNetworkKey
otThreadGetNetworkKeyRef
otNetworkKeyRef otThreadGetNetworkKeyRef( otInstance *aInstance )
Obtenga otNetworkKeyRef
para la clave de red de subprocesos.
Esta función requiere que la función de tiempo de OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
esté habilitada.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | Referencia a la clave de red de subproceso almacenada en la memoria. |
otThreadSetNetworkKeyRef
otThreadGetNetworkName
const char * otThreadGetNetworkName( otInstance *aInstance )
Obtenga el nombre de la red del subproceso.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | Un puntero al nombre de la red de subprocesos. |
otThreadSetNetworkName
otThreadGetNextDiagnosticTlv
otError otThreadGetNextDiagnosticTlv( const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv )
Esta función obtiene el siguiente TLV de diagnóstico de red en el mensaje.
Solo se permite una llamada posterior a esta función cuando el valor de retorno actual es OT_ERROR_NONE.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Valores devueltos |
|
otThreadGetNextNeighborInfo
otError otThreadGetNextNeighborInfo( otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo )
Esta función obtiene la siguiente información del vecino.
Se utiliza para recorrer las entradas de la tabla de vecinos.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Return Values |
|
otThreadGetParentAverageRssi
otError otThreadGetParentAverageRssi( otInstance *aInstance, int8_t *aParentRssi )
The function retrieves the average RSSI for the Thread Parent.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otThreadGetParentInfo
otError otThreadGetParentInfo( otInstance *aInstance, otRouterInfo *aParentInfo )
The function retrieves diagnostic information for a Thread Router as parent.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otThreadGetParentLastRssi
otError otThreadGetParentLastRssi( otInstance *aInstance, int8_t *aLastRssi )
The function retrieves the RSSI of the last packet from the Thread Parent.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
| ||||||
Return Values |
|
otThreadGetPartitionId
uint32_t otThreadGetPartitionId( otInstance *aInstance )
Get the Partition ID.
Details | |||
---|---|---|---|
Parameters |
| ||
Returns | The Partition ID. |
otThreadGetRealmLocalAllThreadNodesMulticastAddress
const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress( otInstance *aInstance )
This function returns the Thread Realm-Local All Thread Nodes multicast address.
The address is a realm-local Unicast Prefix-Based Multcast Address [RFC 3306], with:
- flgs set to 3 (P = 1 and T = 1)
- scop set to 3
- plen set to 64
- network prefix set to the Mesh Local Prefix
- group ID set to 1
Details | |||
---|---|---|---|
Parameters |
| ||
Returns | A pointer to Thread Realm-Local All Thread Nodes multicast address. |
otThreadGetRloc
const otIp6Address * otThreadGetRloc( otInstance *aInstance )
This function returns a pointer to the Thread Routing Locator (RLOC) address.
Details | |||
---|---|---|---|
Parameters |
| ||
Returns | A pointer to the Thread Routing Locator (RLOC) address. |
otThreadGetRloc16
uint16_t otThreadGetRloc16( otInstance *aInstance )
Get the RLOC16.
Details | |||
---|---|---|---|
Parameters |
| ||
Returns | The RLOC16. |
otThreadGetServiceAloc
otError otThreadGetServiceAloc( otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc )
This function retrieves the Service ALOC for given Service ID.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
| ||||||
Return Values |
|
otThreadGetVersion
uint16_t otThreadGetVersion( void )
This function gets the Thread protocol version.
Details | |
---|---|
Returns | the Thread protocol version. |
otThreadIsAnycastLocateInProgress
bool otThreadIsAnycastLocateInProgress( otInstance *aInstance )
This function indicates whether an anycast locate request is currently in progress.
This function is only available when OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE
is enabled.
Details | |||
---|---|---|---|
Parameters |
| ||
Returns | TRUE if an anycast locate request is currently in progress, FALSE otherwise. |
otThreadIsDiscoverInProgress
bool otThreadIsDiscoverInProgress( otInstance *aInstance )
This function determines if an MLE Thread Discovery is currently in progress.
Details | |||
---|---|---|---|
Parameters |
|
otThreadIsSingleton
bool otThreadIsSingleton( otInstance *aInstance )
This function indicates whether a node is the only router on the network.
Details | |||||
---|---|---|---|---|---|
Parameters |
| ||||
Return Values |
|
otThreadLocateAnycastDestination
otError otThreadLocateAnycastDestination( otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext )
This function 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.
If a previous request is ongoing, a subsequent call to this function will cancel and replace the earlier request.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
| ||||||||
Return Values |
|
otThreadRegisterParentResponseCallback
void otThreadRegisterParentResponseCallback( otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext )
This function registers a callback to receive MLE Parent Response data.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
otThreadResetIp6Counters
void otThreadResetIp6Counters( otInstance *aInstance )
Reset the IPv6 counters.
Details | |||
---|---|---|---|
Parameters |
|
otThreadResetMleCounters
void otThreadResetMleCounters( otInstance *aInstance )
Reset the Thread MLE counters.
Details | |||
---|---|---|---|
Parameters |
|
otThreadSendAddressNotification
void otThreadSendAddressNotification( otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid )
This function sends a Proactive Address Notification (ADDR_NTF.ntf) message.
This function is only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
is enabled.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
|
otThreadSendDiagnosticGet
otError otThreadSendDiagnosticGet( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext )
Send a Network Diagnostic Get request.
Details | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parameters |
| ||||||||||||
Return Values |
|
otThreadSendDiagnosticReset
otError otThreadSendDiagnosticReset( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount )
Send a Network Diagnostic Reset request.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
| ||||||||
Return Values |
|
otThreadSendProactiveBackboneNotification
otError otThreadSendProactiveBackboneNotification( otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction )
This function 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.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
| ||||||||
Return Values |
|
otThreadSetChildTimeout
void otThreadSetChildTimeout( otInstance *aInstance, uint32_t aTimeout )
Set the Thread Child Timeout used when operating in the Child role.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otThreadGetChildTimeout
otThreadSetDiscoveryRequestCallback
void otThreadSetDiscoveryRequestCallback( otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext )
This function sets a callback to receive MLE Discovery Request data.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
otThreadSetDomainName
otError otThreadSetDomainName( otInstance *aInstance, const char *aDomainName )
Set the Thread Domain Name.
This function is only available since Thread 1.2. This function succeeds only when Thread protocols are disabled.
Details | |||||
---|---|---|---|---|---|
Parameters |
| ||||
Return Values |
|
otThreadGetDomainName
otThreadSetEnabled
otError otThreadSetEnabled( otInstance *aInstance, bool aEnabled )
This function starts Thread protocol operation.
The interface must be up when calling this function.
Details | |||||
---|---|---|---|---|---|
Parameters |
| ||||
Return Values |
|
otThreadSetExtendedPanId
otError otThreadSetExtendedPanId( otInstance *aInstance, const otExtendedPanId *aExtendedPanId )
Set the IEEE 802.15.4 Extended PAN ID.
This function can only be called while Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.
Details | |||||
---|---|---|---|---|---|
Parameters |
| ||||
Return Values |
|
otThreadGetExtendedPanId
otThreadSetFixedDuaInterfaceIdentifier
otError otThreadSetFixedDuaInterfaceIdentifier( otInstance *aInstance, const otIp6InterfaceIdentifier *aIid )
Set/Clear the Interface Identifier manually specified for the Thread Domain Unicast Address.
This function is only available since Thread 1.2 when OPENTHREAD_CONFIG_DUA_ENABLE
is enabled.
Details | |||||
---|---|---|---|---|---|
Parameters |
| ||||
Return Values |
|
otThreadGetFixedDuaInterfaceIdentifier
otThreadSetJoinerAdvertisement
otError otThreadSetJoinerAdvertisement( otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength )
This method 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, and to make this information available to Commissioners or Commissioner Candidates without human interaction.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
| ||||||||
Return Values |
|
otThreadSetKeySequenceCounter
void otThreadSetKeySequenceCounter( otInstance *aInstance, uint32_t aKeySequenceCounter )
Set the thrKeySequenceCounter.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otThreadGetKeySequenceCounter
otThreadSetKeySwitchGuardTime
void otThreadSetKeySwitchGuardTime( otInstance *aInstance, uint32_t aKeySwitchGuardTime )
Set the thrKeySwitchGuardTime.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otThreadGetKeySwitchGuardTime
otThreadSetLinkMode
otError otThreadSetLinkMode( otInstance *aInstance, otLinkModeConfig aConfig )
Set the MLE Link Mode configuration.
Details | |||||
---|---|---|---|---|---|
Parameters |
| ||||
Return Values |
|
otThreadGetLinkMode
otThreadSetMeshLocalPrefix
otError otThreadSetMeshLocalPrefix( otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix )
This function sets the Mesh Local Prefix.
This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.
Details | |||||
---|---|---|---|---|---|
Parameters |
| ||||
Return Values |
|
otThreadSetNetworkKey
otError otThreadSetNetworkKey( otInstance *aInstance, const otNetworkKey *aKey )
Set the Thread Network Key.
This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.
Details | |||||
---|---|---|---|---|---|
Parameters |
| ||||
Return Values |
|
otThreadGetNetworkKey
otThreadSetNetworkKeyRef
otError otThreadSetNetworkKeyRef( otInstance *aInstance, otNetworkKeyRef aKeyRef )
Set the Thread Network Key as a otNetworkKeyRef
.
This function 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.
Details | |||||
---|---|---|---|---|---|
Parameters |
| ||||
Return Values |
|
otThreadGetNetworkKeyRef
otThreadSetNetworkName
otError otThreadSetNetworkName( otInstance *aInstance, const char *aNetworkName )
Set the Thread Network Name.
This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.
Details | |||||
---|---|---|---|---|---|
Parameters |
| ||||
Return Values |
|
otThreadGetNetworkName
Macros
OT_JOINER_ADVDATA_MAX_LENGTH
OT_JOINER_ADVDATA_MAX_LENGTH 64
Maximum AdvData Length of Joiner Advertisement.
OT_NEIGHBOR_INFO_ITERATOR_INIT
OT_NEIGHBOR_INFO_ITERATOR_INIT 0
Initializer for otNeighborInfoIterator.
OT_NETWORK_BASE_TLV_MAX_LENGTH
OT_NETWORK_BASE_TLV_MAX_LENGTH 254
Maximum value length of Thread Base TLV.
OT_NETWORK_DATA_ITERATOR_INIT
OT_NETWORK_DATA_ITERATOR_INIT 0
Value to initialize otNetworkDataIterator
.
OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE
OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3
Size of Network Diagnostic Child Table entry.
OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT
OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0
Initializer for otNetworkDiagIterator.
OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES
OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19
Maximum Number of Network Diagnostic TLV Types to Request or Reset.
OT_NETWORK_MAX_ROUTER_ID
OT_NETWORK_MAX_ROUTER_ID 62
Maximum Router ID.
OT_SERVER_DATA_MAX_SIZE
OT_SERVER_DATA_MAX_SIZE 248
Max size of Server Data in bytes. Theoretical limit, practically much lower.
OT_SERVICE_DATA_MAX_SIZE
OT_SERVICE_DATA_MAX_SIZE 252
Max size of Service Data in bytes.
Resources
OpenThread API Reference topics originate from the source code, available on GitHub . For more information, or to contribute to our documentation, refer to Resources .