Google se compromete a impulsar la igualdad racial para las comunidades afrodescendientes. Obtén información al respecto.
Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Router o líder

En este módulo, se incluyen funciones para líderes y routers Thread.

Resumen

Enumeraciones

otCacheEntryState Enum
En esta enumeración se define el estado de la entrada en la caché del EID.
otNeighborTableEvent{
  OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED,
  OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED,
  OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED,
  OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED,
  OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED
}
Enum
En esta enumeración se definen las constantes usadas en otNeighborTableCallback para indicar cambios en la tabla vecina.

Typedefs

otCacheEntryInfo typedef
Esta estructura representa una entrada de caché de EID.
otCacheEntryIterator typedef
Este tipo representa un iterador que se usa para iterar a través de las entradas de la tabla de caché EID.
otCacheEntryState typedef
En esta enumeración se define el estado de la entrada en la caché del EID.
otChildIp6AddressIterator typedef
uint16_t
Se usa para iterar a través de direcciones IPv6 de una entrada Thread Child.
otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo) typedef
void(*
Se llama a este puntero de función para notificar que hay un cambio en la tabla vecina.

Funciones

otThreadBecomeLeader(otInstance *aInstance)
Conviértete en líder y comienza una nueva partición.
otThreadBecomeRouter(otInstance *aInstance)
Intenta convertirte en router.
otThreadGetChildInfoById(otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
Obtiene información de diagnóstico para un elemento secundario adjunto mediante su ID secundario o RLOC16.
otThreadGetChildInfoByIndex(otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)
La función retiene la información de diagnóstico para un elemento secundario adjunto mediante el índice de tabla interna.
otThreadGetChildNextIp6Address(otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)
Esta función obtiene la siguiente dirección IPv6 (mediante un iterador) para un elemento secundario determinado.
otThreadGetContextIdReuseDelay(otInstance *aInstance)
uint32_t
Obtén el parámetro CONTEXT_ID_REUSE_DELAY que se usa en la función de líder.
otThreadGetJoinerUdpPort(otInstance *aInstance)
uint16_t
Obtiene el puerto UDP de unión.
otThreadGetLocalLeaderWeight(otInstance *aInstance)
uint8_t
Obtiene la ponderación de líder de subprocesos que se usa cuando se opera en la función de líder.
otThreadGetMaxAllowedChildren(otInstance *aInstance)
uint16_t
Obtiene la cantidad máxima de elementos secundarios permitidos actualmente.
otThreadGetMaxChildIpAddresses(otInstance *aInstance)
uint8_t
Obtiene la cantidad máxima de direcciones IP que cada hijo secundario de MTD puede registrar con este dispositivo como superior.
otThreadGetMaxRouterId(otInstance *aInstance)
uint8_t
La función muestra el ID de router máximo permitido.
otThreadGetNetworkIdTimeout(otInstance *aInstance)
uint8_t
Obtén el parámetro NETWORK_ID_TIMEOUT que se usa en la función de router.
otThreadGetNextCacheEntry(otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)
Esta función obtiene la siguiente entrada de caché de EID (mediante un iterador).
otThreadGetNextHopAndPathCost(otInstance *aInstance, uint16_t aDestRloc16, uint16_t *aNextHopRloc16, uint8_t *aPathCost)
void
Esta función obtiene el siguiente salto y el costo de la ruta de acceso hacia un destino determinado de RLOC16.
otThreadGetParentPriority(otInstance *aInstance)
int8_t
Obtén la prioridad superior asignada.
otThreadGetPreferredLeaderPartitionId(otInstance *aInstance)
uint32_t
Obtén el ID de partición líder del subproceso preferido que se usa cuando operas en la función Líder.
otThreadGetPskc(otInstance *aInstance, otPskc *aPskc)
void
Obtén la Thread PSKc.
otThreadGetPskcRef(otInstance *aInstance)
Obtener la referencia de la clave a la conversación PSKc almacenada
otThreadGetRouterDowngradeThreshold(otInstance *aInstance)
uint8_t
Obtén el parámetro ROUTER_DOWNGRADE_THRESHOLD que usa la función de router.
otThreadGetRouterIdRange(otInstance *aInstance, uint8_t *aMinRouterId, uint8_t *aMaxRouterId)
void
Esta función obtiene el rango de ID de router que se puede asignar a los nodos dentro de la red de subprocesos.
otThreadGetRouterIdSequence(otInstance *aInstance)
uint8_t
Obtén la secuencia de ID del router actual.
otThreadGetRouterInfo(otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)
La función retiene información de diagnóstico para un router de subproceso determinado.
otThreadGetRouterSelectionJitter(otInstance *aInstance)
uint8_t
Obtén el parámetro ROUTER_SELECTION_JITTER que se usa en la función REED/Router.
otThreadGetRouterUpgradeThreshold(otInstance *aInstance)
uint8_t
Obtén el parámetro ROUTER_UPGRADE_THRESHOLD que se usa en la función REED.
otThreadIsRouterEligible(otInstance *aInstance)
bool
Este método indica si el dispositivo es apto para el router o no.
otThreadRegisterNeighborTableCallback(otInstance *aInstance, otNeighborTableCallback aCallback)
void
Esta función registra una función de devolución de llamada de tabla vecina.
otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRouterId)
Liberar un ID de router que el dispositivo haya asignado en la función de líder.
otThreadSetCcmEnabled(otInstance *aInstance, bool aEnabled)
void
Esta función establece si el dispositivo se encargó mediante CCM.
otThreadSetContextIdReuseDelay(otInstance *aInstance, uint32_t aDelay)
void
Configura el parámetro CONTEXT_ID_REUSE_DELAY que se usa en la función Líder.
otThreadSetJoinerUdpPort(otInstance *aInstance, uint16_t aJoinerUdpPort)
Configura el puerto UDP de unión.
otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)
void
Establece el peso de líder del subproceso que se usa cuando se opera en la función de líder.
otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)
Establece la cantidad máxima de elementos secundarios permitidos actualmente.
otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses)
Establece o restablece el número máximo de direcciones IP que cada hijo secundario de MTD puede registrar con este dispositivo como superior.
otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)
void
Configura el parámetro NETWORK_ID_TIMEOUT que se usa en la función de líder.
otThreadSetParentPriority(otInstance *aInstance, int8_t aParentPriority)
Establece la prioridad superior.
otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId)
void
Establece el ID de partición líder del subproceso que se usa cuando se opera en la función líder.
otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)
Configura el ID de router preferido.
otThreadSetPskc(otInstance *aInstance, const otPskc *aPskc)
Configura la Thread PSKc.
otThreadSetPskcRef(otInstance *aInstance, otPskcRef aKeyRef)
Configura la Thread PSKc.
otThreadSetRouterDowngradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
Configura el parámetro ROUTER_DOWNGRADE_THRESHOLD que usa la función de líder.
otThreadSetRouterEligible(otInstance *aInstance, bool aEligible)
Esta función establece si el dispositivo es apto para el router o no.
otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)
Esta función establece el rango de ID de router que se puede asignar a los nodos dentro de la red de subprocesos.
otThreadSetRouterSelectionJitter(otInstance *aInstance, uint8_t aRouterJitter)
void
Configura el parámetro ROUTER_SELECTION_JITTER que se usa en la función de REED/Router.
otThreadSetRouterUpgradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
Configura el parámetro ROUTER_UPGRADE_THRESHOLD que usa la función de líder.
otThreadSetSteeringData(otInstance *aInstance, const otExtAddress *aExtAddress)
void
Establecer los datos de dirección fuera de banda
otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled)
void
Esta función establece si se debe habilitar el umbral de la versión del TLV de la política de seguridad para el enrutamiento (campo de RV).

Structs

otCacheEntryInfo.

Esta estructura representa una entrada de caché de EID.

otCacheEntryIterator.

Este tipo representa un iterador que se usa para iterar a través de las entradas de la tabla de caché EID.

otChildInfo.

Esta estructura contiene información de diagnóstico para un elemento secundario de Thread.

otNeighborTableEntryInfo (en inglés)

Este tipo representa la información de entrada de una tabla vecina (secundaria o router) y se usa como parámetro en la devolución de llamada de la tabla vecina otNeighborTableCallback.

Enumeraciones

otCacheEntryState

 otCacheEntryState

En esta enumeración se define el estado de la entrada en la caché del EID.

otNeighborTableEvent

 otNeighborTableEvent

En esta enumeración se definen las constantes usadas en otNeighborTableCallback para indicar cambios en la tabla vecina.

Propiedades
OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED

Se está agregando un niño.

OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED

Se cambia el modo de un niño existente.

OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED

Se está quitando un niño.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED

Se está agregando un router.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED

Se está quitando un router.

Typedefs

otCacheEntryInfo.

struct otCacheEntryInfo otCacheEntryInfo

Esta estructura representa una entrada de caché de EID.

otCacheEntryIterator.

struct otCacheEntryIterator otCacheEntryIterator

Este tipo representa un iterador que se usa para iterar a través de las entradas de la tabla de caché EID.

Para inicializar el iterador y comenzar desde la primera entrada en la tabla de caché, establece todos sus campos en la estructura a cero (p.ej., memset el iterador a cero).

otCacheEntryState

enum otCacheEntryState otCacheEntryState

En esta enumeración se define el estado de la entrada en la caché del EID.

otChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

Se usa para iterar a través de direcciones IPv6 de una entrada Thread Child.

Devolución de llamada otNeighborTable

void(* otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)

Se llama a este puntero de función para notificar que hay un cambio en la tabla vecina.

Detalles
Parámetros
[in] aEvent
Una marca de evento.
[in] aEntryInfo
Un puntero para la información de entrada en la tabla.

Funciones

oThreadThreadLeader

otError otThreadBecomeLeader(
  otInstance *aInstance
)

Conviértete en líder y comienza una nueva partición.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores de retorno
OT_ERROR_NONE
Se convirtió en líder de manera exitosa y comenzó una nueva partición.
OT_ERROR_INVALID_STATE
La conversación está inhabilitada.

oThreadThreadRouter

otError otThreadBecomeRouter(
  otInstance *aInstance
)

Intenta convertirte en router.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores de retorno
OT_ERROR_NONE
Comienza a intentar convertirte en un router.
OT_ERROR_INVALID_STATE
La conversación está inhabilitada.

otThreadGetChildInfoById.

otError otThreadGetChildInfoById(
  otInstance *aInstance,
  uint16_t aChildId,
  otChildInfo *aChildInfo
)

Obtiene información de diagnóstico para un elemento secundario adjunto mediante su ID secundario o RLOC16.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aChildId
El ID secundario o RLOC16 para el elemento secundario adjunto.
[out] aChildInfo
Un puntero a la ubicación de la información del elemento secundario.
Valores de retorno
OT_ERROR_NONE
aChildInfo se actualizó correctamente con la información del ID determinado.
OT_ERROR_NOT_FOUND
No hay un niño válido con este ID de hijo.
OT_ERROR_INVALID_ARGS
Si aChildInfo es NULO.

otThreadGetChildInfoByIndex

otError otThreadGetChildInfoByIndex(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildInfo *aChildInfo
)

La función retiene la información de diagnóstico para un elemento secundario adjunto mediante el índice de tabla interna.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aChildIndex
El índice de la tabla.
[out] aChildInfo
Un puntero a la ubicación de la información del elemento secundario.
Valores de retorno
OT_ERROR_NONE
aChildInfo se actualizó correctamente con la información del índice especificado.
OT_ERROR_NOT_FOUND
No hay un campo secundario válido en este índice.
OT_ERROR_INVALID_ARGS
aChildInfo es NULL o aChildIndex está fuera del rango (superior al índice máximo de la tabla).
Consulta también:
otGetMaxAllowedChildren

otThreadGetChildNextIp6Dirección

otError otThreadGetChildNextIp6Address(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildIp6AddressIterator *aIterator,
  otIp6Address *aAddress
)

Esta función obtiene la siguiente dirección IPv6 (mediante un iterador) para un elemento secundario determinado.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aChildIndex
El índice secundario.
[in,out] aIterator
Un puntero para el iterador. Si lo hace correctamente, se actualizará el iterador para que apunte a la siguiente entrada de la lista. Para obtener la primera dirección IPv6, el iterador se debe configurar como OT_CHILD_IP6_ADDRESS_ITERATOR_INIT.
[out] aAddress
Un puntero a una dirección IPv6 en la que se coloca la siguiente dirección secundaria (en caso de éxito).
Valores de retorno
OT_ERROR_NONE
Se encontró correctamente la siguiente dirección IPv6 (aAddress se actualizó correctamente).
OT_ERROR_NOT_FOUND
El campo secundario no tiene una entrada de dirección IPv6 posterior.
OT_ERROR_INVALID_ARGS
aIterator o aAddress son NULL, o el elemento secundario de aChildIndex no es válido.
Consulta también:
otThreadGetChildInfoByIndex

otThreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

Obtén el parámetro CONTEXT_ID_REUSE_DELAY que se usa en la función de líder.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El valor CONTEXT_ID_REUSE_DELAY.
Consulta también:
otThreadSetContextIdReuseDelay

otThreadGetJoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

Obtiene el puerto UDP de unión.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El número de puerto UDP de la unión.
Consulta también:
otThreadSetJoinerUdpPort

otThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

Obtiene la ponderación de líder de subprocesos que se usa cuando se opera en la función de líder.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Es el valor de ponderación del líder del subproceso.
Consulta también:
otThreadSetLeaderWeight

otThreadGetMaxAllowedChildren

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

Obtiene la cantidad máxima de elementos secundarios permitidos actualmente.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
La cantidad máxima de niños permitida actualmente.
Consulta también:
otThreadSetMaxAllowedChildren

otThreadGetMaxChildIpAddresses

uint8_t otThreadGetMaxChildIpAddresses(
  otInstance *aInstance
)

Obtiene la cantidad máxima de direcciones IP que cada hijo secundario de MTD puede registrar con este dispositivo como superior.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
La cantidad máxima de direcciones IP que cada hijo secundario de MTD puede registrar con este dispositivo como superior.
Consulta también:
otThreadSetMaxChildIpAddresses

ID de otThreadGetMaxRouter

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

La función muestra el ID de router máximo permitido.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El ID máximo del router permitido.

otThreadGetNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

Obtén el parámetro NETWORK_ID_TIMEOUT que se usa en la función de router.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El valor NETWORK_ID_TIMEOUT.
Consulta también:
otThreadSetNetworkIdTimeout

otThreadGetNextCacheEntry.

otError otThreadGetNextCacheEntry(
  otInstance *aInstance,
  otCacheEntryInfo *aEntryInfo,
  otCacheEntryIterator *aIterator
)

Esta función obtiene la siguiente entrada de caché de EID (mediante un iterador).

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aEntryInfo
Un puntero a la ubicación de la información de entrada de la caché EID
[in,out] aIterator
Un puntero para un iterador. Se actualizará para indicar la próxima entrada exitosa. Para obtener la primera entrada, inicialice el iterador configurando todos sus campos en cero (p.ej., memset la estructura del iterador a cero).
Valores de retorno
OT_ERROR_NONE
Se propagó correctamente aEntryInfo para la siguiente entrada de caché de EID
OT_ERROR_NOT_FOUND
No hay más entradas en la tabla de caché de direcciones.

otThreadGetNextHopAndPathCost

void otThreadGetNextHopAndPathCost(
  otInstance *aInstance,
  uint16_t aDestRloc16,
  uint16_t *aNextHopRloc16,
  uint8_t *aPathCost
)

Esta función obtiene el siguiente salto y el costo de la ruta de acceso hacia un destino determinado de RLOC16.

Esta función se puede usar, ya que aNextHopRloc16 o aPathCost son NULL, lo que indica que el emisor no desea obtener el valor.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDesRloct16
El RLOC16 del destino.
[out] aNextHopRloc16
Un puntero para mostrar RLOC16 del siguiente salto, 0xfffe si no hay un salto siguiente.
[out] aPathCost
Un puntero para mostrar el costo de la ruta de acceso hacia el destino.

oThreadThreadGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

Obtén la prioridad superior asignada.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El valor de prioridad superior asignado, -2 significa que no está asignado.
Consulta también:
otThreadSetParentPriority

ID de partición de otThreadGetPreferredLeader

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

Obtén el ID de partición líder del subproceso preferido que se usa cuando operas en la función Líder.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Es el valor de ID de partición líder de subprocesos.

OtThreadGetPskc

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

Obtén la Thread PSKc.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aPskc
Un puntero a una otPskc para mostrar el Thread PSKc recuperado.
Consulta también:
otThreadSetPskc

otThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

Obtener la referencia de la clave a la conversación PSKc almacenada

Esta función requiere que se habilite la función de tiempo de compilación OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Referencia clave para PSKc
Consulta también:
otThreadSetPskcRef

otThreadGetRouterDowngradeThreshold

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

Obtén el parámetro ROUTER_DOWNGRADE_THRESHOLD que usa la función de router.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El valor ROUTER_DOWNGRADE_THRESHOLD.
Consulta también:
otThreadSetRouterDowngradeThreshold

otThreadGetRouterIdRange.

void otThreadGetRouterIdRange(
  otInstance *aInstance,
  uint8_t *aMinRouterId,
  uint8_t *aMaxRouterId
)

Esta función obtiene el rango de ID de router que se puede asignar a los nodos dentro de la red de subprocesos.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aMinRouterId
El ID de router mínimo.
[out] aMaxRouterId
El ID de router máximo.
Consulta también:
otThreadSetRouterIdRange

otThreadGetRouterIdSequence

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

Obtén la secuencia de ID del router actual.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
La secuencia de ID del router

oThreadThreadGetRouterInfo

otError otThreadGetRouterInfo(
  otInstance *aInstance,
  uint16_t aRouterId,
  otRouterInfo *aRouterInfo
)

La función retiene información de diagnóstico para un router de subproceso determinado.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aRouterId
El ID de router o RLOC16 para un router determinado.
[out] aRouterInfo
Un puntero donde se ubica la información del router.
Valores de retorno
OT_ERROR_NONE
Se recuperó correctamente la información del router para el ID proporcionado.
OT_ERROR_NOT_FOUND
No hay entrada del router con el ID proporcionado.
OT_ERROR_INVALID_ARGS
aRouterInfo es NULL.

otThreadGetRouterSelectionJitter.

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

Obtén el parámetro ROUTER_SELECTION_JITTER que se usa en la función REED/Router.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El valor ROUTER_SELECTION_JITTER.
Consulta también:
otThreadSetRouterSelectionJitter

otThreadGetRouterUpgradeThreshold

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

Obtén el parámetro ROUTER_UPGRADE_THRESHOLD que se usa en la función REED.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El valor ROUTER_UPGRADE_THRESHOLD.
Consulta también:
otThreadSetRouterUpgradeThreshold

otThreadIsRouterApto

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

Este método indica si el dispositivo es apto para el router o no.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores de retorno
TRUE
Si el dispositivo es apto para el router
FALSE
Si el dispositivo no es compatible con el router

otThreadRegisterNeighborNeighborCallback

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

Esta función registra una función de devolución de llamada de tabla vecina.

Se invocará la devolución de llamada proporcionada (si no es NULL) cuando se produzca un cambio en la tabla vecina (p.ej., se está agregando o quitando una entrada vecina de router o secundario o si se cambia el modo de un campo secundario existente).

Las llamadas posteriores a este método reemplazarán la devolución de llamada anterior. Ten en cuenta que esta devolución de llamada se invoca durante la actualización de la tabla vecina/secundaria y siempre antes de la ejecución de otStateChangedCallback.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aCallback
Un puntero para la función de controlador de devolución de llamada.

ID de lanzamiento de otThreadRelease

otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Liberar un ID de router que el dispositivo haya asignado en la función de líder.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aRouterId
El ID del router que se liberará. El rango válido es [0, 62].
Valores de retorno
OT_ERROR_NONE
Se lanzó correctamente el ID de router.
OT_ERROR_INVALID_ARGS
aRouterId no está en el rango [0, 62].
OT_ERROR_INVALID_STATE
Actualmente, el dispositivo no funciona como líder.
OT_ERROR_NOT_FOUND
El ID del router no está asignado.

otThreadSetCcmEnabled

void otThreadSetCcmEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Esta función establece si el dispositivo se encargó mediante CCM.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aEnabled
TRUE si el dispositivo se encargó mediante CCM o FALSE en caso contrario.

otThreadSetContextIdReuseDelay

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

Configura el parámetro CONTEXT_ID_REUSE_DELAY que se usa en la función Líder.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDelay
El valor CONTEXT_ID_REUSE_DELAY.
Consulta también:
otThreadGetContextIdReuseDelay

otThreadSetJoinerUdpPort

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

Configura el puerto UDP de unión.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aJoinerUdpPort
El número de puerto UDP de la unión.
Valores de retorno
OT_ERROR_NONE
El puerto UDP de unión se configuró correctamente.
Consulta también:
otThreadGetJoinerUdpPort

otThreadSetLocalLeaderWeight (sitio web)

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

Establece el peso de líder del subproceso que se usa cuando se opera en la función de líder.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aWeight
Es el valor de ponderación del líder del subproceso.
Consulta también:
otThreadGetLeaderWeight

oThreadThreadSetMaxAllowedChildren

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

Establece la cantidad máxima de elementos secundarios permitidos actualmente.

Este parámetro solo se puede establecer cuando se detiene el funcionamiento del protocolo Thread.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aMaxChildren
La cantidad máxima de elementos secundarios permitidos.
Valores de retorno
OT_ERROR_NONE
Se estableció correctamente el CPC máx.
OT_ERROR_INVALID_ARGS
Si aMaxChildren no está dentro del rango [1, OPENTHREAD_CONFIG_MLE_MAX_CHILDREN].
OT_ERROR_INVALID_STATE
Si Thread no se detiene,
Consulta también:
otThreadGetMaxAllowedChildren

oThreadThreadSetMaxChildIpAddresses

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

Establece o restablece el número máximo de direcciones IP que cada hijo secundario de MTD puede registrar con este dispositivo como superior.

Pasa 0 para borrar la configuración y restablecer la configuración predeterminada.

Disponible cuando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE esté habilitado.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aMaxIpAddresses
La cantidad máxima de direcciones IP que cada hijo secundario de MTD puede registrar con este dispositivo como superior. 0 para borrar la configuración y restablecer la configuración predeterminada.
Valores de retorno
OT_ERROR_NONE
Se estableció o borró el número correctamente.
OT_ERROR_INVALID_ARGS
Si excede la cantidad máxima permitida.
Consulta también:
otThreadGetMaxChildIpAddresses

oThreadThreadSetNetworkIdTimeout

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

Configura el parámetro NETWORK_ID_TIMEOUT que se usa en la función de líder.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aTimeout
El valor NETWORK_ID_TIMEOUT.
Consulta también:
otThreadGetNetworkIdTimeout

oThreadThreadSetParentPriority

otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

Establece la prioridad superior.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aParentPriority
El valor de prioridad superior.
Valores de retorno
OT_ERROR_NONE
Se estableció correctamente la prioridad superior.
OT_ERROR_INVALID_ARGS
Si el valor de prioridad superior no está entre 1, 0, -1 y -2.
Consulta también:
otThreadGetParentPriority

ID de partición de otThreadSetPreferredLeader

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

Establece el ID de partición líder del subproceso que se usa cuando se opera en la función líder.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aPartitionId
Es el valor de ID de partición líder de subprocesos.

ID de otThreadSetPreferredRouter

otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Configura el ID de router preferido.

Después de convertirse en un router o líder, el nodo intenta usar este ID de router. Si no se establece el ID de router preferido o no se puede usar, se elige uno que se genera de manera aleatoria. Esta propiedad solo se puede configurar cuando la función del dispositivo está desconectada o inhabilitada.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aRouterId
El ID de router preferido.
Valores de retorno
OT_ERROR_NONE
Se estableció correctamente el ID de router preferido.
OT_ERROR_INVALID_STATE
No se pudo establecer (la función no se encuentra separada o inhabilitada)

otThreadSetPskc

otError otThreadSetPskc(
  otInstance *aInstance,
  const otPskc *aPskc
)

Configura la Thread PSKc.

Esta función solo tendrá éxito cuando los protocolos de Thread estén inhabilitados. Una llamada exitosa a esta función también invalidará los conjuntos de datos operativos activos y pendientes en la memoria no volátil.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aPskc
Un puntero para el nuevo Thread PSKc.
Valores de retorno
OT_ERROR_NONE
Se estableció correctamente la PSKc de Thread.
OT_ERROR_INVALID_STATE
Los protocolos de conversación están habilitados.
Consulta también:
otThreadGetPskc

OtThreadSetPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

Configura la Thread PSKc.

Esta función requiere que se habilite la función de tiempo de compilación OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

Esta función solo tendrá éxito cuando los protocolos de Thread estén inhabilitados. Una llamada exitosa a esta función también invalidará los conjuntos de datos operativos activos y pendientes en la memoria no volátil.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aKeyRef
Referencia clave del nuevo Thread PSKc.
Valores de retorno
OT_ERROR_NONE
Se estableció correctamente la PSKc de Thread.
OT_ERROR_INVALID_STATE
Los protocolos de conversación están habilitados.
Consulta también:
otThreadGetPskcRef

otThreadSetRouterDowngradeThreshold

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Configura el parámetro ROUTER_DOWNGRADE_THRESHOLD que usa la función de líder.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aThreshold
El valor ROUTER_DOWNGRADE_THRESHOLD.
Consulta también:
otThreadGetRouterDowngradeThreshold

otThreadSetRouterApto

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

Esta función establece si el dispositivo es apto para el router o no.

Si aEligible es falso y el dispositivo actualmente está funcionando como router, esta llamada hará que el dispositivo se desconecte y vuelva a intentar conectarse como niño.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aEligible
TRUE para configurar el dispositivo como router. En caso contrario, FALSE.
Valores de retorno
OT_ERROR_NONE
Se configuró correctamente la configuración apta para el router.
OT_ERROR_NOT_CAPABLE
El dispositivo no puede convertirse en router.

oThreadThreadSetRouterIdRange

otError otThreadSetRouterIdRange(
  otInstance *aInstance,
  uint8_t aMinRouterId,
  uint8_t aMaxRouterId
)

Esta función establece el rango de ID de router que se puede asignar a los nodos dentro de la red de subprocesos.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aMinRouterId
El ID de router mínimo.
[in] aMaxRouterId
El ID de router máximo.
Valores de retorno
OT_ERROR_NONE
Se configuró el rango correctamente.
OT_ERROR_INVALID_ARGS
aMinRouterId > aMaxRouterId, o el rango no está cubierto por [0, 62].
Consulta también:
otThreadGetRouterIdRange

otThreadSetRouterSelectionJitter.

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

Configura el parámetro ROUTER_SELECTION_JITTER que se usa en la función de REED/Router.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aRouterJitter
El valor ROUTER_SELECTION_JITTER.
Consulta también:
otThreadGetRouterSelectionJitter

otThreadSetRouterUpgradeThreshold

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Configura el parámetro ROUTER_UPGRADE_THRESHOLD que usa la función de líder.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aThreshold
El valor ROUTER_UPGRADE_THRESHOLD.
Consulta también:
otThreadGetRouterUpgradeThreshold

otThreadSetSteeringData.

void otThreadSetSteeringData(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

Establecer los datos de dirección fuera de banda

Se debe establecer la opción de configuración OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE para habilitar el parámetro de dirección cuando los datos salgan de la banda.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aExtAddress
Dirección utilizada para actualizar los datos del volante. Todos los ceros para borrar los datos del volante (sin datos del volante). Todos los 0xFFs para configurar los datos del volante o el filtro de Bloom para aceptar/permitir todo. Un EUI64 específico que se agrega al filtro de dirección/datos del direccionamiento actual.

oThreadThreadSetThreadVersionCheckEnabled

void otThreadSetThreadVersionCheckEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Esta función establece si se debe habilitar el umbral de la versión del TLV de la política de seguridad para el enrutamiento (campo de RV).

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aEnabled
TRUE para habilitar el umbral de versión del TLV de la política de seguridad para el enrutamiento. De lo contrario, es FALSE.

Macros

INT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

Inicializador de otChildIP6AddressIterator.

Recursos

Los temas de referencia de la API de OpenThread se originan en el código fuente, disponible en GitHub. Para obtener más información o colaborar con nuestra documentación, consulta Recursos.