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

Typedefs

otCacheEntryInfo typedef
Esta estructura representa una entrada de caché EID.
otCacheEntryIterator typedef
Este tipo representa un iterador utilizado para iterar a través de las entradas de la tabla de caché de EID.
otCacheEntryState typedef
Esta enumeración define el estado de entrada de la caché de EID.
otChildIp6AddressIterator typedef
uint16_t
Se usa para iterar a través de direcciones IPv6 de una entrada de Thread Child.
otNeighborTableCallback )(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo) typedef
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 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 la información de diagnóstico de un niño adjunto por su ID de niño o RLOC16.
otThreadGetChildInfoByIndex ( otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)
La función retiene la información de diagnóstico para un niño adjunto por el índice de tabla interno.
otThreadGetChildNextIp6Address ( otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)
Esta función obtiene la siguiente dirección IPv6 (usando un iterador) para un niño 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 de líder de subproceso que se utiliza cuando se trabaja 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 el número máximo de direcciones IP que cada niño MTD puede registrar con este dispositivo como padre.
otThreadGetMaxRouterId ( otInstance *aInstance)
uint8_t
La función devuelve el ID de enrutador máximo permitido.
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
Obtenga la prioridad de padre asignada.
otThreadGetPreferredLeaderPartitionId ( otInstance *aInstance)
uint32_t
Obtenga el Id. De partición de líder de subproceso preferido que se usa cuando se trabaja en el rol de líder.
otThreadGetPskc ( otInstance *aInstance, otPskc *aPskc)
void
Obtenga el hilo PSKc.
otThreadGetPskcRef ( otInstance *aInstance)
Obtiene la referencia clave al subproceso PSKc almacenado.
otThreadGetRouterDowngradeThreshold ( otInstance *aInstance)
uint8_t
Obtenga el parámetro ROUTER_DOWNGRADE_THRESHOLD utilizado en el rol de enrutador.
otThreadGetRouterIdSequence ( otInstance *aInstance)
uint8_t
Obtenga la secuencia de ID del enrutador actual.
otThreadGetRouterInfo ( otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)
La función conserva la información de diagnóstico de 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 apto para el 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)
Libera 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 mediante CCM.
otThreadSetContextIdReuseDelay ( otInstance *aInstance, uint32_t aDelay)
void
Establezca el parámetro CONTEXT_ID_REUSE_DELAY utilizado en el rol de líder.
otThreadSetJoinerUdpPort ( otInstance *aInstance, uint16_t aJoinerUdpPort)
Configure el puerto UDP de Joiner.
otThreadSetLocalLeaderWeight ( otInstance *aInstance, uint8_t aWeight)
void
Establezca el peso de líder de subproceso que se utiliza al operar en el rol de líder.
otThreadSetMaxAllowedChildren ( otInstance *aInstance, uint16_t aMaxChildren)
Establece la cantidad máxima de niños permitidos actualmente.
otThreadSetMaxChildIpAddresses ( otInstance *aInstance, uint8_t aMaxIpAddresses)
Esta función establece / restaura el número máximo de direcciones IP que cada niño MTD puede registrar con este dispositivo como padre.
otThreadSetNetworkIdTimeout ( otInstance *aInstance, uint8_t aTimeout)
void
Establezca 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 al operar en el rol de líder.
otThreadSetPreferredRouterId ( otInstance *aInstance, uint8_t aRouterId)
Establezca el Id. De enrutador preferido.
otThreadSetPskc ( otInstance *aInstance, const otPskc *aPskc)
Configure el Thread PSKc.
otThreadSetPskcRef ( otInstance *aInstance, otPskcRef aKeyRef)
Configure el Thread 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 el enrutador.
otThreadSetRouterSelectionJitter ( otInstance *aInstance, uint8_t aRouterJitter)
void
Establezca el parámetro ROUTER_SELECTION_JITTER utilizado en el rol REED / Router.
otThreadSetRouterUpgradeThreshold ( otInstance *aInstance, uint8_t aThreshold)
void
Establezca 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.

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 de información representan una entrada de tabla de vecinos (niño o enrutador) y se utiliza como un parámetro en la tabla de vecinos de devolución de llamada otNeighborTableCallback .

Enumeraciones

otCacheEntryState

 otCacheEntryState

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

otNeighborTableEvent

 otNeighborTableEvent

Esta enumeración define las constantes utilizadas en otNeighborTableCallback para indicar cambios en tabla de vecinos.

Propiedades
OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED

Se agrega 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 a un niño.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED

Se está agregando un enrutador.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED

Se está quitando un enrutador.

Typedefs

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 la caché de EID.

otChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

Se usa para iterar a través de direcciones IPv6 de una entrada de 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 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
Se convirtió con éxito 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 la información de diagnóstico de 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 hijo o RLOC16 del hijo adjunto.
[out] aChildInfo
Un puntero al lugar donde se coloca la información del niño.
Valores devueltos
OT_ERROR_NONE
aChildInfo se ha actualizado correctamente con la información para el ID dado.
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 la información de diagnóstico para un niño adjunto por el índice de tabla interno.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aChildIndex
El índice de la tabla.
[out] aChildInfo
Un puntero al lugar donde se coloca la información del niño.
Valores devueltos
OT_ERROR_NONE
aChildInfo se ha actualizado correctamente 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
De cualquier aChildInfo es NULL, o aChildIndex está fuera de rango (superior a índice de la tabla max).
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 niño dado.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aChildIndex
El índice secundario.
[in,out] aIterator
Un puntero al iterador. En caso de éxito, el iterador se actualizará para apuntar a la siguiente entrada de 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
Encontrado con éxito la siguiente dirección IPv6 ( aAddress se ha actualizado correctamente).
OT_ERROR_NOT_FOUND
El niño no tiene ninguna entrada de dirección IPv6 posterior.
OT_ERROR_INVALID_ARGS
aIterator o aAddress son NULL, o un niño en aChildIndex no es válida.
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 Joiner.
Ver también:
otThreadSetJoinerUdpPort

otThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

Obtenga el peso de líder de subproceso que se utiliza cuando se trabaja en el rol de líder.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El valor de Peso del líder del hilo.
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 el número máximo 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 el ID de enrutador máximo permitido.

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 al lugar donde se coloca la información de entrada de la 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, inicializar el iterador fijando todos sus campos a cero (por ejemplo, memset la estructura del iterador a cero).
Valores devueltos
OT_ERROR_NONE
Poblada con éxito aEntryInfo para la próxima entrada de caché EID.
OT_ERROR_NOT_FOUND
No más entradas en la tabla de caché de direcciones.

otThreadGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

Obtenga la prioridad de padre 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 trabaja 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 hilo recuperado PSKc.
Ver también:
otThreadSetPskc

otThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

Obtiene la referencia clave al subproceso PSKc almacenado.

Esta función requiere la función del tiempo de construcción OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE esté habilitado.

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 de ROUTER_DOWNGRADE_THRESHOLD.
Ver también:
otThreadSetRouterDowngradeThreshold

otThreadGetRouterIdSequence

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

Obtenga la secuencia de ID del enrutador actual.

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

otThreadGetRouterInfo

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

La función conserva la información de diagnóstico de 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 al lugar 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 de ROUTER_SELECTION_JITTER.
Ver también:
otThreadSetRouterSelectionJitter

otThreadGetRouterUpgradeThreshold

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

otThreadIsRouterEligible

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

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

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

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 NULL) se invocará cuando haya un cambio en la tabla de vecinos (por ejemplo, se está agregando / eliminando una entrada secundaria o vecina del enrutador 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 en invoca mientras que la tabla de vecinos / niño está siendo actualizado y siempre antes de la otStateChangedCallback .

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

otThreadReleaseRouterId

otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Libera 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
La ID del enrutador que se va a liberar. El rango válido es [0, 62].
Valores devueltos
OT_ERROR_NONE
Lanzó 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 funciona 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 mediante CCM.

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

otThreadSetContextIdReuseDelay

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

Establezca 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
)

Configure 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 Joiner.
Valores devueltos
OT_ERROR_NONE
Configure correctamente el puerto UDP de Joiner.
Ver también:
otThreadGetJoinerUdpPort

otThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

Establezca el peso de líder de subproceso que se utiliza al operar en el rol de líder.

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

otThreadSetMaxAllowedChildren

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

Establece la cantidad máxima de niños permitidos actualmente.

Este parámetro solo se puede configurar cuando se ha detenido el funcionamiento 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
Estableció con éxito el máximo.
OT_ERROR_INVALID_ARGS
Si aMaxChildren no está en el intervalo [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 el número máximo 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 la predeterminada.
Valores devueltos
OT_ERROR_NONE
Estableció / borró correctamente el número.
OT_ERROR_INVALID_ARGS
Si excede el número máximo permitido.
Ver también:
otThreadGetMaxChildIpAddresses

otThreadSetNetworkIdTimeout

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

Establezca 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
Estableció correctamente la prioridad de los padres.
OT_ERROR_INVALID_ARGS
Si el valor de la 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 al operar 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 el Id. De enrutador preferido.

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

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aRouterId
El Id. De enrutador preferido.
Valores devueltos
OT_ERROR_NONE
Establezca correctamente el Id. De enrutador preferido.
OT_ERROR_INVALID_STATE
No se pudo establecer (el rol no está separado ni deshabilitado)

otThreadSetPskc

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

Configure el Thread 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 correctamente el Thread PSKc.
OT_ERROR_INVALID_STATE
Los protocolos de subprocesos están habilitados.
Ver también:
otThreadGetPskc

otThreadSetPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

Configure el Thread PSKc.

Esta función requiere la función del tiempo de construcción OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE esté habilitado.

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] aPskcRef
Referencia clave al nuevo hilo PSKc.
Valores devueltos
OT_ERROR_NONE
Configure correctamente el Thread 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 de ROUTER_DOWNGRADE_THRESHOLD.
Ver también:
otThreadGetRouterDowngradeThreshold

otThreadSetRouterEligible

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

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

Si aEligible es falsa y el dispositivo está funcionando actualmente como un router, esta llamada será hacer que el dispositivo de separación y vuelva a colocarla, como un niño.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aEligible
TRUE para configurar el dispositivo como apto para enrutador, FALSE en caso contrario.
Valores devueltos
OT_ERROR_NONE
Establezca correctamente la configuración elegible para el enrutador.
OT_ERROR_NOT_CAPABLE
El dispositivo no puede convertirse en un enrutador.

otThreadSetRouterSelectionJitter

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

Establezca 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 de ROUTER_SELECTION_JITTER.
Ver también:
otThreadGetRouterSelectionJitter

otThreadSetRouterUpgradeThreshold

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Establezca 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:
otThreadGetRouterUpgradeThreshold

otThreadSetSteeringData

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

Establezca los datos de dirección fuera de banda.

Posibilidad de ajuste OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE debe ajustarse para permitir ajuste de los 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. Todos ceros para borrar los datos de dirección (sin datos de dirección). Todos 0xFFs para configurar los datos de dirección / filtro de floración para aceptar / permitir todos. Un EUI64 específico que luego se agrega a los datos de dirección / filtro de floración actuales.

Macros

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

Inicializador para otChildIP6AddressIterator.