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

Enrutador/Líder

Este módulo incluye funciones para Thread Routers y Leaders.

Resumen

enumeraciones

otCacheEntryState enumeración
Esta enumeración define el estado de entrada de caché de 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
}		 enumeración
Esta enumeración define las constantes utilizadas en otNeighborTableCallback para indicar cambios en la tabla vecina.

definiciones de tipo

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

Funciones

otThreadBecomeLeader ( otInstance *aInstance)
Conviértete en un líder y comienza una nueva partición.
otThreadBecomeRouter ( otInstance *aInstance)
Intenta convertirte en un enrutador.
otThreadGetChildInfoById ( otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
La función retiene información de diagnóstico para un niño adjunto por su ID de niño o RLOC16.
otThreadGetChildInfoByIndex ( otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)
La función retiene información de diagnóstico para un niño adjunto por el índice de la tabla interna.
otThreadGetChildNextIp6Address ( otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)
Esta función obtiene la siguiente dirección IPv6 (usando un iterador) para un hijo dado.
otThreadGetContextIdReuseDelay ( otInstance *aInstance)
uint32_t
Obtenga el parámetro CONTEXT_ID_REUSE_DELAY utilizado en el rol de Líder.
otThreadGetJoinerUdpPort ( otInstance *aInstance)
uint16_t
Obtenga el puerto UDP de Joiner.
otThreadGetLocalLeaderWeight ( otInstance *aInstance)
uint8_t
Obtenga el peso del líder de hilo utilizado cuando se opera en el rol de líder.
otThreadGetMaxAllowedChildren ( otInstance *aInstance)
uint16_t
Obtenga el número máximo de niños permitido actualmente.
otThreadGetMaxChildIpAddresses ( otInstance *aInstance)
uint8_t
Esta función obtiene la cantidad máxima de direcciones IP que cada niño MTD puede registrar con este dispositivo como padre.
otThreadGetMaxRouterId ( otInstance *aInstance)
uint8_t
La función devuelve la ID de enrutador máxima permitida.
otThreadGetNetworkIdTimeout ( otInstance *aInstance)
uint8_t
Obtenga el parámetro NETWORK_ID_TIMEOUT utilizado en el rol de enrutador.
otThreadGetNextCacheEntry ( otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)
Esta función obtiene la siguiente entrada de caché EID (usando un iterador).
otThreadGetParentPriority ( otInstance *aInstance)
int8_t
Obtener la prioridad principal asignada.
otThreadGetPreferredLeaderPartitionId ( otInstance *aInstance)
uint32_t
Obtenga el Id. de partición de líder de subproceso preferido que se usa cuando se opera en el rol de líder.
otThreadGetPskc ( otInstance *aInstance, otPskc *aPskc)
void
Obtenga el hilo PSKc.
otThreadGetPskcRef ( otInstance *aInstance)
Obtenga la referencia clave del subproceso PSKc almacenado.
otThreadGetRouterDowngradeThreshold ( otInstance *aInstance)
uint8_t
Obtenga el parámetro ROUTER_DOWNGRADE_THRESHOLD utilizado en el rol de enrutador.
otThreadGetRouterIdRange ( otInstance *aInstance, uint8_t *aMinRouterId, uint8_t *aMaxRouterId)
void
Esta función obtiene el rango de ID de enrutadores que se pueden asignar a los nodos dentro de la red de subprocesos.
otThreadGetRouterIdSequence ( otInstance *aInstance)
uint8_t
Obtenga la secuencia de identificación del enrutador actual.
otThreadGetRouterInfo ( otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)
La función retiene información de diagnóstico para un enrutador de subprocesos determinado.
otThreadGetRouterSelectionJitter ( otInstance *aInstance)
uint8_t
Obtenga el parámetro ROUTER_SELECTION_JITTER utilizado en el rol REED/Router.
otThreadGetRouterUpgradeThreshold ( otInstance *aInstance)
uint8_t
Obtenga el parámetro ROUTER_UPGRADE_THRESHOLD utilizado en el rol REED.
otThreadIsRouterEligible ( otInstance *aInstance)
bool
Este método indica si el dispositivo es o no elegible para enrutador.
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)
Libere una ID de enrutador que haya sido asignada por el dispositivo en el rol de líder.
otThreadSetCcmEnabled ( otInstance *aInstance, bool aEnabled)
void
Esta función establece si el dispositivo se puso en marcha utilizando CCM.
otThreadSetContextIdReuseDelay ( otInstance *aInstance, uint32_t aDelay)
void
Configure el parámetro CONTEXT_ID_REUSE_DELAY utilizado en el rol de Líder.
otThreadSetJoinerUdpPort ( otInstance *aInstance, uint16_t aJoinerUdpPort)
Establezca el puerto UDP de Joiner.
otThreadSetLocalLeaderWeight ( otInstance *aInstance, uint8_t aWeight)
void
Establezca el peso del líder de hilo que se usa cuando se opera en el rol de líder.
otThreadSetMaxAllowedChildren ( otInstance *aInstance, uint16_t aMaxChildren)
Establezca el número máximo de niños permitido actualmente.
otThreadSetMaxChildIpAddresses ( otInstance *aInstance, uint8_t aMaxIpAddresses)
Esta función establece/restaura la cantidad máxima de direcciones IP que cada niño MTD puede registrar con este dispositivo como padre.
otThreadSetNetworkIdTimeout ( otInstance *aInstance, uint8_t aTimeout)
void
Configure el parámetro NETWORK_ID_TIMEOUT utilizado en el rol de Líder.
otThreadSetParentPriority ( otInstance *aInstance, int8_t aParentPriority)
Establezca la prioridad de los padres.
otThreadSetPreferredLeaderPartitionId ( otInstance *aInstance, uint32_t aPartitionId)
void
Establezca el Id. de partición de líder de subproceso preferido que se usa cuando se opera en el rol de líder.
otThreadSetPreferredRouterId ( otInstance *aInstance, uint8_t aRouterId)
Establezca la identificación del enrutador preferido.
otThreadSetPskc ( otInstance *aInstance, const otPskc *aPskc)
Establezca el hilo PSKc.
otThreadSetPskcRef ( otInstance *aInstance, otPskcRef aKeyRef)
Establezca el hilo PSKc.
otThreadSetRouterDowngradeThreshold ( otInstance *aInstance, uint8_t aThreshold)
void
Establezca el parámetro ROUTER_DOWNGRADE_THRESHOLD utilizado en el rol de líder.
otThreadSetRouterEligible ( otInstance *aInstance, bool aEligible)
Esta función establece si el dispositivo es apto para enrutador o no.
otThreadSetRouterIdRange ( otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)
Esta función establece el rango de ID de enrutadores que se pueden asignar a los nodos dentro de la red de subprocesos.
otThreadSetRouterSelectionJitter ( otInstance *aInstance, uint8_t aRouterJitter)
void
Configure el parámetro ROUTER_SELECTION_JITTER utilizado en el rol REED/Router.
otThreadSetRouterUpgradeThreshold ( otInstance *aInstance, uint8_t aThreshold)
void
Configure el parámetro ROUTER_UPGRADE_THRESHOLD utilizado en el rol de líder.
otThreadSetSteeringData ( otInstance *aInstance, const otExtAddress *aExtAddress)
void
Establezca los datos de dirección fuera de banda.
otThreadSetThreadVersionCheckEnabled ( otInstance *aInstance, bool aEnabled)
void
Esta función establece si el umbral de versión de TLV de la política de seguridad para el enrutamiento (campo VR) está habilitado.

estructuras

otCacheEntryInfo

Esta estructura representa una entrada de caché EID.

otCacheEntryIterator

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

otChildInfo

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

otNeighborTableEntryInfo

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

enumeraciones

otCacheEntryState

 otCacheEntryState

Esta enumeración define el estado de entrada de caché de EID.

otNeighborTableEvent

 otNeighborTableEvent

Esta enumeración define las constantes utilizadas 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

Un niño está siendo eliminado.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED

Se está agregando un enrutador.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED

Se está eliminando un enrutador.

definiciones de tipo

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

Esta estructura representa una entrada de caché EID.

otCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

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

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

otCacheEntryState

enum otCacheEntryState otCacheEntryState

Esta enumeración define el estado de entrada de caché de EID.

otChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

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

otNeighborTableCallback

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

Este puntero de función se llama para notificar que hay un cambio en la tabla vecina.

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

Funciones

otThreadBecomeLeader

otError otThreadBecomeLeader(
  otInstance *aInstance
)

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

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Valores devueltos
OT_ERROR_NONE
Con éxito se convirtió en líder y comenzó una nueva partición.
OT_ERROR_INVALID_STATE
El hilo está deshabilitado.

otThreadBecomeRouter

otError otThreadBecomeRouter(
  otInstance *aInstance
)

Intenta convertirte en un enrutador.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Valores devueltos
OT_ERROR_NONE
Comience con éxito el intento de convertirse en un enrutador.
OT_ERROR_INVALID_STATE
El hilo está deshabilitado.

otThreadGetChildInfoById

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

La función retiene información de diagnóstico para un niño adjunto por su ID de niño o RLOC16.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aChildId
El ID de niño o RLOC16 para el niño adjunto.
[out] aChildInfo
Un puntero a donde se coloca la información del niño.
Valores devueltos
OT_ERROR_NONE
aChildInfo se actualizó con éxito con la información para la identificación dada.
OT_ERROR_NOT_FOUND
Ningún niño válido con esta identificación de niño.
OT_ERROR_INVALID_ARGS
Si aChildInfo es NULL.

otThreadGetChildInfoByIndex

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

La función retiene información de diagnóstico para un niño adjunto por el índice de la tabla interna.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aChildIndex
El índice de la tabla.
[out] aChildInfo
Un puntero a donde se coloca la información del niño.
Valores devueltos
OT_ERROR_NONE
aChildInfo se actualizó con éxito con la información para el índice dado.
OT_ERROR_NOT_FOUND
Ningún niño válido en este índice.
OT_ERROR_INVALID_ARGS
O aChildInfo es NULL o aChildIndex está fuera de rango (más alto que el índice máximo de la tabla).
Ver también:
otGetMaxAllowedChildren

otThreadGetChildNextIp6Address

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

Esta función obtiene la siguiente dirección IPv6 (usando un iterador) para un hijo dado.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aChildIndex
El índice infantil.
[in,out] aIterator
Un puntero al iterador. En caso de éxito, el iterador se actualizará para apuntar a la siguiente entrada en la lista. Para obtener la primera dirección IPv6, el iterador debe establecerse en OT_CHILD_IP6_ADDRESS_ITERATOR_INIT.
[out] aAddress
Un puntero a una dirección IPv6 donde se coloca la siguiente dirección del niño (en caso de éxito).
Valores devueltos
OT_ERROR_NONE
Se encontró con éxito la siguiente dirección IPv6 ( aAddress se actualizó con éxito).
OT_ERROR_NOT_FOUND
El niño no tiene una entrada de dirección IPv6 posterior.
OT_ERROR_INVALID_ARGS
aIterator o aAddress son NULL, o child en aChildIndex no es válido.
Ver también:
otThreadGetChildInfoByIndex

otThreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

Obtenga el parámetro CONTEXT_ID_REUSE_DELAY utilizado en el rol de líder.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El valor CONTEXT_ID_REUSE_DELAY.
Ver también:
otThreadSetContextIdReuseDelay

otThreadGetJoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

Obtenga el puerto UDP de Joiner.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El número de puerto UDP de unión.
Ver también:
otThreadSetJoinerUdpPort

otThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

Obtenga el peso del líder de hilo utilizado cuando se opera en el rol de líder.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El valor de peso de líder de rosca.
Ver también:
otThreadSetLeaderWeight

otThreadGetMaxAllowedChildren

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

Obtenga el número máximo de niños permitido actualmente.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El número máximo de niños permitido actualmente.
Ver también:
otThreadSetMaxAllowedChildren

otThreadGetMaxChildIpAddresses

uint8_t otThreadGetMaxChildIpAddresses(
  otInstance *aInstance
)

Esta función obtiene la cantidad máxima de direcciones IP que cada niño MTD puede registrar con este dispositivo como padre.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El número máximo de direcciones IP que cada niño MTD puede registrar con este dispositivo como padre.
Ver también:
otThreadSetMaxChildIpAddresses

otThreadGetMaxRouterId

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

La función devuelve la ID de enrutador máxima permitida.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El ID de enrutador máximo permitido.

otThreadGetNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

Obtenga el parámetro NETWORK_ID_TIMEOUT utilizado en el rol de enrutador.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El valor NETWORK_ID_TIMEOUT.
Ver también:
otThreadSetNetworkIdTimeout

otThreadGetNextCacheEntry

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

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

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[out] aEntryInfo
Un puntero a donde se coloca la información de entrada de caché de EID.
[in,out] aIterator
Un puntero a un iterador. Se actualizará para apuntar a la siguiente entrada en caso de éxito. Para obtener la primera entrada, inicialice el iterador poniendo todos sus campos a cero (por ejemplo, memset la estructura del iterador a cero).
Valores devueltos
OT_ERROR_NONE
Se completó con éxito aEntryInfo para la siguiente entrada de caché de EID.
OT_ERROR_NOT_FOUND
No más entradas en la tabla de caché de direcciones.

otThreadGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

Obtener la prioridad principal asignada.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El valor de prioridad principal asignado, -2 significa no asignado.
Ver también:
otThreadSetParentPriority

otThreadGetPreferredLeaderPartitionId

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

Obtenga el Id. de partición de líder de subproceso preferido que se usa cuando se opera en el rol de líder.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El valor de Id. de partición de líder de subproceso.

otThreadGetPskc

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

Obtenga el hilo PSKc.

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

otThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

Obtenga la referencia clave del subproceso PSKc almacenado.

Esta función requiere que la función de tiempo de OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE esté habilitada.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
Referencia clave a PSKc
Ver también:
otThreadSetPskcRef

otThreadGetRouterDowngradeThreshold

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

Obtenga el parámetro ROUTER_DOWNGRADE_THRESHOLD utilizado en el rol de enrutador.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El valor ROUTER_DOWNGRADE_THRESHOLD.
Ver también:
otThreadSetRouterDowngradeThreshold

otThreadGetRouterIdRange

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

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

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

otThreadGetRouterIdSequence

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

Obtenga la secuencia de identificación del enrutador actual.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
La secuencia de identificación del enrutador.

otThreadGetRouterInfo

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

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

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aRouterId
El ID del enrutador o RLOC16 para un enrutador determinado.
[out] aRouterInfo
Un puntero a donde se coloca la información del enrutador.
Valores devueltos
OT_ERROR_NONE
Se recuperó con éxito la información del enrutador para la identificación dada.
OT_ERROR_NOT_FOUND
No hay entrada de enrutador con la identificación dada.
OT_ERROR_INVALID_ARGS
aRouterInfo es NULL.

otThreadGetRouterSelectionJitter

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

Obtenga el parámetro ROUTER_SELECTION_JITTER utilizado en el rol REED/Router.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El valor ROUTER_SELECTION_JITTER.
Ver también:
otThreadSetRouterSelectionJitter

otThreadGetRouterUpgradeUmbral

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

Obtenga el parámetro ROUTER_UPGRADE_THRESHOLD utilizado en el rol REED.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El valor ROUTER_UPGRADE_THRESHOLD.
Ver también:
otThreadSetRouterUpgradeThreshold

otThreadIsRouterElegible

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

Este método indica si el dispositivo es o no elegible para enrutador.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Valores devueltos
TRUE
Si el dispositivo es apto para enrutadores.
FALSE
Si el dispositivo no es elegible para enrutador.

otThreadRegisterVeighborTableCallback

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 NULL) se invocará cuando haya un cambio en la tabla de vecinos (p. ej., se agrega/elimina una entrada de vecino de enrutador o un niño o se cambia el modo de un niño existente).

Las llamadas posteriores a este método sobrescribirán la devolución de llamada anterior. Tenga en cuenta que esta devolución de llamada se invoca mientras se actualiza la tabla vecina/secundaria y siempre antes de otStateChangedCallback .

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

otThreadReleaseRouterId

otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Libere una ID de enrutador que haya sido asignada por el dispositivo en el rol de líder.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aRouterId
El ID del enrutador para liberar. El rango válido es [0, 62].
Valores devueltos
OT_ERROR_NONE
Liberado con éxito la identificación del enrutador.
OT_ERROR_INVALID_ARGS
aRouterId no está en el rango [0, 62].
OT_ERROR_INVALID_STATE
El dispositivo no está funcionando actualmente como líder.
OT_ERROR_NOT_FOUND
La identificación del enrutador no está asignada actualmente.

otThreadSetCcmEnabled

void otThreadSetCcmEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Esta función establece si el dispositivo se puso en marcha utilizando CCM.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aEnabled
VERDADERO si el dispositivo se puso en servicio con CCM, FALSO en caso contrario.

otThreadSetContextIdReuseDelay

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

Configure el parámetro CONTEXT_ID_REUSE_DELAY utilizado en el rol de Líder.

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

otThreadSetJoinerUdpPort

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

Establezca el puerto UDP de Joiner.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aJoinerUdpPort
El número de puerto UDP de unión.
Valores devueltos
OT_ERROR_NONE
Configure con éxito el puerto UDP de Joiner.
Ver también:
otThreadGetJoinerUdpPort

otThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

Establezca el peso del líder de hilo que se usa cuando se opera en el rol de líder.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aWeight
El valor de peso de líder de rosca.
Ver también:
otThreadGetLeaderWeight

otThreadSetMaxAllowedChildren

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

Establezca el número máximo de niños permitido actualmente.

Este parámetro solo se puede establecer cuando se ha detenido la operación del protocolo Thread.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aMaxChildren
El máximo permitido de niños.
Valores devueltos
OT_ERROR_NONE
Establecer con éxito el máximo.
OT_ERROR_INVALID_ARGS
Si aMaxChildren no está en el rango [1, OPENTHREAD_CONFIG_MLE_MAX_CHILDREN].
OT_ERROR_INVALID_STATE
Si Thread no se detiene.
Ver también:
otThreadGetMaxAllowedChildren

otThreadSetMaxChildIpAddresses

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

Esta función establece/restaura la cantidad máxima de direcciones IP que cada niño MTD puede registrar con este dispositivo como padre.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aMaxIpAddresses
El número máximo de direcciones IP que cada niño MTD puede registrar con este dispositivo como padre. 0 para borrar la configuración y restaurar el valor predeterminado.
Valores devueltos
OT_ERROR_NONE
Configuró/borró correctamente el número.
OT_ERROR_INVALID_ARGS
Si supera el número máximo permitido.
Ver también:
otThreadGetMaxChildIpAddresses

otThreadSetNetworkIdTimeout

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

Configure el parámetro NETWORK_ID_TIMEOUT utilizado en el rol de Líder.

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

otThreadSetParentPriority

otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

Establezca la prioridad de los padres.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aParentPriority
El valor de prioridad principal.
Valores devueltos
OT_ERROR_NONE
Establecer correctamente la prioridad de los padres.
OT_ERROR_INVALID_ARGS
Si el valor de prioridad principal no está entre 1, 0, -1 y -2.
Ver también:
otThreadGetParentPriority

otThreadSetPreferredLeaderPartitionId

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

Establezca el Id. de partición de líder de subproceso preferido que se usa cuando se opera en el rol de líder.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aPartitionId
El valor de Id. de partición de líder de subproceso.

otThreadSetPreferredRouterId

otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Establezca la identificación del enrutador preferido.

Al convertirse en un enrutador/líder, el nodo intenta usar este ID de enrutador. Si la identificación del enrutador preferido no está configurada o si no se puede usar, se elige una identificación del enrutador generada aleatoriamente. Esta propiedad solo se puede establecer cuando la función del dispositivo está desconectada o deshabilitada.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aRouterId
La identificación del enrutador preferido.
Valores devueltos
OT_ERROR_NONE
Configure con éxito la identificación del enrutador preferido.
OT_ERROR_INVALID_STATE
No se pudo establecer (el rol no está desconectado o deshabilitado)

otThreadSetPskc

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

Establezca el hilo PSKc.

Esta función solo tendrá éxito cuando los protocolos de subprocesos estén deshabilitados. 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 a una instancia de OpenThread.
[in] aPskc
Un puntero al nuevo Thread PSKc.
Valores devueltos
OT_ERROR_NONE
Configure con éxito el hilo PSKc.
OT_ERROR_INVALID_STATE
Los protocolos de subprocesos están habilitados.
Ver también:
otThreadGetPskc

otThreadSetPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

Establezca el hilo PSKc.

Esta función requiere que la función de tiempo de OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE esté habilitada.

Esta función solo tendrá éxito cuando los protocolos de subprocesos estén deshabilitados. 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 a una instancia de OpenThread.
[in] aKeyRef
Referencia clave al nuevo Thread PSKc.
Valores devueltos
OT_ERROR_NONE
Configure con éxito el hilo PSKc.
OT_ERROR_INVALID_STATE
Los protocolos de subprocesos están habilitados.
Ver también:
otThreadGetPskcRef

otThreadSetRouterDowngradeThreshold

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Establezca el parámetro ROUTER_DOWNGRADE_THRESHOLD utilizado en el rol de líder.

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

otThreadSetRouterEligible

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

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

Si aEligible es falso y el dispositivo está funcionando actualmente como un enrutador, esta llamada hará que el dispositivo se desconecte e intente volver a conectarse como un dispositivo secundario.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aEligible
VERDADERO para configurar el dispositivo como apto para enrutador, FALSO de lo contrario.
Valores devueltos
OT_ERROR_NONE
Establecer correctamente la configuración elegible para el enrutador.
OT_ERROR_NOT_CAPABLE
El dispositivo no es capaz de convertirse en un enrutador.

otThreadSetRouterIdRange

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

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

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aMinRouterId
El ID de enrutador mínimo.
[in] aMaxRouterId
El ID de enrutador máximo.
Valores devueltos
OT_ERROR_NONE
Establecer correctamente el rango.
OT_ERROR_INVALID_ARGS
aMinRouterId > aMaxRouterId, o el rango no está cubierto por [0, 62].
Ver también:
otThreadGetRouterIdRange

otThreadSetRouterSelectionJitter

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

Configure el parámetro ROUTER_SELECTION_JITTER utilizado en el rol REED/Router.

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

otThreadSetRouterUpgradeThreshold

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Configure el parámetro ROUTER_UPGRADE_THRESHOLD utilizado en el rol de líder.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aThreshold
El valor ROUTER_UPGRADE_THRESHOLD.
Ver también:
otThreadGetRouterUpgradeUmbral

otThreadSetSteeringData

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

Establezca los datos de dirección fuera de banda.

La opción de configuración OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE debe establecerse para habilitar la configuración de datos de dirección fuera de banda.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aExtAddress
Dirección utilizada para actualizar los datos de dirección. Todo ceros para borrar los datos de dirección (sin datos de dirección). Todos los 0xFF para configurar los datos de dirección/filtro de floración para aceptar/permitir todo. Un EUI64 específico que luego se agrega a los datos de dirección/filtro de floración actuales.

otThreadSetThreadVersionCheckEnabled

void otThreadSetThreadVersionCheckEnabled(
  otInstance *aInstance,
  bool aEnabled
)

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

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

macros

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

Inicializador para otChildIP6AddressIterator.

Recursos

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