Google se compromete a impulsar la igualdad racial para las comunidades afrodescendientes. Obtén información al respecto.

Router o líder

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

Summary

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 que se usan en otNeighborTableCallback para indicar cambios en la tabla vecina.

Typedefs
otCacheEntryInfo typedef
Esta estructura representa una entrada de caché EID.
otCacheEntryIterator typedef
Este tipo representa un iterador que se usa para iterar a través de las entradas de las tablas 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 de subproceso secundario.
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 partición nueva.
otThreadBecomeRouter(otInstance *aInstance)
Intenta convertirte en router.
otThreadGetChildInfoById(otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
La función retiene información de diagnóstico de un elemento secundario adjunto mediante su ID secundario o RLOC16.
otThreadGetChildInfoByIndex(otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)
La función retiene 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 (con un iterador) para un elemento secundario determinado.
otThreadGetContextIdReuseDelay(otInstance *aInstance)
uint32_t
Obtenga el parámetro CONTEXT_ID_REUSE_DELAY de la función de líder.
otThreadGetJoinerUdpPort(otInstance *aInstance)
uint16_t
Obtenga el puerto UDP de Joiner.
otThreadGetLocalLeaderWeight(otInstance *aInstance)
uint8_t
Obtén la ponderación del líder de Thread que se usa cuando operas en la función de líder.
otThreadGetMaxAllowedChildren(otInstance *aInstance)
uint16_t
Obtén la cantidad máxima de elementos secundarios que se permiten actualmente.
otThreadGetMaxChildIpAddresses(otInstance *aInstance)
uint8_t
Esta función obtiene la cantidad máxima de direcciones IP que cada elemento 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
Obtenga 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).
otThreadGetParentPriority(otInstance *aInstance)
int8_t
Obtén la prioridad superior asignada.
otThreadGetPreferredLeaderPartitionId(otInstance *aInstance)
uint32_t
Obtén el ID de partición de líder de Thread preferido que se usa cuando se opera en la función de líder.
otThreadGetPskc(otInstance *aInstance, otPskc *aPskc)
void
Obtén la PSKc de Thread.
otThreadGetPskcRef(otInstance *aInstance)
Obtén la referencia de la clave al subproceso PSKc almacenado.
otThreadGetRouterDowngradeThreshold(otInstance *aInstance)
uint8_t
Obtén el parámetro ROUTER_DOWNABLE_THRESHOLD que se usa en la función de router.
otThreadGetRouterIdRange(otInstance *aInstance, uint8_t *aMinRouterId, uint8_t *aMaxRouterId)
void
Esta función obtiene el rango de ID de routers que se pueden asignar a los nodos dentro de la red de subprocesos.
otThreadGetRouterIdSequence(otInstance *aInstance)
uint8_t
Obtenga la secuencia actual del ID del router.
otThreadGetRouterInfo(otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)
La función retiene información de diagnóstico para un router de subprocesos 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_UPABLE_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.
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)
Libera un ID de router que el dispositivo asignó 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
Establece el parámetro CONTEXT_ID_REUSE_DELAY que se usa en la función de líder.
otThreadSetJoinerUdpPort(otInstance *aInstance, uint16_t aJoinerUdpPort)
Configure el puerto UDP de Joiner.
otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)
void
Establece el peso del líder de subprocesos que se usa al operar en la función de líder.
otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)
Establece la cantidad máxima de elementos secundarios que se permiten actualmente.
otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses)
Esta función establece o restablece la cantidad máxima de direcciones IP que cada elemento secundario de MTD puede registrar con este dispositivo como superior.
otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)
void
Establece 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 de líder de Thread preferido que se usa cuando se opera en la función de líder.
otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)
Establezca el ID de router preferido.
otThreadSetPskc(otInstance *aInstance, const otPskc *aPskc)
Configura el subproceso PSKc.
otThreadSetPskcRef(otInstance *aInstance, otPskcRef aKeyRef)
Configura el subproceso PSKc.
otThreadSetRouterDowngradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
Establece el parámetro ROUTER_DOWNABLE_THRESHOLD de la función de líder.
otThreadSetRouterEligible(otInstance *aInstance, bool aEligible)
Esta función establece si el dispositivo es apto para el router.
otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)
Esta función establece el rango de ID de router que se pueden asignar a los nodos dentro de la red de subprocesos.
otThreadSetRouterSelectionJitter(otInstance *aInstance, uint8_t aRouterJitter)
void
Establece el parámetro ROUTER_SELECTION_JITTER que se usa en la función REED/Router.
otThreadSetRouterUpgradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
Configura el parámetro ROUTER_UPABLE_THRESHOLD que se usa en la función de líder.
otThreadSetSteeringData(otInstance *aInstance, const otExtAddress *aExtAddress)
void
Configura los datos de dirección fuera de la banda.
otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled)
void
Esta función establece si el umbral de versión del TLV de la política de seguridad para el enrutamiento (campo de RV) está habilitado.

Structs
otCacheEntryInfo.

Esta estructura representa una entrada de caché EID.

otCacheEntryIterator

Este tipo representa un iterador que se usa para iterar a través de las entradas de las tablas 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 una entrada de 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 que se usan en otNeighborTableCallback para indicar cambios en la tabla vecina.

Properties
OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED

Se está agregando un niño.

OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED

Se cambió el modo de un hijo existente.

OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED

Se está quitando a 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

Información de otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

Esta estructura representa una entrada de caché EID.

otCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

Este tipo representa un iterador que se usa para iterar a través de las entradas de las tablas 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 de subproceso secundario.

otNeighborTableCallback

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 la entrada de la tabla.

Funciones

oThreadThreadLeader

otError otThreadBecomeLeader(
  otInstance *aInstance
)

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores que se muestran
OT_ERROR_NONE
Se convirtió correctamente en líder y comenzó una partición nueva.
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 que se muestran
OT_ERROR_NONE
Empieza 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
)

La función retiene información de diagnóstico de 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 del elemento secundario adjunto.
[out] aChildInfo
Un puntero sobre dónde se coloca la información secundaria.
Valores que se muestran
OT_ERROR_NONE
Se actualizó correctamente aChildInfo con la información del ID determinado.
OT_ERROR_NOT_FOUND
No hay elementos secundarios válidos con este ID.
OT_ERROR_INVALID_ARGS
Si aChildInfo es NULO.

otThreadGetChildInfoByIndex

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

La función retiene 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 sobre dónde se coloca la información secundaria.
Valores que se muestran
OT_ERROR_NONE
Se actualizó correctamente aChildInfo con la información del índice especificado.
OT_ERROR_NOT_FOUND
No hay elementos secundarios válidos en este índice.
OT_ERROR_INVALID_ARGS
aChildInfo está cuyo valor 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 (con 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 al iterador. Si se realiza correctamente, se actualizará el iterador para que apunte a la siguiente entrada de la lista. Para obtener la primera dirección IPv6, se debe configurar el iterador en OT_CHILD_IP6_ADDRESS_ITERATOR_INIT.
[out] aAddress
Un puntero a una dirección IPv6 en la que se coloca la dirección siguiente del elemento secundario (si la operación se realiza correctamente).
Valores que se muestran
OT_ERROR_NONE
Se encontró correctamente la siguiente dirección IPv6 (aAddress se actualizó correctamente).
OT_ERROR_NOT_FOUND
El elemento secundario no tiene una entrada de dirección IPv6 posterior.
OT_ERROR_INVALID_ARGS
aIterator o aAddress son NULL o un elemento secundario de aChildIndex no es válido.
Consulta también:
otThreadGetChildInfoByIndex

OtThreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

Obtenga el parámetro CONTEXT_ID_REUSE_DELAY de 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

oThreadThreadGetJoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

Obtenga el puerto UDP de Joiner.

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

otThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

Obtén la ponderación del líder de Thread que se usa cuando operas 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 de subprocesos.
Consulta también:
otThreadSetLeaderWeight

otThreadGetMaxAllowedChildren

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

Obtén la cantidad máxima de elementos secundarios que se permiten actualmente.

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

oThreadThreadGetMaxChildIpAddresses

uint8_t otThreadGetMaxChildIpAddresses(
  otInstance *aInstance
)

Esta función obtiene la cantidad máxima de direcciones IP que cada elemento 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 conversación 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 permitido del router.

oThreadThreadGetNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

Obtenga 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 sobre dónde se coloca la información de la entrada de caché EID.
[in,out] aIterator
Un puntero para un iterador. Se actualizará para indicar la siguiente entrada exitosa. Para obtener la primera entrada, inicialice el iterador configurando todos sus campos en cero (p.ej., memset la estructura del iterador en cero).
Valores que se muestran
OT_ERROR_NONE
Se propagó correctamente aEntryInfo para la siguiente entrada de la caché de EID.
OT_ERROR_NOT_FOUND
No hay más entradas en la tabla de caché de direcciones.

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 no asignado.
Consulta también:
otThreadSetParentPriority

ID de la partición de otThreadGetPreferredLeader

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

Obtén el ID de partición de líder de Thread preferido 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
El valor de ID de partición de líder de subprocesos.

OThreadThreadGetPskc

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

Obtén la PSKc de Thread.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aPskc
Un puntero para un elemento otPskc a fin de mostrar la conversación PSKc recuperada.
Consulta también:
otThreadSetPskc

oThreadThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

Obtén la referencia de la clave al subproceso PSKc almacenado.

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 a PSKc
Consulta también:
otThreadSetPskcRef

otThreadGetRouterDowngradeThreshold

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

Obtén el parámetro ROUTER_DOWNABLE_THRESHOLD 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 ROUTER_DOWNABLE_THRESHOLD.
Consulta también:
otThreadSetRouterDowngradeThreshold

oThreadThreadGetRouterIdRange

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

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

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

oThreadThreadGetRouterIdSequence

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

Obtenga la secuencia actual del ID del router.

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

OThreadThreadGetRouterInfo

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

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aRouterId
Es el ID o RLOC16 del router de un router determinado.
[out] aRouterInfo
Un puntero sobre dónde se encuentra la información del router.
Valores que se muestran
OT_ERROR_NONE
Se recuperó correctamente la información del router para el ID específico.
OT_ERROR_NOT_FOUND
No hay ninguna entrada del router con el ID proporcionado.
OT_ERROR_INVALID_ARGS
aRouterInfo es NULO.

oThreadThreadGetRouterSelectionJitter

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_UPABLE_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_UPABLE_THRESHOLD.
Consulta también:
otThreadSetRouterUpgradeThreshold

oThreadThreadRouterApto

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

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

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

otThreadRegisterNeighborTableCallback

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

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

La devolución de llamada proporcionada (si no es NULO) se invocará cuando haya un cambio en la tabla vecina (p.ej., se agregará o quitará una entrada secundaria o de vecino del router o se modificará el modo de un elemento 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 mientras se actualiza la tabla vecina/secundaria y siempre antes de la otStateChangedCallback.

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

ID de conversación de otThreadRelease

otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Libera un ID de router que el dispositivo asignó 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 que se muestran
OT_ERROR_NONE
Se lanzó correctamente el ID del router.
OT_ERROR_INVALID_ARGS
aRouterId no está en el rango [0, 62].
OT_ERROR_INVALID_STATE
En este momento, el dispositivo no funciona como líder.
OT_ERROR_NOT_FOUND
El ID del router no está asignado.

oThreadSetCcmEnabled

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
VERDADERO si el dispositivo se encargó mediante CCM, de lo contrario, es FALSO.

OtThreadSetContextIdReuseDelay

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

Establece 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.
[in] aDelay
El valor CONTEXT_ID_REUSE_DELAY.
Consulta también:
otThreadGetContextIdReuseDelay

otThreadSetJoinerUdpPort

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

Configure el puerto UDP de Joiner.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aJoinerUdpPort
El número de puerto UDP del combinador.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente el puerto UDP del combinador.
Consulta también:
otThreadGetJoinerUdpPort

otThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

Establece el peso del líder de subprocesos que se usa al operar 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 de subprocesos.
Consulta también:
otThreadGetLeaderWeight

oThreadThreadMaxMaxChildren

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

Establece la cantidad máxima de elementos secundarios que se permiten 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 que se muestran
OT_ERROR_NONE
Se estableció correctamente el CPC máx.
OT_ERROR_INVALID_ARGS
Si aMaxChildren no está en el rango [1, OPENthread_CONFIG_MLE_MAX_CHILDREN].
OT_ERROR_INVALID_STATE
Si Thread no está detenido,
Consulta también:
otThreadGetMaxAllowedChildren

otThreadSetMaxChildIpAddresses

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

Esta función establece o restablece la cantidad máxima de direcciones IP que cada elemento secundario de MTD puede registrar con este dispositivo como superior.

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 el parámetro de configuración y restablecer el valor predeterminado.
Valores que se muestran
OT_ERROR_NONE
Se estableció o borró el número correctamente.
OT_ERROR_INVALID_ARGS
Si supera la cantidad máxima permitida
Consulta también:
otThreadGetMaxChildIpAddresses

otThreadSetNetworkIdTimeout

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

Establece 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

oThreadThreadParentPriority

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
Es el valor de la prioridad superior.
Valores que se muestran
OT_ERROR_NONE
Se estableció correctamente la prioridad del elemento 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 de líder de Thread preferido 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] aPartitionId
El valor de ID de partición de líder de subprocesos.

ID de conversación de otThreadSetPreferredRouter

otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Establezca el ID de router preferido.

Cuando se convierte en 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 un ID de router generado de forma aleatoria. Esta propiedad solo se puede establecer cuando se desconecta o inhabilita la función del dispositivo.

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

OtThreadSetPskc

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

Configura el subproceso 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 a la nueva PSKc de Thread.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente la PSKc de Thread.
OT_ERROR_INVALID_STATE
Los protocolos de Thread están habilitados.
Consulta también:
otThreadGetPskc

oThreadThreadPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

Configura el subproceso 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 para el nuevo PSKc de Thread.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente la PSKc de Thread.
OT_ERROR_INVALID_STATE
Los protocolos de Thread están habilitados.
Consulta también:
otThreadGetPskcRef

oThreadThreadRouteDownDownThreshold

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Establece el parámetro ROUTER_DOWNABLE_THRESHOLD de la función de líder.

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

otThreadSetRouterEligible

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

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

Si aEligible es falso y el dispositivo funciona como router, esta llamada hará que el dispositivo se desconecte y trate de volver a conectarse como niño.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aEligible
Se asigna el valor TRUE para configurar el dispositivo como apto para router. De lo contrario, se asigna el valor FALSE.
Valores que se muestran
OT_ERROR_NONE
Se estableció correctamente la configuración apta para el router.
OT_ERROR_NOT_CAPABLE
El dispositivo no puede convertirse en un router.

oThreadThreadRouterIdRange

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

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aMinRouterId
Es el ID mínimo del router.
[in] aMaxRouterId
Es el ID máximo del router.
Valores que se muestran
OT_ERROR_NONE
Se estableció correctamente el rango.
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
)

Establece 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.
[in] aRouterJitter
El valor ROUTER_SELECTION_JITTER.
Consulta también:
otThreadGetRouterSelectionJitter

oThreadSetRouterUpgradeThreshold

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

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

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

oThreadSetSteeringData

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

Configura los datos de dirección fuera de la banda.

Se debe establecer la opción de configuración OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE para habilitar el ajuste de dirección de los datos fuera de 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 de dirección). Todos los 0xFFs para establecer el filtro de datos del volante o de floración a fin de aceptar o permitir todo. Un EUI64 específico que luego se agrega al filtro de flora y datos del volante.

oThreadThreadThreadVersionCheckEnabled

void otThreadSetThreadVersionCheckEnabled(
  otInstance *aInstance,
  bool aEnabled
)

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

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

OT_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.