General
Este módulo incluye funciones para todas las funciones de Thread.
Resumen
El editor de datos de red proporciona mecanismos para limitar la cantidad de entradas de servicios o prefijos similares (prefijo en malla o ruta externa) en los datos de red de subprocesos mediante la supervisión de los datos de red y la administración de si se deben agregar o quitar entradas.
Todas las funciones de este módulo requieren que se habilite OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE
.
Typedefs |
|
---|---|
otBorderRouterConfig
|
typedefstruct otBorderRouterConfig
Esta estructura representa una configuración de router de borde. |
otDetachGracefullyCallback)(void *aContext)
|
typedefvoid(*
Este callback le informa a la aplicación que finalizó el proceso de desconexión. |
otExternalRouteConfig
|
typedefstruct otExternalRouteConfig
Esta estructura representa una configuración de ruta externa. |
otIpCounters
|
typedefstruct otIpCounters
Esta estructura representa los contadores de nivel de IP. |
otLeaderData
|
typedefstruct otLeaderData
Esta estructura representa los datos del líder de subprocesos. |
otLinkModeConfig
|
typedefstruct otLinkModeConfig
Esta estructura representa una configuración del modo de vínculo MLE. |
otMleCounters
|
typedefstruct otMleCounters
Esta estructura representa los contadores de MLE de Thread. |
otNeighborInfoIterator
|
typedefint16_t
Se usa para iterar a través de una tabla vecina. |
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)
|
typedefvoid(*
Este tipo de puntero de función define la devolución de llamada que se usa para notificar cuando se agrega una entrada de servicio de DNS/SRP a los datos de red de subprocesos o se quita de ellos. |
otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)
|
typedefvoid(*
Este tipo de puntero de función define la devolución de llamada que se usa para notificar cuando se agrega una entrada de prefijo (en la malla o una ruta externa) a los datos de red de Thread o se quita. |
otNetDataPublisherEvent
|
typedef Esta enumeración representa los eventos informados desde las devoluciones de llamada del publicador. |
otNetworkDataIterator
|
typedefuint32_t
Se usa para iterar a través de la información de datos de red. |
otNetworkDiagChildEntry
|
typedefstruct otNetworkDiagChildEntry
Esta estructura representa una entrada de tabla secundaria de diagnóstico de red. |
otNetworkDiagConnectivity
|
typedefstruct otNetworkDiagConnectivity
Esta estructura representa un valor de conectividad de diagnóstico de red. |
otNetworkDiagIterator
|
typedefuint16_t
Se usa para iterar a través del TLV de diagnóstico de red. |
otNetworkDiagMacCounters
|
typedefstruct otNetworkDiagMacCounters
Esta estructura representa un valor de contador de Mac de diagnóstico de red. |
otNetworkDiagRoute
|
typedefstruct otNetworkDiagRoute
Esta estructura representa un valor de TLV de la ruta de diagnóstico de red. |
otNetworkDiagRouteData
|
typedefstruct otNetworkDiagRouteData
Esta estructura representa los datos de una ruta de diagnóstico de red. |
otNetworkDiagTlv
|
typedefstruct otNetworkDiagTlv
Esta estructura representa un TLV de diagnóstico de red. |
otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)
|
typedefvoid(*
Se llama a este puntero de función cuando se recibe una respuesta Get de diagnóstico de la red. |
otRoutePreference
|
typedefenum otRoutePreference
|
otServerConfig
|
typedefstruct otServerConfig
Esta estructura representa una configuración del servidor. |
otServiceConfig
|
typedefstruct otServiceConfig
Esta estructura representa una configuración de servicio. |
otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)
|
typedefvoid(*
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)
|
typedefvoid(*
Se llama a este puntero de función cada vez que se recibe un mensaje de solicitud de descubrimiento de MLE. |
otThreadDiscoveryRequestInfo
|
typedefstruct otThreadDiscoveryRequestInfo
Esta estructura representa los datos de la solicitud de descubrimiento de subprocesos. |
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)
|
typedefvoid(*
Se llama a este puntero de función cada vez que se recibe un mensaje de respuesta superior de MLE. |
otThreadParentResponseInfo
|
typedefstruct otThreadParentResponseInfo
Esta estructura representa los datos de la respuesta principal de MLE. |
Funciones |
|
---|---|
otNetDataContainsOmrPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
|
bool
Esta función verifica si un prefijo determinado puede actuar como un prefijo de OMR válido y si también lo contiene el dato de red del líder.
|
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 de 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
Obtén la versión estable de datos de red.
|
otNetDataGetVersion(otInstance *aInstance)
|
uint8_t
Obtén la versión de datos de la red.
|
otNetDataIsDnsSrpServiceAdded(otInstance *aInstance)
|
bool
Esta función indica si se agregó o no la entrada "DNS/SRP Service' a los datos de red de Thread.
|
otNetDataIsPrefixAdded(otInstance *aInstance, const otIp6Prefix *aPrefix)
|
bool
Esta función indica si actualmente se agrega o no una entrada de prefijo publicada (en malla o una ruta externa) a los datos de red de Thread.
|
otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)
|
void
Esta función solicita que la dirección Anycast del servicio de DNS/SRP se publique en los datos de la red Thread.
|
otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
|
void
Esta función solicita que la dirección Unicast del servicio DNS/SRP se publique en los datos de la red Thread.
|
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)
|
void
Esta función solicita que la dirección Unicast del servicio DNS/SRP se publique en los datos de la red Thread.
|
otNetDataPublishExternalRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
|
Esta función solicita que se publique un prefijo de ruta externo en los datos de la red Thread.
|
otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
|
Esta función solicita que se publique un prefijo en la malla en los datos de la red Thread.
|
otNetDataSetDnsSrpServicePublisherCallback(otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
|
void
Esta función configura una devolución de llamada para notificar cuando un "servicio DNS/SRP" publicado se agrega o quita de los datos de red de Thread.
|
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 quita de los datos de red de Thread.
|
otNetDataSteeringDataCheckJoiner(otInstance *aInstance, const otExtAddress *aEui64)
|
Compruebe si los datos de dirección incluyen un elemento Joiner.
|
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
|
Verifica si los datos de dirección incluyen un elemento Joiner con un valor determinado de discernimiento.
|
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
|
void
Anula la publicación de cualquier entrada de servicio de DNS/SRP (Anycast o Unicast) que se haya agregado anteriormente de los datos de red de Thread.
|
otNetDataUnpublishPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
|
Anula la publicación de un prefijo de ruta externa o en malla ya publicado.
|
otThreadBecomeChild(otInstance *aInstance)
|
Intenta volver a adjuntarte como niño.
|
otThreadBecomeDetached(otInstance *aInstance)
|
Desconéctate de la red Thread.
|
otThreadDetachGracefully(otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)
|
Esta función notifica a otros nodos de la red (si los hubiera) y, luego, detiene la operación del protocolo Thread.
|
otThreadDeviceRoleToString(otDeviceRole aRole)
|
const char *
Convierte la función del dispositivo en una string legible.
|
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 Thread Discovery.
|
otThreadGetChildTimeout(otInstance *aInstance)
|
uint32_t
Obtiene el tiempo de espera de conversación de subprocesos secundarios (en segundos) que se usa cuando se opera en la función secundaria.
|
otThreadGetDeviceRole(otInstance *aInstance)
|
Obtén la función de dispositivo.
|
otThreadGetDomainName(otInstance *aInstance)
|
const char *
Obtiene el nombre de dominio del subproceso.
|
otThreadGetExtendedPanId(otInstance *aInstance)
|
const otExtendedPanId *
Obtiene el ID PAN extendido IEEE 802.15.4.
|
otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)
|
const otIp6InterfaceIdentifier *
Obtiene el identificador de interfaz especificado manualmente para la dirección de unicat de dominio de Thread.
|
otThreadGetIp6Counters(otInstance *aInstance)
|
const otIpCounters *
Obtiene los contadores de IPv6.
|
otThreadGetKeySequenceCounter(otInstance *aInstance)
|
uint32_t
Obtiene el thrKeySequenceCounter.
|
otThreadGetKeySwitchGuardTime(otInstance *aInstance)
|
uint32_t
Obtiene el thrKeySwitchGuardTime (en horas).
|
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
|
Esta función obtiene los datos del líder de subprocesos.
|
otThreadGetLeaderRloc(otInstance *aInstance, otIp6Address *aLeaderRloc)
|
Esta función muestra un puntero al RLOC del líder.
|
otThreadGetLeaderRouterId(otInstance *aInstance)
|
uint8_t
Obtén el ID de router del líder.
|
otThreadGetLeaderWeight(otInstance *aInstance)
|
uint8_t
Obtén el peso del líder.
|
otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
|
const otIp6Address *
Obtiene la dirección de multidifusión de Thread Link-Local All Thread Nodes.
|
otThreadGetLinkLocalIp6Address(otInstance *aInstance)
|
const otIp6Address *
Obtiene la dirección IPv6 del vínculo local de Thread.
|
otThreadGetLinkMode(otInstance *aInstance)
|
Obtén la configuración del modo de vínculo MLE.
|
otThreadGetMeshLocalEid(otInstance *aInstance)
|
const otIp6Address *
Obtiene la dirección EID local de la malla.
|
otThreadGetMeshLocalPrefix(otInstance *aInstance)
|
const otMeshLocalPrefix *
Esta función muestra un puntero al prefijo local de malla.
|
otThreadGetMleCounters(otInstance *aInstance)
|
const otMleCounters *
Obtiene los contadores de MLE de Thread.
|
otThreadGetNetworkKey(otInstance *aInstance, otNetworkKey *aNetworkKey)
|
void
Obtén la clave de red Thread.
|
otThreadGetNetworkKeyRef(otInstance *aInstance)
|
Obtén la
otNetworkKeyRef para la clave de red de Thread. |
otThreadGetNetworkName(otInstance *aInstance)
|
const char *
Obtén el nombre de la red de Thread.
|
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 del subproceso superior.
|
otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo)
|
La función recupera información de diagnóstico para un Thread Router como superior.
|
otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi)
|
La función recupera el RSSI del último paquete del subproceso superior.
|
otThreadGetPartitionId(otInstance *aInstance)
|
uint32_t
Obtén el ID de partición.
|
otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
|
const otIp6Address *
Obtiene la dirección multidifusión de Thread Realm-Local All Thread Nodes.
|
otThreadGetRloc(otInstance *aInstance)
|
const otIp6Address *
Obtiene la dirección del localizador de enrutamiento de subprocesos (RLOC).
|
otThreadGetRloc16(otInstance *aInstance)
|
uint16_t
Obtén el RLOC16.
|
otThreadGetServiceAloc(otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
|
Esta función recupera el ALOC del servicio para un ID de servicio determinado.
|
otThreadGetVersion(void)
|
uint16_t
Esta función obtiene la versión de protocolo de Thread.
|
otThreadIsAnycastLocateInProgress(otInstance *aInstance)
|
bool
Esta función indica si una solicitud de ubicación Anycast está en curso.
|
otThreadIsDiscoverInProgress(otInstance *aInstance)
|
bool
Esta función determina si actualmente hay un descubrimiento de subprocesos de MLE en curso.
|
otThreadIsSingleton(otInstance *aInstance)
|
bool
Esta función indica si un nodo es el único router de la red.
|
otThreadLocateAnycastDestination(otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
|
Esta función solicita que se ubique el destino más cercano de una dirección Anycast determinada.
|
otThreadRegisterParentResponseCallback(otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
|
void
Esta función registra una devolución de llamada para recibir datos de la respuesta principal de MLE.
|
otThreadResetIp6Counters(otInstance *aInstance)
|
void
Restablece los contadores de IPv6.
|
otThreadResetMleCounters(otInstance *aInstance)
|
void
Restablece los contadores de MLE de Thread.
|
otThreadSearchForBetterParent(otInstance *aInstance)
|
Inicia el proceso para que el elemento secundario busque un superior y, al mismo tiempo, permanezca conectado a su elemento superior actual.
|
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ía 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 troncal proactiva (PRO_BB.ntf) en el vínculo de la red troncal.
|
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
|
void
Establece el tiempo de espera del elemento secundario del subproceso (en segundos) que se usa cuando se opera en la función secundaria.
|
otThreadSetDiscoveryRequestCallback(otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
|
void
Esta función establece una devolución de llamada para recibir datos de la solicitud de descubrimiento de MLE.
|
otThreadSetDomainName(otInstance *aInstance, const char *aDomainName)
|
Establece 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)
|
Configura el ID de PAN extendido IEEE 802.15.4.
|
otThreadSetFixedDuaInterfaceIdentifier(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
|
Establece o borra el identificador de interfaz especificado manualmente para la dirección Unicast de Thread.
|
otThreadSetJoinerAdvertisement(otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
|
Este método establece el anuncio del conector de subprocesos cuando se descubre la red de subprocesos.
|
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
|
void
Configura thrKeySequenceCounter.
|
otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)
|
void
Configura el thrKeySwitchGuardTime (en horas).
|
otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)
|
Establece la configuración del modo de vínculo MLE.
|
otThreadSetMeshLocalPrefix(otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
|
Esta función establece el prefijo local de la malla.
|
otThreadSetNetworkKey(otInstance *aInstance, const otNetworkKey *aKey)
|
Configura la clave de red del subproceso.
|
otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)
|
Configura la clave de red del subproceso como
otNetworkKeyRef . |
otThreadSetNetworkName(otInstance *aInstance, const char *aNetworkName)
|
Configura el nombre de la red Thread.
|
Structs |
|
---|---|
otBorderRouterConfig |
Esta estructura representa una configuración de router de borde. |
otExternalRouteConfig |
Esta estructura representa una configuración de ruta externa. |
otIpCounters |
Esta estructura representa los contadores de nivel de IP. |
DatosdeotLeader |
Esta estructura representa los datos del líder de subprocesos. |
otLinkModeConfig |
Esta estructura representa una configuración del modo de vínculo MLE. |
otMleCounters |
Esta estructura representa los contadores de MLE de Thread. |
otvecino |
Esta estructura contiene información de diagnóstico para un nodo de Thread vecino. |
otNetworkDiagChildEntry |
Esta estructura representa una entrada de tabla secundaria de diagnóstico de red. |
otNetworkDiagConnectivity |
Esta estructura representa un valor de conectividad de diagnóstico de red. |
otNetworkDiagMacCounters |
Esta estructura representa un valor de contador de Mac de diagnóstico de red. |
otNetworkDiagRoute |
Esta estructura representa un valor de TLV de la 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 router de subprocesos. |
otServerConfig. |
Esta estructura representa una configuración del servidor. |
otServiceConfig. |
Esta estructura representa una configuración de servicio. |
otThreadDiscoveryRequestInfo. |
Esta estructura representa los datos de la solicitud de descubrimiento de subprocesos. |
otThreadParentResponseInfo. |
Esta estructura representa los datos de la respuesta principal de MLE. |
Enumeraciones
enumeración anónima
anonymous enum
Función del dispositivo ot
otDeviceRole
Representa una función del dispositivo Thread.
Propiedades | |
---|---|
OT_DEVICE_ROLE_CHILD
|
La función Thread Child. |
OT_DEVICE_ROLE_DETACHED
|
No participas en una red o partición de Thread. |
OT_DEVICE_ROLE_DISABLED
|
La pila Thread está inhabilitada. |
OT_DEVICE_ROLE_LEADER
|
La función de líder del subproceso |
OT_DEVICE_ROLE_ROUTER
|
La función de router de subprocesos. |
otNetDataPublisherEvent
otNetDataPublisherEvent
Esta enumeración representa los eventos informados desde las devoluciones de llamada del publicador.
Propiedades | |
---|---|
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED
|
La entrada publicada se agrega a los datos de red de Thread. |
OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED
|
Se quita la entrada publicada de los datos de red de Thread. |
otRoutePreference
otRoutePreference
Define valores válidos para mPreference
en otExternalRouteConfig
y otBorderRouterConfig
.
Propiedades | |
---|---|
OT_ROUTE_PREFERENCE_HIGH
|
Preferencia de ruta alta |
OT_ROUTE_PREFERENCE_LOW
|
Preferencia de ruta baja. |
OT_ROUTE_PREFERENCE_MED
|
Preferencia de ruta media. |
Typedefs
otBorderRouterConfig
struct otBorderRouterConfig otBorderRouterConfig
Esta estructura representa una configuración de router de borde.
otDetachGraceGraceCallback
void(* otDetachGracefullyCallback)(void *aContext)
Este callback le informa a la aplicación que finalizó el proceso de desconexión.
Detalles | |||
---|---|---|---|
Parámetros |
|
Configuración 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.
Datos principales de otLeader
struct otLeaderData otLeaderData
Esta estructura representa los datos del líder de subprocesos.
otLinkModeConfig
struct otLinkModeConfig otLinkModeConfig
Esta estructura representa una configuración del modo de vínculo MLE.
otMleCounters
struct otMleCounters otMleCounters
Esta estructura representa los contadores de MLE de Thread.
otNeighborInfoIterator
int16_t otNeighborInfoIterator
Se usa para iterar a través de una tabla vecina.
otNetDataDnsSrpServicePublisherCallback
void(* otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)
Este tipo de puntero de función define la devolución de llamada que se usa para notificar cuando se agrega una entrada de servicio de DNS/SRP a los datos de red de subprocesos o se quita de ellos.
Cuando se quita la devolución de llamada, se invoca independientemente de que Publisher
quite la entrada (p. ej., cuando ya hay demasiadas entradas similares en los datos de red) o mediante una llamada explícita para anular la publicación (es decir, una llamada a otNetDataUnpublishDnsSrpService()
).
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otNetDataPrefixPublisherPublisher
void(* otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)
Este tipo de puntero de función define la devolución de llamada que se usa para notificar cuando se agrega una entrada de prefijo (en la malla o una ruta externa) a los datos de red de Thread o se quita.
Cuando se quita, se invoca la devolución de llamada independientemente de que Publisher
quite la entrada (p.ej., cuando ya hay demasiadas entradas similares en los datos de red) o mediante una llamada explícita para anular la publicación.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
otNetDataPublisherEvent
enum otNetDataPublisherEvent otNetDataPublisherEvent
Esta enumeración representa los eventos informados desde las devoluciones de llamada del publicador.
otNetworkDataIterator
uint32_t otNetworkDataIterator
Se usa 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.
otNetworkDiagConnectivity
struct otNetworkDiagConnectivity otNetworkDiagConnectivity
Esta estructura representa un valor de conectividad de diagnóstico de red.
otNetworkDiagIterator
uint16_t otNetworkDiagIterator
Se usa para iterar a través del TLV de diagnóstico de red.
otNetworkDiagMacCounters
struct otNetworkDiagMacCounters otNetworkDiagMacCounters
Esta estructura representa un valor de contador de Mac de diagnóstico de red.
Consulta RFC 2863 para ver las definiciones de los campos de los miembros.
otNetworkDiagRoute
struct otNetworkDiagRoute otNetworkDiagRoute
Esta estructura representa un valor de TLV de la 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 una respuesta Get de diagnóstico de la red.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
otRoutePreference
enum otRoutePreference otRoutePreference
Define valores válidos para mPreference
en otExternalRouteConfig
y otBorderRouterConfig
.
Configuración del servidor ot
struct otServerConfig otServerConfig
Esta estructura representa una configuración del 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)
Se llama a este puntero de función cada vez que se recibe un mensaje de solicitud de descubrimiento de MLE.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otThreadDiscoveryRequestInfo
struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo
Esta estructura representa los datos de la solicitud de descubrimiento de subprocesos.
otThreadParentResponseCallback.
void(* otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)
Se llama a este puntero de función cada vez que se recibe un mensaje de respuesta superior de MLE.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otThreadParentResponseInfo.
struct otThreadParentResponseInfo otThreadParentResponseInfo
Esta estructura representa los datos de la respuesta principal de MLE.
Funciones
otNetDataContainsOmrPrefix
bool otNetDataContainsOmrPrefix( otInstance *aInstance, const otIp6Prefix *aPrefix )
Esta función verifica si un prefijo determinado puede actuar como un prefijo de OMR válido y si también lo contiene el dato de red del líder.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Qué muestra |
Si
aPrefix es un prefijo de OMR válido y los Datos de red del líder contienen el prefijo de 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 de malla en los datos de red de la partición.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores de retorno |
|
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 de retorno |
|
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 de retorno |
|
otNetDataGetStableVersion
uint8_t otNetDataGetStableVersion( otInstance *aInstance )
Obtén la versión estable de datos de red.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
La versión de datos de red estable.
|
otNetDataGetVersion
uint8_t otNetDataGetVersion( otInstance *aInstance )
Obtén la versión de datos de la red.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
La versión de datos de red.
|
otNetDataIsDnsSrpServiceAdded
bool otNetDataIsDnsSrpServiceAdded( otInstance *aInstance )
Esta función indica si se agregó o no la entrada "DNS/SRP Service' a los datos de red de Thread.
Esta función requiere que se habilite la función OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores de retorno |
|
otNetDataIsPrefixAdded
bool otNetDataIsPrefixAdded( otInstance *aInstance, const otIp6Prefix *aPrefix )
Esta función indica si actualmente se agrega o no una entrada de prefijo publicada (en malla o una ruta externa) a los datos de red de Thread.
Esta función requiere que se habilite la función OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores de retorno |
|
otNetDataPublishDnsSrpServiceAnycast
void otNetDataPublishDnsSrpServiceAnycast( otInstance *aInstance, uint8_t aSequenceNUmber )
Esta función solicita que la dirección Anycast del servicio de DNS/SRP se publique en los datos de la red Thread.
Esta función requiere que se habilite la función OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
.
Una llamada a esta función quitará y reemplazará cualquier entrada anterior del "Servicio DNS/SRP" que se haya publicado (de una llamada anterior a cualquiera de las funciones otNetDataPublishDnsSrpService{Type}()
).
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otNetDataPublishDnsSrpServiceUnicast
void otNetDataPublishDnsSrpServiceUnicast( otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort )
Esta función solicita que la dirección Unicast del servicio DNS/SRP se publique en los datos de la red Thread.
Esta función requiere que se habilite la función OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
.
Una llamada a esta función quitará y reemplazará cualquier entrada anterior del "Servicio DNS/SRP" que se haya publicado (de una llamada anterior a cualquiera de las funciones otNetDataPublishDnsSrpService{Type}()
).
Esta función publica la dirección Unicast del servicio de DNS/SRP al incluir la información de puerto y dirección en los datos de TLV del servicio.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid
void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid( otInstance *aInstance, uint16_t aPort )
Esta función solicita que la dirección Unicast del servicio DNS/SRP se publique en los datos de la red Thread.
Esta función requiere que se habilite la función OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
.
Una llamada a esta función quitará y reemplazará cualquier entrada anterior del"Servicio DNS/SRP"que se haya publicado (de una llamada anterior a cualquiera de las funciones otNetDataPublishDnsSrpService{Type}()
).
A diferencia de otNetDataPublishDnsSrpServiceUnicast()
, que requiere que se proporcione la dirección publicada y que incluya la información de los datos de TLV del servicio, esta función usa el EID local de la malla del dispositivo y, además, incluye la información de los datos de 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 Thread.
Esta función requiere que se habilite la función OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
.
Solo se pueden publicar entradas estables (es decir,aConfig.mStable
DEBE ser VERDADERO.
Una llamada posterior a este método reemplazará una solicitud anterior por el mismo prefijo. En particular, si la nueva llamada solo cambia las marcas (p.ej., el nivel de preferencia) y el prefijo ya se agregó en los datos de red, el cambio a las marcas se refleja de inmediato en los datos de red. Esto garantiza que las entradas existentes en los datos de red no se quiten abruptamente. Ten en cuenta que un cambio en el nivel de preferencia puede hacer que la entrada se quite de los datos de red después de determinar que hay otros nodos que publican el mismo prefijo con la misma preferencia o una superior.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores de retorno |
|
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 Thread.
Esta función requiere que se habilite la función OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
.
Solo se pueden publicar entradas estables (es decir,aConfig.mStable
DEBE ser VERDADERO.
Una llamada posterior a este método reemplazará una solicitud anterior por el mismo prefijo. En particular, si la nueva llamada solo cambia las marcas (p.ej., el nivel de preferencia) y el prefijo ya se agregó en los datos de red, el cambio a las marcas se refleja de inmediato en los datos de red. Esto garantiza que las entradas existentes en los datos de red no se quiten abruptamente. Ten en cuenta que un cambio en el nivel de preferencia puede hacer que la entrada se quite de los datos de red después de determinar que hay otros nodos que publican el mismo prefijo con la misma preferencia o una superior.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores de retorno |
|
otNetDataSetDnsSrpServicePublisherCallback
void otNetDataSetDnsSrpServicePublisherCallback( otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext )
Esta función configura una devolución de llamada para notificar cuando un "servicio DNS/SRP" publicado se agrega o quita de los datos de red de Thread.
Una llamada posterior a esta función reemplaza cualquier función de devolución de llamada configurada previamente.
Esta función requiere que se habilite la función OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
.
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 quita de los datos de red de Thread.
Una llamada posterior a esta función reemplaza cualquier función de devolución de llamada configurada previamente.
Esta función requiere que se habilite la función OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
otNetDataSteeringDataCheckJoiner
otError otNetDataSteeringDataCheckJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
Compruebe si los datos de dirección incluyen un elemento Joiner.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores de retorno |
|
otNetDataSteeringDataCheckJoinerWithDiscerner
otError otNetDataSteeringDataCheckJoinerWithDiscerner( otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner )
Verifica si los datos de dirección incluyen un elemento Joiner con un valor determinado de discernimiento.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores de retorno |
|
otNetDataUnpublishDnsSrpService
void otNetDataUnpublishDnsSrpService( otInstance *aInstance )
Anula la publicación de cualquier entrada de servicio de DNS/SRP (Anycast o Unicast) que se haya agregado anteriormente de los datos de red de Thread.
Se debe habilitar OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
.
Detalles | |||
---|---|---|---|
Parámetros |
|
otNetDataUnpublishPrefix
otError otNetDataUnpublishPrefix( otInstance *aInstance, const otIp6Prefix *aPrefix )
Anula la publicación de un prefijo de ruta externa o en malla ya publicado.
Se debe habilitar OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores de retorno |
|
otThreadConvertChild
otError otThreadBecomeChild( otInstance *aInstance )
Intenta volver a adjuntarte como niño.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores de retorno |
|
otThread Separe
otError otThreadBecomeDetached( otInstance *aInstance )
Desconéctate de la red Thread.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores de retorno |
|
otThreadDetachGraceful
otError otThreadDetachGracefully( otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext )
Esta función notifica a otros nodos de la red (si los hubiera) y, luego, detiene la operación del protocolo Thread.
Envía una liberación de dirección si es un router o establece el tiempo de espera de su hijo en 0 si es un secundario.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores de retorno |
|
otThreadDeviceRoleToString;
const char * otThreadDeviceRoleToString( otDeviceRole aRole )
Convierte la función del dispositivo en una string legible.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
Una string 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 Thread Discovery.
Detalles | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||||||||
Valores de retorno |
|
otThreadGetChildTimeout
uint32_t otThreadGetChildTimeout( otInstance *aInstance )
Obtiene el tiempo de espera de conversación de subprocesos secundarios (en segundos) que se usa cuando se opera en la función secundaria.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
El valor de tiempo de espera de la conversación secundaria en segundos.
|
otThreadSetChildTimeout
otThreadGetDeviceRole
otDeviceRole otThreadGetDeviceRole( otInstance *aInstance )
Obtén la función de dispositivo.
Detalles | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||||
Valores de retorno |
|
otThreadGetDomainName
const char * otThreadGetDomainName( otInstance *aInstance )
Obtiene el nombre de dominio del subproceso.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
Un puntero para el nombre de dominio del subproceso.
|
otThreadSetDomainName
ID de otThreadGetExtendedPanId
const otExtendedPanId * otThreadGetExtendedPanId( otInstance *aInstance )
Obtiene el ID PAN extendido IEEE 802.15.4.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
Un puntero del ID de PAN extendido IEEE 802.15.4.
|
otThreadSetExtendedPanId
otThreadGetFixedDuaInterfaceIdentifier
const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier( otInstance *aInstance )
Obtiene el identificador de interfaz especificado manualmente para la dirección de unicat de dominio de Thread.
Disponible cuando OPENTHREAD_CONFIG_DUA_ENABLE
está habilitado.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
Un puntero para el identificador de interfaz que se configuró manualmente o NULL si no se estableció ninguno.
|
otThreadSetFixedDuaInterfaceIdentifier
otThreadGetIp6Counters
const otIpCounters * otThreadGetIp6Counters( otInstance *aInstance )
Obtiene los contadores de IPv6.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
Un puntero para los contadores de IPv6.
|
otThreadGetKeySequenceCounter
uint32_t otThreadGetKeySequenceCounter( otInstance *aInstance )
Obtiene el thrKeySequenceCounter.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
El valor thrKeySequenceCounter.
|
otThreadSetKeySequenceCounter
otThreadGetKeySwitchGuardTime
uint32_t otThreadGetKeySwitchGuardTime( otInstance *aInstance )
Obtiene el thrKeySwitchGuardTime (en horas).
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
El valor de thrKeySwitchGuardTime (en horas).
|
otThreadSetKeySwitchGuardTime
otThreadGetLeaderData
otError otThreadGetLeaderData( otInstance *aInstance, otLeaderData *aLeaderData )
Esta función obtiene los datos del líder de subprocesos.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores de retorno |
|
oThreadThreadGetLeaderRloc
otError otThreadGetLeaderRloc( otInstance *aInstance, otIp6Address *aLeaderRloc )
Esta función muestra un puntero al RLOC del líder.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores de retorno |
|
ID de otThreadGetLeaderRouter
uint8_t otThreadGetLeaderRouterId( otInstance *aInstance )
Obtén el ID de router del líder.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
El ID de router del líder.
|
otThreadGetLeaderWeight
uint8_t otThreadGetLeaderWeight( otInstance *aInstance )
Obtén el peso del líder.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
El peso del líder.
|
otThreadGetLinkLocalAllThreadNodesMulticastAddress
const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress( otInstance *aInstance )
Obtiene la dirección de multidifusión de Thread Link-Local All Thread Nodes.
La dirección es una dirección de multidifusión basada en prefijos Unicast local [RFC 3306] de vínculo, con:
- flgs establecidos en 3 (P = 1 y T = 1)
- scop configurado en 2
- plen configurado en 64
- el prefijo de red establecido en el prefijo local de malla
- ID de grupo establecido en 1
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
Un puntero para la dirección de multidifusión de Thread Link-Local All Thread Nodes.
|
Dirección otThreadGetLinkLocalIp6
const otIp6Address * otThreadGetLinkLocalIp6Address( otInstance *aInstance )
Obtiene la dirección IPv6 del vínculo local de Thread.
La dirección local del vínculo de Thread se deriva de la dirección extendida IEEE802.15.4 como identificador de interfaz.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
Un puntero para la dirección IPv6 de vínculo local de Thread.
|
otThreadGetLinkMode
otLinkModeConfig otThreadGetLinkMode( otInstance *aInstance )
Obtén la configuración del modo de vínculo MLE.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
La configuración del modo de vínculo MLE.
|
otThreadSetLinkMode
otThreadGetMeshLocalEid
const otIp6Address * otThreadGetMeshLocalEid( otInstance *aInstance )
Obtiene la dirección EID local de la malla.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
Un puntero para la dirección EID local de la malla.
|
otThreadGetMeshLocalPrefix
const otMeshLocalPrefix * otThreadGetMeshLocalPrefix( otInstance *aInstance )
Esta función muestra un puntero al prefijo local de malla.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
Un puntero para el prefijo local de malla.
|
otThreadGetMleCounters
const otMleCounters * otThreadGetMleCounters( otInstance *aInstance )
Obtiene los contadores de MLE de Thread.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
Un puntero para los contadores de MLE de Thread.
|
otThreadGetNetworkKey
void otThreadGetNetworkKey( otInstance *aInstance, otNetworkKey *aNetworkKey )
Obtén la clave de red Thread.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otThreadSetNetworkKey
otThreadGetNetworkKeyRef
otNetworkKeyRef otThreadGetNetworkKeyRef( otInstance *aInstance )
Obtén la otNetworkKeyRef
para la clave de red de Thread.
Esta función requiere que se habilite la función de tiempo de compilación OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
Referencia a la clave de red Thread almacenada en la memoria.
|
otThreadSetNetworkKeyRef
otThreadGetNetworkName
const char * otThreadGetNetworkName( otInstance *aInstance )
Obtén el nombre de la red de Thread.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
Un puntero para el nombre de red del subproceso.
|
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.
Se permite una llamada posterior a esta función solo cuando el valor de retorno actual es OT_ERROR_NONE.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores de retorno |
|
otThreadGetNextNeighborInfo
otError otThreadGetNextNeighborInfo( otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo )
Esta función obtiene la siguiente información del vecino.
Se usa para recorrer las entradas de la tabla vecina.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores de retorno |
|
otThreadGetParentAverageRssi.
otError otThreadGetParentAverageRssi( otInstance *aInstance, int8_t *aParentRssi )
La función recupera el RSSI promedio del subproceso superior.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otThreadGetParentInfo
otError otThreadGetParentInfo( otInstance *aInstance, otRouterInfo *aParentInfo )
La función recupera información de diagnóstico para un Thread Router como superior.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otThreadGetParentLastRssi
otError otThreadGetParentLastRssi( otInstance *aInstance, int8_t *aLastRssi )
La función recupera el RSSI del último paquete del subproceso superior.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores de retorno |
|
otThreadGetPartitionId
uint32_t otThreadGetPartitionId( otInstance *aInstance )
Obtén el ID de partición.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
El ID de partición.
|
otThreadGetRealmLocalAllThreadNodesMulticastAddress
const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress( otInstance *aInstance )
Obtiene la dirección multidifusión de Thread Realm-Local All Thread Nodes.
La dirección es una dirección multidifusión basada en prefijos Unicast local [RFC 3306], con lo siguiente:
- flgs establecidos en 3 (P = 1 y T = 1)
- scop configurado en 3
- plen configurado en 64
- el prefijo de red establecido en el prefijo local de malla
- ID de grupo establecido en 1
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
Un puntero para la dirección multidifusión de Thread Realm-Local All Thread Nodes.
|
otThreadGetRloc
const otIp6Address * otThreadGetRloc( otInstance *aInstance )
Obtiene la dirección del localizador de enrutamiento de subprocesos (RLOC).
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
Un puntero para la dirección del localizador de enrutamiento de subprocesos (RLOC).
|
otThreadGetRloc16
uint16_t otThreadGetRloc16( otInstance *aInstance )
Obtén el RLOC16.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
El RLOC16.
|
oThreadThreadGetServiceAloc
otError otThreadGetServiceAloc( otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc )
Esta función recupera el ALOC del servicio para un ID de servicio determinado.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores de retorno |
|
otThreadGetVersion
uint16_t otThreadGetVersion( void )
Esta función obtiene la versión de protocolo de Thread.
Detalles | |
---|---|
Qué muestra |
la versión del protocolo Thread.
|
otThreadIsAnycastLocateInProgress
bool otThreadIsAnycastLocateInProgress( otInstance *aInstance )
Esta función indica si una solicitud de ubicación Anycast está en curso.
Esta función solo está disponible cuando OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE
está habilitado.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
VERDADERO si una solicitud de ubicación Anycast está en curso; de lo contrario, se muestra FALSO.
|
otThreadIsDiscoverInProgress
bool otThreadIsDiscoverInProgress( otInstance *aInstance )
Esta función determina si actualmente hay un descubrimiento de subprocesos de MLE en curso.
Detalles | |||
---|---|---|---|
Parámetros |
|
otThreadIsSingleton
bool otThreadIsSingleton( otInstance *aInstance )
Esta función indica si un nodo es el único router de la red.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores de retorno |
|
otThreadLocateAnycastDestination
otError otThreadLocateAnycastDestination( otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext )
Esta función solicita que se ubique el destino más cercano de una dirección Anycast determinada.
Esta función solo está disponible cuando OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE
está habilitado.
Si hay una solicitud anterior en curso, se cancelará y reemplazará la solicitud anterior con una llamada posterior a esta función.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores de retorno |
|
otThreadRegisterParentResponseCallback
void otThreadRegisterParentResponseCallback( otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext )
Esta función registra una devolución de llamada para recibir datos de la respuesta principal de MLE.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
otThreadResetIp6Counters
void otThreadResetIp6Counters( otInstance *aInstance )
Restablece los contadores de IPv6.
Detalles | |||
---|---|---|---|
Parámetros |
|
otThreadResetMleCounters
void otThreadResetMleCounters( otInstance *aInstance )
Restablece los contadores de MLE de Thread.
Detalles | |||
---|---|---|---|
Parámetros |
|
otThreadSearchForBetterParent.
otError otThreadSearchForBetterParent( otInstance *aInstance )
Inicia el proceso para que el elemento secundario busque un superior y, al mismo tiempo, permanezca conectado a su elemento superior actual.
Debe usarse cuando el dispositivo esté conectado como niño.
Detalles | |||||
---|---|---|---|---|---|
Valores de retorno |
|
otThreadSendAddressNotification
void otThreadSendAddressNotification( otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid )
Esta función envía un mensaje de Notificación de dirección proactiva (ADDR_NTF.ntf).
Esta función solo está disponible cuando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
está habilitado.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
otThreadSendDiagnosticGet
otError otThreadSendDiagnosticGet( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext )
Envía una solicitud de obtención de diagnóstico de red.
Detalles | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||||||
Valores de retorno |
|
otThreadSendDiagnosticReset
otError otThreadSendDiagnosticReset( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount )
Envíe una solicitud de restablecimiento de diagnóstico de red.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores de retorno |
|
notificación de la espina dorsal otThreadSend
otError otThreadSendProactiveBackboneNotification( otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction )
Esta función envía un mensaje de notificación troncal proactiva (PRO_BB.ntf) en el vínculo de la red troncal.
Esta función solo está disponible cuando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
está habilitado.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores de retorno |
|
otThreadSetChildTimeout
void otThreadSetChildTimeout( otInstance *aInstance, uint32_t aTimeout )
Establece el tiempo de espera del elemento secundario del subproceso (en segundos) que se usa cuando se opera en la función secundaria.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otThreadGetChildTimeout
otThreadSetDiscoveryRequestCallback
void otThreadSetDiscoveryRequestCallback( otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext )
Esta función establece una devolución de llamada para recibir datos de la solicitud de descubrimiento de MLE.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
otThreadSetDomainName
otError otThreadSetDomainName( otInstance *aInstance, const char *aDomainName )
Establece el nombre de dominio del subproceso.
Solo tiene éxito cuando se inhabilitan los protocolos de Thread.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores de retorno |
|
otThreadGetDomainName
otThreadSetEnabled
otError otThreadSetEnabled( otInstance *aInstance, bool aEnabled )
Esta función inicia la operación del protocolo Thread.
La interfaz debe estar activa cuando se llama a esta función.
Si llamas a esta función con aEnabled
establecido en FALSE, se detendrá cualquier proceso de desconexión iniciado por otThreadDetachGraceful(). Se llamará a su devolución de llamada.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores de retorno |
|
otThreadSetExtendedPanId
otError otThreadSetExtendedPanId( otInstance *aInstance, const otExtendedPanId *aExtendedPanId )
Configura el ID de PAN extendido IEEE 802.15.4.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores de retorno |
|
otThreadGetExtendedPanId
otThreadSetFixedDuaInterfaceIdentifier
otError otThreadSetFixedDuaInterfaceIdentifier( otInstance *aInstance, const otIp6InterfaceIdentifier *aIid )
Establece o borra el identificador de interfaz especificado manualmente para la dirección Unicast de Thread.
Disponible cuando OPENTHREAD_CONFIG_DUA_ENABLE
está habilitado.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores de retorno |
|
otThreadGetFixedDuaInterfaceIdentifier
otThreadSetJoinerAdvertisement
otError otThreadSetJoinerAdvertisement( otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength )
Este método establece el anuncio del conector de subprocesos cuando se descubre la red de subprocesos.
Este anuncio se utiliza para permitirle a este usuario anunciar su propia información específica de la aplicación (como el ID de proveedor, el ID del producto, el Discriminante, etc.) a través de un TLV del anuncio de los recién llegados, y poner esta información a disposición de los comisionados o candidatas sin interacción humana.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores de retorno |
|
otThreadSetKeySequenceCounter
void otThreadSetKeySequenceCounter( otInstance *aInstance, uint32_t aKeySequenceCounter )
Configura thrKeySequenceCounter.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otThreadGetKeySequenceCounter
otThreadSetKeySwitchGuardTime
void otThreadSetKeySwitchGuardTime( otInstance *aInstance, uint32_t aKeySwitchGuardTime )
Configura el thrKeySwitchGuardTime (en horas).
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otThreadGetKeySwitchGuardTime
otThreadSetLinkMode
otError otThreadSetLinkMode( otInstance *aInstance, otLinkModeConfig aConfig )
Establece la configuración del modo de vínculo MLE.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores de retorno |
|
otThreadGetLinkMode
otThreadSetMeshLocalPrefix
otError otThreadSetMeshLocalPrefix( otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix )
Esta función establece el prefijo local de la malla.
Esta función tiene éxito solo cuando los protocolos de Thread están inhabilitados. Una llamada exitosa a esta función invalida los conjuntos de datos operativos activos y pendientes en la memoria no volátil.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores de retorno |
|
otThreadSetNetworkKey
otError otThreadSetNetworkKey( otInstance *aInstance, const otNetworkKey *aKey )
Configura la clave de red del subproceso.
Esta función tiene éxito solo cuando los protocolos de Thread están inhabilitados. Una llamada exitosa a esta función invalida los conjuntos de datos operativos activos y pendientes en la memoria no volátil.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores de retorno |
|
otThreadGetNetworkKey
otThreadSetNetworkKeyRef
otError otThreadSetNetworkKeyRef( otInstance *aInstance, otNetworkKeyRef aKeyRef )
Configura la clave de red del subproceso como otNetworkKeyRef
.
Esta función tiene éxito solo cuando los protocolos de Thread están inhabilitados. Una llamada exitosa a esta función invalida los conjuntos de datos operativos activos y pendientes en la memoria no volátil.
Esta función requiere que se habilite la función de tiempo de compilación OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores de retorno |
|
otThreadGetNetworkKeyRef
otThreadSetNetworkName
otError otThreadSetNetworkName( otInstance *aInstance, const char *aNetworkName )
Configura el nombre de la red Thread.
Esta función tiene éxito solo cuando los protocolos de Thread están inhabilitados. Una llamada exitosa a esta función invalida los conjuntos de datos operativos activos y pendientes en la memoria no volátil.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores de retorno |
|
otThreadGetNetworkName
Macros
TS_JOINER_ADVDATA_MAX_LENGTH
OT_JOINER_ADVDATA_MAX_LENGTH 64
Longitud máxima de los datos del anunciante para los anuncios de unión.
OT_NEIGHBOR_INFO_ITERATOR_INIT
OT_NEIGHBOR_INFO_ITERATOR_INIT 0
Inicializador de otNeighborInfoIterator
TS_NETWORK_BASE_TLV_MAX_LENGTH
OT_NETWORK_BASE_TLV_MAX_LENGTH 254
Longitud máxima del valor del TLV base de la conversación.
OT_NETWORK_DATA_ITERATOR_INIT
OT_NETWORK_DATA_ITERATOR_INIT 0
Valor para inicializar otNetworkDataIterator
.
TS_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE
OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3
Tamaño de la entrada de la tabla secundaria de diagnóstico de red.
TS_NETWORK_DIAGNOSTIC_ITERATOR_INIT
OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0
Inicializador de otNetworkDiagIterator.
TS_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES
OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19
Cantidad máxima de tipos de TLV de diagnóstico de red que se deben solicitar o restablecer.
TS_NETWORK_MAX_ROUTER_ID
OT_NETWORK_MAX_ROUTER_ID 62
ID máximo del router.
TS_SERVER_DATA_MAX_SIZE
OT_SERVER_DATA_MAX_SIZE 248
Tamaño máximo de datos del servidor en bytes. Límite teórico, prácticamente mucho menor.
TS_SERVICE_DATA_MAX_SIZE
OT_SERVICE_DATA_MAX_SIZE 252
Tamaño máximo de datos del servicio en bytes.
Recursos
Los temas de referencia de la API de OpenThread se originan a partir del código fuente, disponible en GitHub. Para obtener más información o contribuir con nuestra documentación, consulta Recursos.