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

Router o líder

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

Resumen

Enumeraciones

otCacheEntryState Enum
Esta enumeración define el estado de la entrada de caché 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
Esta enumeración define 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 la tabla de caché EID.
otCacheEntryState typedef
Esta enumeración define el estado de la entrada de caché EID.
otChildIp6AddressIterator typedef
uint16_t
Se usa para iterar a través de direcciones IPv6 de una entrada secundaria de Thread.
otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo) typedef
void(*
Se llama a este puntero de función para notificar que hay un cambio en la tabla vecina.

Funciones

otThreadBecomeLeader(otInstance *aInstance)
Conviértete en líder y comienza una nueva partición.
otThreadBecomeRouter(otInstance *aInstance)
Intenta convertirte en router.
otThreadGetChildInfoById(otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
Obtiene información de diagnóstico para un elemento secundario adjunto según 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 por el índice de tabla interna.
otThreadGetChildNextIp6Address(otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)
Esta función obtiene la siguiente dirección IPv6 (mediante un iterador) para un elemento secundario determinado.
otThreadGetContextIdReuseDelay(otInstance *aInstance)
uint32_t
Obtén el parámetro CONTEXT_ID_REUSE_DELAY que se usa en la función de líder.
otThreadGetJoinerUdpPort(otInstance *aInstance)
uint16_t
Obtenga el puerto UDP de la unión.
otThreadGetLocalLeaderWeight(otInstance *aInstance)
uint8_t
Obtiene el peso del líder de subprocesos que se usa cuando operas en el rol de líder.
otThreadGetMaxAllowedChildren(otInstance *aInstance)
uint16_t
Obtiene la cantidad máxima de elementos secundarios permitidos actualmente.
otThreadGetMaxChildIpAddresses(otInstance *aInstance)
uint8_t
Obtiene la cantidad máxima de direcciones IP que cada hijo secundario de MTD puede registrar con este dispositivo como superior.
otThreadGetMaxRouterId(otInstance *aInstance)
uint8_t
La función muestra el ID de router máximo permitido.
otThreadGetNetworkIdTimeout(otInstance *aInstance)
uint8_t
Obtén el parámetro NETWORK_ID_TIMEOUT que se usa en la función de router.
otThreadGetNextCacheEntry(otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)
Esta función obtiene la siguiente entrada de caché 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 líder del subproceso que se usa cuando operas en la función de líder.
otThreadGetPskc(otInstance *aInstance, otPskc *aPskc)
void
Obtén el PSKc de Thread.
otThreadGetPskcRef(otInstance *aInstance)
Se almacenó la referencia de clave en la conversación PSKc.
otThreadGetRouterDowngradeThreshold(otInstance *aInstance)
uint8_t
Obtén el parámetro ROUTER_DOWNGRADE_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 router que se pueden asignar a los nodos dentro de la red de subprocesos.
otThreadGetRouterIdSequence(otInstance *aInstance)
uint8_t
Obtén la secuencia de ID del router actual.
otThreadGetRouterInfo(otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)
La función retiene información de diagnóstico para un router de 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_UPGRADE_THRESHOLD que se usa en la función REED.
otThreadIsRouterEligible(otInstance *aInstance)
bool
Este método indica si el dispositivo es apto para el router o no.
otThreadRegisterNeighborTableCallback(otInstance *aInstance, otNeighborTableCallback aCallback)
void
Esta función registra una función de devolución de llamada de tabla vecina.
otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRouterId)
Liberar un ID de router que haya asignado el dispositivo en la función de líder.
otThreadSetCcmEnabled(otInstance *aInstance, bool aEnabled)
void
Esta función establece si el dispositivo se encargó mediante CCM.
otThreadSetContextIdReuseDelay(otInstance *aInstance, uint32_t aDelay)
void
Configura el parámetro CONTEXT_ID_REUSE_DELAY que se usa en la función de líder.
otThreadSetJoinerUdpPort(otInstance *aInstance, uint16_t aJoinerUdpPort)
Configure el puerto UDP de la unión.
otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)
void
Establece el peso del líder de subprocesos que se usa cuando operas en el rol de líder.
otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)
Establece la cantidad máxima de elementos secundarios permitidos actualmente.
otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses)
Establece o restablece el número máximo de direcciones IP que cada hijo secundario de MTD puede registrar con este dispositivo como superior.
otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)
void
Configura el parámetro NETWORK_ID_TIMEOUT que se usa en la función de líder.
otThreadSetParentPriority(otInstance *aInstance, int8_t aParentPriority)
Establece la prioridad superior.
otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId)
void
Establece el ID de partición líder del subproceso que se usa cuando operas en la función de líder.
otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)
Configura 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
Configura el parámetro ROUTER_DOWNGRADE_THRESHOLD que se usa en la función de líder.
otThreadSetRouterEligible(otInstance *aInstance, bool aEligible)
Esta función establece si el dispositivo es apto para el router o no.
otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)
Esta función establece el rango de ID de router que se pueden asignar a los nodos dentro de la red de subprocesos.
otThreadSetRouterSelectionJitter(otInstance *aInstance, uint8_t aRouterJitter)
void
Configura el parámetro ROUTER_SELECTION_JITTER que se usa en la función REED/Router.
otThreadSetRouterUpgradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
Configura el parámetro ROUTER_UPGRADE_THRESHOLD que se usa en la función de líder.
otThreadSetSteeringData(otInstance *aInstance, const otExtAddress *aExtAddress)
void
No es posible configurar los datos de dirección.
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 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 la tabla de caché EID.

otChildInfo

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

otNeighborTableEntryInfo (en inglés)

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

Enumeraciones

Estado de entrada de caché

 otCacheEntryState

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

evento OtNeighborTable

 otNeighborTableEvent

Esta enumeración define las constantes que se usan 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 cambió el modo de un niño existente.

OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED

Se está quitando un niño.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED

Se está agregando un router.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED

Se está quitando un router.

Typedefs

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

Esta estructura representa una entrada de caché EID.

otCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

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

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

Estado de entrada de caché

enum otCacheEntryState otCacheEntryState

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

otChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

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

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

Funciones

otThreadConvertLeader

otError otThreadBecomeLeader(
  otInstance *aInstance
)

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

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

otThread SeRouter

otError otThreadBecomeRouter(
  otInstance *aInstance
)

Intenta convertirte en router.

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

otThreadGetChildInfoById

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

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aChildId
El ID secundario o RLOC16 para el elemento secundario adjunto.
[out] aChildInfo
Un puntero a la ubicación de la información secundaria
Valores de retorno
OT_ERROR_NONE
aChildInfo se actualizó correctamente con la información del ID proporcionado.
OT_ERROR_NOT_FOUND
No hay ningún niño válido con este ID de niño.
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 por el índice de tabla interna.

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

otThreadGetChildNextIp6Dirección

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

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aChildIndex
El índice secundario.
[in,out] aIterator
Un puntero 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, el iterador se debe configurar como OT_CHILD_IP6_ADDRESS_ITERATOR_INIT.
[out] aAddress
Un puntero a una dirección IPv6 en la que se coloca la dirección siguiente del hijo (en caso de éxito).
Valores de retorno
OT_ERROR_NONE
Se encontró correctamente la siguiente dirección IPv6 (aAddress se actualizó correctamente).
OT_ERROR_NOT_FOUND
El secundario no tiene una entrada de dirección IPv6 posterior.
OT_ERROR_INVALID_ARGS
aIterator o aAddress son NULL, o el elemento secundario de aChildIndex no es válido.
Consulta también:
otThreadGetChildInfoByIndex

otThreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

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

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

otThreadGetJoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

Obtenga el puerto UDP de la unión.

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

otThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

Obtiene el peso del líder de subprocesos que se usa cuando operas en el rol de líder.

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

otThreadGetMaxAllowedChildren

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

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

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

otThreadGetMaxChildIpAddresses

uint8_t otThreadGetMaxChildIpAddresses(
  otInstance *aInstance
)

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

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

ID de otThreadGetMaxRouter

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

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

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

otThreadGetNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El valor de 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é EID (mediante un iterador).

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

otThreadGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

Obtén la prioridad superior asignada.

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

ID de otThreadGetPreferredLeader

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

Obtén el ID de partición líder del subproceso 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 del ID de partición líder del subproceso.

otThreadGetPskc

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

Obtén el PSKc de Thread.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aPskc
Un puntero para un objeto otPskc que muestra el subproceso PSKc recuperado.
Consulta también:
otThreadSetPskc

otThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

Se almacenó la referencia de clave en la conversación PSKc.

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

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

otThreadGetRouterDowngradeThreshold

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

Obtén el parámetro ROUTER_DOWNGRADE_THRESHOLD que 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_DOWNGRADE_THRESHOLD
Consulta también:
otThreadSetRouterDowngradeThreshold

otThreadGetRouterIdRange

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

Esta función obtiene el rango de ID de router que se 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
El ID de router mínimo.
[out] aMaxRouterId
El ID máximo del router.
Consulta también:
otThreadSetRouterIdRange

otThreadGetRouterIdSequence

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

Obtén la secuencia de ID del router actual.

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

otThreadGetRouterInfo

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 de router o RLOC16 de un router determinado.
[out] aRouterInfo
Un puntero sobre la ubicación de la información del router.
Valores de retorno
OT_ERROR_NONE
Se recuperó correctamente la información del router para el ID proporcionado.
OT_ERROR_NOT_FOUND
No hay ninguna entrada de router con el ID proporcionado.
OT_ERROR_INVALID_ARGS
aRouterInfo es NULO.

otThreadGetRouterSelectionJitter

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

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

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

otThreadGetRouterUpgradeThreshold

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

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

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

otThreadIsRouterApto

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores de retorno
TRUE
Si el dispositivo es 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 se produzca un cambio en la tabla vecina (p.ej., cuando se agregue o quite una entrada secundaria o vecina del router o cuando se cambie el modo 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 otStateChangedCallback.

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

ID de otThreadReleaseRouter

otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

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

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

otThreadSetCcmEnabled

void otThreadSetCcmEnabled(
  otInstance *aInstance,
  bool aEnabled
)

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

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

otThreadSetContextIdReuseDelay

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

Configura 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 la unión.

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

otThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

Establece el peso del líder de subprocesos que se usa cuando operas en el rol de líder.

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

otThreadSetMaxAllowedChildren

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

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

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

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

otThreadSetMaxChildIpAddresses

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

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

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

Disponible cuando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE está habilitado.

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

otThreadSetNetworkIdTimeout

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

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

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

otThreadSetParentPriority

otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

Establece la prioridad superior.

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

otThreadSetPreferredLeaderPartitionId

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

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

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

otThreadSetPreferredRouterId

otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Configura 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 uno que se genera aleatoriamente. Esta propiedad solo se puede configurar cuando la función del dispositivo está desconectada o inhabilitada.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aRouterId
El ID de router preferido
Valores de retorno
OT_ERROR_NONE
Se estableció correctamente el ID de router preferido.
OT_ERROR_INVALID_STATE
No se pudo establecer (la función no 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 al nuevo PSKc de Thread.
Valores de retorno
OT_ERROR_NONE
Se configuró correctamente el PSKc de subprocesos.
OT_ERROR_INVALID_STATE
Los protocolos de subprocesos están habilitados.
Consulta también:
otThreadGetPskc

otThreadSetPskcRef

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 al nuevo PSKc del subproceso.
Valores de retorno
OT_ERROR_NONE
Se configuró correctamente el PSKc de subprocesos.
OT_ERROR_INVALID_STATE
Los protocolos de subprocesos están habilitados.
Consulta también:
otThreadGetPskcRef

otThreadSetRouterDowngradeThreshold

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Configura el parámetro ROUTER_DOWNGRADE_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_DOWNGRADE_THRESHOLD
Consulta también:
otThreadGetRouterDowngradeThreshold

otThreadSetRouterApto

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

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

Si aEligible es falso y el dispositivo funciona como router, la llamada hará que el dispositivo se desconecte y se vuelva a conectar como niño.

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

otThreadSetRouterIdRange

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
El ID de router mínimo.
[in] aMaxRouterId
El ID máximo del router.
Valores de retorno
OT_ERROR_NONE
Se configuró el rango correctamente.
OT_ERROR_INVALID_ARGS
aMinRouterId > aMaxRouterId, o el rango no está cubierto por [0, 62].
Consulta también:
otThreadGetRouterIdRange

otThreadSetRouterSelectionJitter

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

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

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

otThreadSetRouterUpgradeThreshold

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Configura el parámetro ROUTER_UPGRADE_THRESHOLD que 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_UPGRADE_THRESHOLD.
Consulta también:
otThreadGetRouterUpgradeThreshold

otThreadSetSteeringData

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

No es posible configurar los datos de dirección.

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 del volante). Todos los 0xFF para establecer datos del direccionamiento o el filtro de flores para aceptar o permitir todo. Un EUI64 específico que luego se agrega al filtro de flores/datos de dirección actual.

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 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 de TLV de la política de seguridad para el enrutamiento. De lo contrario, es FALSE.

Macros

TS_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 a partir del código fuente, disponible en GitHub. Para obtener más información o contribuir con nuestra documentación, consulta Recursos.