Router / Líder

Este módulo incluye funciones para Routers hilo y líderes.

Resumen

enumeraciones
`otCacheEntryState`	enumeración 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_ROUTER_ADDED , OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED }`	enumeración Esta enumeración define las constantes utilizadas en `otNeighborTableCallback` para indicar si se añade o se elimina un vecino niño o router.

typedefs
`otCacheEntryInfo`	typedef `struct otCacheEntryInfo` Esta estructura representa una entrada de caché EID.
`otCacheEntryIterator`	typedef `struct otCacheEntryIterator` Este tipo representa un iterador usado para interaccionar a través de las entradas de la tabla de caché EID.
`otCacheEntryState`	typedef `enum otCacheEntryState` Esta enumeración define el estado de la entrada de caché EID.
`otChildIp6AddressIterator`	typedef `uint16_t` Se utiliza para iterar a través de las direcciones IPv6 de una entrada de hilo hijo.
`otNeighborTableCallback )(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)`	typedef `void(*` Este puntero de función se llama para notificar que un vecino niño o router se añade o se elimina de la tabla de vecinos.

funciones
`otThreadBecomeLeader ( otInstance *aInstance)`	`otError` Convertirse en un líder y empezar una nueva partición.
`otThreadBecomeRouter ( otInstance *aInstance)`	`otError` Intentará convertirse en un router.
`otThreadGetChildInfoById ( otInstance aInstance, uint16_t aChildId, otChildInfo aChildInfo)`	`otError` La función conserva la información de diagnóstico para un niño unido por su ID niño o RLOC16.
`otThreadGetChildInfoByIndex ( otInstance aInstance, uint16_t aChildIndex, otChildInfo aChildInfo)`	`otError` La función conserva la información de diagnóstico para un niño unido por el índice de la tabla interna.
`otThreadGetChildNextIp6Address ( otInstance aInstance, uint16_t aChildIndex, otChildIp6AddressIterator aIterator, otIp6Address *aAddress)`	`otError` Esta función obtiene la siguiente dirección IPv6 (usando un iterador) para un niño dado.
`otThreadGetContextIdReuseDelay ( otInstance *aInstance)`	`uint32_t` Obtener el parámetro CONTEXT_ID_REUSE_DELAY utilizado en la función de líder.
`otThreadGetJoinerUdpPort ( otInstance *aInstance)`	`uint16_t` Obtener el puerto UDP Joiner.
`otThreadGetLocalLeaderPartitionId ( otInstance *aInstance)`	`uint32_t` Obtener la partición de rosca Líder ID utilizado durante el funcionamiento en el papel líder.
`otThreadGetLocalLeaderWeight ( otInstance *aInstance)`	`uint8_t` Obtener el hilo Líder peso utilizado cuando se opera en el papel líder.
`otThreadGetMaxAllowedChildren ( otInstance *aInstance)`	`uint16_t` Obtener el número máximo de niños que actualmente permitido.
`otThreadGetMaxChildIpAddresses ( otInstance *aInstance)`	`uint8_t` Esta función obtiene el número máximo de direcciones IP que cada niño MTD puede inscribirse en este dispositivo como padre.
`otThreadGetMaxRouterId ( otInstance *aInstance)`	`uint8_t` La función devuelve el máximo permitido enrutador ID.
`otThreadGetNetworkIdTimeout ( otInstance *aInstance)`	`uint8_t` Obtener el parámetro NETWORK_ID_TIMEOUT utilizado en el papel del router.
`otThreadGetNextCacheEntry ( otInstance aInstance, otCacheEntryInfo aEntryInfo, otCacheEntryIterator *aIterator)`	`otError` Esta función obtiene la siguiente entrada de caché EID (usando un iterador).
`otThreadGetParentPriority ( otInstance *aInstance)`	`int8_t` Obtener la prioridad asignada padres.
`otThreadGetPskc ( otInstance *aInstance)`	`const otPskc *` Obtener el hilo PSKc.
`otThreadGetRouterDowngradeThreshold ( otInstance *aInstance)`	`uint8_t` Obtener el parámetro ROUTER_DOWNGRADE_THRESHOLD utilizado en el papel del router.
`otThreadGetRouterIdSequence ( otInstance *aInstance)`	`uint8_t` Obtener la corriente Secuencia ID del router.
`otThreadGetRouterInfo ( otInstance aInstance, uint16_t aRouterId, otRouterInfo aRouterInfo)`	`otError` La función conserva la información de diagnóstico para un hilo dado Router.
`otThreadGetRouterSelectionJitter ( otInstance *aInstance)`	`uint8_t` Obtener el parámetro ROUTER_SELECTION_JITTER utilizado en el papel REED / router.
`otThreadGetRouterUpgradeThreshold ( otInstance *aInstance)`	`uint8_t` Obtener el parámetro ROUTER_UPGRADE_THRESHOLD utilizado en el papel REED.
`otThreadIsRouterEligible ( otInstance *aInstance)`	`bool` Este método indica si el dispositivo está enrutador-elegible.
`otThreadRegisterNeighborTableCallback ( otInstance *aInstance, otNeighborTableCallback aCallback)`	`void` Esta función registra una función de devolución de llamada tabla de vecinos.
`otThreadReleaseRouterId ( otInstance *aInstance, uint8_t aRouterId)`	`otError` Liberar un ID de router que ha sido asignada por el dispositivo en la función de líder.
`otThreadSetContextIdReuseDelay ( otInstance *aInstance, uint32_t aDelay)`	`void` Establecer el parámetro CONTEXT_ID_REUSE_DELAY utilizado en la función de líder.
`otThreadSetJoinerUdpPort ( otInstance *aInstance, uint16_t aJoinerUdpPort)`	`otError` Ajuste el puerto UDP Joiner.
`otThreadSetLocalLeaderPartitionId ( otInstance *aInstance, uint32_t aPartitionId)`	`void` Establecer la partición de rosca Líder ID utilizado durante el funcionamiento en el papel líder.
`otThreadSetLocalLeaderWeight ( otInstance *aInstance, uint8_t aWeight)`	`void` Ajuste el hilo de Líder peso utilizado cuando se opera en el papel líder.
`otThreadSetMaxAllowedChildren ( otInstance *aInstance, uint16_t aMaxChildren)`	`otError` Establecer el número máximo de niños que actualmente permitido.
`otThreadSetMaxChildIpAddresses ( otInstance *aInstance, uint8_t aMaxIpAddresses)`	`otError` Esta función establece / restablece el número máximo de direcciones IP que cada niño MTD puede inscribirse en este dispositivo como padre.
`otThreadSetNetworkIdTimeout ( otInstance *aInstance, uint8_t aTimeout)`	`void` Establecer el parámetro NETWORK_ID_TIMEOUT utilizado en la función de líder.
`otThreadSetParentPriority ( otInstance *aInstance, int8_t aParentPriority)`	`otError` Establecer la prioridad de los padres.
`otThreadSetPreferredRouterId ( otInstance *aInstance, uint8_t aRouterId)`	`otError` Ajuste el Router Id preferido.
`otThreadSetPskc ( otInstance aInstance, const otPskc aPskc)`	`otError` Ajuste el hilo de PSKc.
`otThreadSetRouterDowngradeThreshold ( otInstance *aInstance, uint8_t aThreshold)`	`void` Establecer el parámetro ROUTER_DOWNGRADE_THRESHOLD utilizado en la función de líder.
`otThreadSetRouterEligible ( otInstance *aInstance, bool aEligible)`	`otError` Esta función establece si el dispositivo es el router-elegible.
`otThreadSetRouterSelectionJitter ( otInstance *aInstance, uint8_t aRouterJitter)`	`void` Establecer el parámetro ROUTER_SELECTION_JITTER utilizado en el papel REED / router.
`otThreadSetRouterUpgradeThreshold ( otInstance *aInstance, uint8_t aThreshold)`	`void` Establecer el parámetro ROUTER_UPGRADE_THRESHOLD utilizado en la función de líder.
`otThreadSetSteeringData ( otInstance aInstance, const otExtAddress aExtAddress)`	`void` los datos de dirección conjunto fuera de banda.

Las estructuras
otCacheEntryInfo	Esta estructura representa una entrada de caché EID.
otCacheEntryIterator	Este tipo representa un iterador usado para interaccionar a través de las entradas de la tabla de caché EID.
otChildInfo	Esta estructura contiene información de diagnóstico para un niño de rosca.
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 la entrada de caché EID.

otNeighborTableEvent

 otNeighborTableEvent

Esta enumeración define las constantes utilizadas en otNeighborTableCallback para indicar si se añade o se elimina un vecino niño o router.

propiedades
`OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED`	se añade un niño.
`OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED`	está siendo retirado un niño.
`OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED`	Se añade una router.
`OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED`	está siendo retirado de un router.

typedefs

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

Esta estructura representa una entrada de caché EID.

otCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

Este tipo representa un iterador usado para interaccionar 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é, 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 la entrada de caché EID.

otChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

Se utiliza para iterar a través de las direcciones IPv6 de una entrada de hilo hijo.

otNeighborTableCallback

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

Este puntero de función se llama para notificar que un vecino niño o router se añade o se elimina de la tabla de vecinos.

detalles

parámetros

`[in] aEvent`	Una bandera evento.
`[in] aEntryInfo`	Un puntero a información de la entrada de la tabla.

funciones

otThreadBecomeLeader

 otError otThreadBecomeLeader(
  otInstance *aInstance
)

Convertirse en un líder y empezar una nueva partición.

detalles

parámetros

[in] aInstance

Un puntero a una instancia OpenThread.

Valores devueltos

`OT_ERROR_NONE`	Con éxito se convirtió en un líder y comenzó una nueva partición.
`OT_ERROR_INVALID_STATE`	Hilo está desactivado.

otThreadBecomeRouter

 otError otThreadBecomeRouter(
  otInstance *aInstance
)

Intentará convertirse en un router.

detalles

parámetros

[in] aInstance

Un puntero a una instancia OpenThread.

Valores devueltos

`OT_ERROR_NONE`	Éxito iniciar intento de convertirse en un router.
`OT_ERROR_INVALID_STATE`	Hilo está desactivado.

otThreadGetChildInfoById

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

La función conserva la información de diagnóstico para un niño unido por su ID niño o RLOC16.

detalles

parámetros

`[in] aInstance`	Un puntero a una instancia OpenThread.
`[in] aChildId`	El ID del niño o RLOC16 para el niño adjunto.
`[out] aChildInfo`	Una indicación del 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álida con este ID del niño.
`OT_ERROR_INVALID_ARGS`	Si `aChildInfo` es NULL.

otThreadGetChildInfoByIndex

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

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

detalles

parámetros

`[in] aInstance`	Un puntero a una instancia OpenThread.
`[in] aChildIndex`	El índice de la tabla.
`[out] aChildInfo`	Una indicación del 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álida 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 OpenThread.
`[in] aChildIndex`	El índice de niños.
`[in,out] aIterator`	Un puntero al iterador. En caso de éxito el iterador se actualizará al punto de entrada siguiente en la lista. Para conseguir la primera dirección IPv6 del iterador debe establecerse en OT_CHILD_IP6_ADDRESS_ITERATOR_INIT.
`[out] aAddress`	Un puntero a una dirección IPv6 en el que se coloca al lado la 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 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
)

Obtener el parámetro CONTEXT_ID_REUSE_DELAY utilizado en la función de líder.

detalles

parámetros

[in] aInstance

Un puntero a una instancia OpenThread.

Devoluciones

El valor CONTEXT_ID_REUSE_DELAY.

Ver también:
otThreadSetContextIdReuseDelay

otThreadGetJoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

Obtener el puerto UDP Joiner.

detalles

parámetros

[in] aInstance

Un puntero a una instancia OpenThread.

Devoluciones

El número de puerto UDP Joiner.

Ver también:
otThreadSetJoinerUdpPort

otThreadGetLocalLeaderPartitionId

uint32_t otThreadGetLocalLeaderPartitionId(
  otInstance *aInstance
)

Obtener la partición de rosca Líder ID utilizado durante el funcionamiento en el papel líder.

detalles

parámetros

[in] aInstance

Un puntero a una instancia OpenThread.

Devoluciones

El valor de ID de partición Tema Líder.

otThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

Obtener el hilo Líder peso utilizado cuando se opera en el papel líder.

detalles

parámetros

[in] aInstance

Un puntero a una instancia OpenThread.

Devoluciones

El valor Líder Peso del hilo.

Ver también:
otThreadSetLeaderWeight

otThreadGetMaxAllowedChildren

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

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

detalles

parámetros

[in] aInstance

Un puntero a una instancia OpenThread.

Devoluciones

El número máximo de niños que actualmente permitido.

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 inscribirse en este dispositivo como padre.

detalles

parámetros

[in] aInstance

Un puntero a una instancia OpenThread.

Devoluciones

El número máximo de direcciones IP que cada niño MTD puede inscribirse en este dispositivo como padre.

Ver también:
otThreadSetMaxChildIpAddresses

otThreadGetMaxRouterId

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

La función devuelve el máximo permitido enrutador ID.

detalles

parámetros

[in] aInstance

Un puntero a una instancia OpenThread.

Devoluciones

El máximo permitido enrutador ID.

otThreadGetNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

Obtener el parámetro NETWORK_ID_TIMEOUT utilizado en el papel del router.

detalles

parámetros

[in] aInstance

Un puntero a una instancia 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 OpenThread.
`[out] aEntryInfo`	Un puntero a donde se coloca la información de entrada de caché EID.
`[in,out] aIterator`	Un puntero a un iterador. Será actualizado para apuntar a la siguiente entrada en el é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 hay más entradas en la tabla de caché de direcciones.

otThreadGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

Obtener la prioridad asignada padres.

detalles

parámetros

[in] aInstance

Un puntero a una instancia OpenThread.

Devoluciones

El valor de prioridad asignado padres, -2 significa no asignado.

Ver también:
otThreadSetParentPriority

otThreadGetPskc

const otPskc * otThreadGetPskc(
  otInstance *aInstance
)

Obtener el hilo PSKc.

detalles

parámetros

[in] aInstance

Un puntero a una instancia OpenThread.

Devoluciones

Un puntero para enhebrar PSKc

Ver también:
otThreadSetPskc

otThreadGetRouterDowngradeThreshold

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

Obtener el parámetro ROUTER_DOWNGRADE_THRESHOLD utilizado en el papel del router.

detalles

parámetros

[in] aInstance

Un puntero a una instancia OpenThread.

Devoluciones

El valor ROUTER_DOWNGRADE_THRESHOLD.

Ver también:
otThreadSetRouterDowngradeThreshold

otThreadGetRouterIdSequence

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

Obtener la corriente Secuencia ID del router.

detalles

parámetros

[in] aInstance

Un puntero a una instancia OpenThread.

Devoluciones

La Secuencia ID Router.

otThreadGetRouterInfo

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

La función conserva la información de diagnóstico para un hilo dado Router.

detalles

parámetros

`[in] aInstance`	Un puntero a una instancia OpenThread.
`[in] aRouterId`	El ID de router o RLOC16 para un router dado.
`[out] aRouterInfo`	Una indicación del lugar donde se coloca la información del router.

Valores devueltos

`OT_ERROR_NONE`	Recuperado con éxito la información dada por el router ID.
`OT_ERROR_NOT_FOUND`	Ninguna entrada router con el identificador dado.
`OT_ERROR_INVALID_ARGS`	`aRouterInfo` es NULL.

otThreadGetRouterSelectionJitter

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

Obtener el parámetro ROUTER_SELECTION_JITTER utilizado en el papel REED / router.

detalles

parámetros

[in] aInstance

Un puntero a una instancia OpenThread.

Devoluciones

El valor ROUTER_SELECTION_JITTER.

Ver también:
otThreadSetRouterSelectionJitter

otThreadGetRouterUpgradeThreshold

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

Obtener el parámetro ROUTER_UPGRADE_THRESHOLD utilizado en el papel REED.

detalles

parámetros

[in] aInstance

Un puntero a una instancia OpenThread.

Devoluciones

El valor ROUTER_UPGRADE_THRESHOLD.

Ver también:
otThreadSetRouterUpgradeThreshold

otThreadIsRouterEligible

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

Este método indica si el dispositivo está enrutador-elegible.

detalles

parámetros

[in] aInstance

Un puntero a una instancia OpenThread.

Valores devueltos

`TRUE`	Si el dispositivo está enrutador-elegible.
`FALSE`	Si el dispositivo no es elegible enrutador.

otThreadRegisterNeighborTableCallback

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

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

La devolución de llamada proporcionado (si no NULL) será invocado cuando se está añadiendo un niño o entrada vecino router / eliminado a / de la tabla de vecinos. las posteriores llamadas a este método se sobreponen a los de 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 OpenThread.
`[in] aCallback`	Un puntero a función de controlador de devolución de llamada.

otThreadReleaseRouterId

 otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Liberar un ID de router que ha sido asignada por el dispositivo en la función de líder.

detalles

parámetros

`[in] aInstance`	Un puntero a una instancia OpenThread.
`[in] aRouterId`	El ID Router para liberar. El rango válido es [0, 62].

Valores devueltos

`OT_ERROR_NONE`	Lanzado con éxito el ID del router.
`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 router no está asignado actualmente.

otThreadSetContextIdReuseDelay

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

Establecer el parámetro CONTEXT_ID_REUSE_DELAY utilizado en la función de líder.

detalles

parámetros

`[in] aInstance`	Un puntero a una instancia OpenThread.
`[in] aDelay`	El valor CONTEXT_ID_REUSE_DELAY.

Ver también:
otThreadGetContextIdReuseDelay

otThreadSetJoinerUdpPort

 otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

Ajuste el puerto UDP Joiner.

detalles

parámetros

`[in] aInstance`	Un puntero a una instancia OpenThread.
`[in] aJoinerUdpPort`	El número de puerto UDP Joiner.

Valores devueltos

OT_ERROR_NONE

Éxito establecer el puerto UDP Joiner.

Ver también:
otThreadGetJoinerUdpPort

otThreadSetLocalLeaderPartitionId

void otThreadSetLocalLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

Establecer la partición de rosca Líder ID utilizado durante el funcionamiento en el papel líder.

detalles

parámetros

`[in] aInstance`	Un puntero a una instancia OpenThread.
`[in] aPartitionId`	El valor de ID de partición Tema Líder.

otThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

Ajuste el hilo de Líder peso utilizado cuando se opera en el papel líder.

detalles

parámetros

`[in] aInstance`	Un puntero a una instancia OpenThread.
`[in] aWeight`	El valor Líder Peso del hilo.

Ver también:
otThreadGetLeaderWeight

otThreadSetMaxAllowedChildren

 otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

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

Este parámetro sólo se puede ajustar cuando se ha detenido el funcionamiento del protocolo de rosca.

detalles

parámetros

`[in] aInstance`	Un puntero a una instancia OpenThread.
`[in] aMaxChildren`	El máximo permiten niños.

Valores devueltos

`OT_ERROR_NONE`	establecer 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 no se detiene hilo.

Ver también:
otThreadGetMaxAllowedChildren

otThreadSetMaxChildIpAddresses

 otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

Esta función establece / restablece el número máximo de direcciones IP que cada niño MTD puede inscribirse en este dispositivo como padre.

Nota: Esta API requiere OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE , y sólo es utilizado por Tema instrumento de prueba para limitar los registros de dirección de la matriz de referencia con el fin de probar la reacción MTD DUT.

detalles

parámetros

`[in] aInstance`	Un puntero a una instancia OpenThread.
`[in] aMaxIpAddresses`	El número máximo de direcciones IP que cada niño MTD puede inscribirse en este dispositivo como padre. 0 para eliminar la configuración y restaurar el valor predeterminado.

Valores devueltos

`OT_ERROR_NONE`	Éxito set / borra 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
)

Establecer el parámetro NETWORK_ID_TIMEOUT utilizado en la función de líder.

detalles

parámetros

`[in] aInstance`	Un puntero a una instancia OpenThread.
`[in] aTimeout`	El valor NETWORK_ID_TIMEOUT.

Ver también:
otThreadGetNetworkIdTimeout

otThreadSetParentPriority

 otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

Establecer la prioridad de los padres.

detalles

parámetros

`[in] aInstance`	Un puntero a una instancia OpenThread.
`[in] aParentPriority`	El valor de prioridad de los padres.

Valores devueltos

`OT_ERROR_NONE`	configurar correctamente la prioridad de los padres.
`OT_ERROR_INVALID_ARGS`	Si el valor de prioridad de los padres no está entre 1, 0, -1 y -2.

Ver también:
otThreadGetParentPriority

otThreadSetPreferredRouterId

 otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Ajuste el Router Id preferido.

Al convertirse en un enrutador / líder de los intentos de nodo para utilizar este ID de router. Si el router Id preferido no está establecido o si no se puede utilizar, se recogió una ID de enrutador generado aleatoriamente. Esta propiedad se puede establecer sólo cuando el papel se separa dispositivo o desactivar cualquiera.

detalles

parámetros

`[in] aInstance`	Un puntero a una instancia OpenThread.
`[in] aRouterId`	El Id Router preferido.

Valores devueltos

`OT_ERROR_NONE`	Con éxito establecer el Router Id preferido.
`OT_ERROR_INVALID_STATE`	No se pudo establecer (papel no se extrae o desactivado)

otThreadSetPskc

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

Ajuste el hilo de PSKc.

Esta función sólo tendrá éxito cuando los protocolos de rosca están desactivados. Una llamada con éxito a esta función también invalidar los conjuntos de datos operacionales activos y pendientes en la memoria no volátil.

detalles

parámetros

`[in] aInstance`	Un puntero a una instancia OpenThread.
`[in] aPskc`	Un puntero a la nueva rosca PSKc.

Valores devueltos

`OT_ERROR_NONE`	establecer con éxito el hilo PSKc.
`OT_ERROR_INVALID_STATE`	protocolos de rosca están habilitadas.

Ver también:
otThreadGetPskc

otThreadSetRouterDowngradeThreshold

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Establecer el parámetro ROUTER_DOWNGRADE_THRESHOLD utilizado en la función de líder.

detalles

parámetros

`[in] aInstance`	Un puntero a una instancia 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 el router-elegible.

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 OpenThread.
`[in] aEligible`	TRUE para configurar el dispositivo como router elegible, de lo contrario.

Valores devueltos

`OT_ERROR_NONE`	establecer con éxito la configuración de router-elegible.
`OT_ERROR_NOT_CAPABLE`	El dispositivo no es capaz de convertirse en un router.

otThreadSetRouterSelectionJitter

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

Establecer el parámetro ROUTER_SELECTION_JITTER utilizado en el papel REED / router.

detalles

parámetros

`[in] aInstance`	Un puntero a una instancia OpenThread.
`[in] aRouterJitter`	El valor ROUTER_SELECTION_JITTER.

Ver también:
otThreadGetRouterSelectionJitter

otThreadSetRouterUpgradeThreshold

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Establecer el parámetro ROUTER_UPGRADE_THRESHOLD utilizado en la función de líder.

detalles

parámetros

`[in] aInstance`	Un puntero a una instancia OpenThread.
`[in] aThreshold`	El valor ROUTER_UPGRADE_THRESHOLD.

Ver también:
otThreadGetRouterUpgradeThreshold

otThreadSetSteeringData

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

los datos de dirección conjunto 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 OpenThread.
`[in] aExtAddress`	Dirección utiliza para actualizar los datos de dirección. Todos los ceros para borrar los datos de dirección (sin datos de dirección). Todos 0xFFs a los datos de dirección conjunto / filtro de floración para aceptar / permitir todo. A EUI64 específico que se añade a continuación al filtro de dirección de datos / bloom actual.

macros

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

Inicializador para otChildIP6AddressIterator.

Router / Líder

Resumen

enumeraciones

typedefs

funciones

Las estructuras

enumeraciones

otCacheEntryState

otNeighborTableEvent

typedefs

otCacheEntryInfo

otCacheEntryIterator

otCacheEntryState

otChildIp6AddressIterator

otNeighborTableCallback

funciones

otThreadBecomeLeader

otThreadBecomeRouter

otThreadGetChildInfoById

otThreadGetChildInfoByIndex

otThreadGetChildNextIp6Address

otThreadGetContextIdReuseDelay

otThreadGetJoinerUdpPort

otThreadGetLocalLeaderPartitionId

otThreadGetLocalLeaderWeight

otThreadGetMaxAllowedChildren

otThreadGetMaxChildIpAddresses

otThreadGetMaxRouterId

otThreadGetNetworkIdTimeout

otThreadGetNextCacheEntry

otThreadGetParentPriority

otThreadGetPskc

otThreadGetRouterDowngradeThreshold

otThreadGetRouterIdSequence

otThreadGetRouterInfo

otThreadGetRouterSelectionJitter

otThreadGetRouterUpgradeThreshold

otThreadIsRouterEligible

otThreadRegisterNeighborTableCallback

otThreadReleaseRouterId

otThreadSetContextIdReuseDelay

otThreadSetJoinerUdpPort

otThreadSetLocalLeaderPartitionId

otThreadSetLocalLeaderWeight

otThreadSetMaxAllowedChildren

otThreadSetMaxChildIpAddresses

otThreadSetNetworkIdTimeout

otThreadSetParentPriority

otThreadSetPreferredRouterId

otThreadSetPskc

otThreadSetRouterDowngradeThreshold

otThreadSetRouterEligible

otThreadSetRouterSelectionJitter

otThreadSetRouterUpgradeThreshold

otThreadSetSteeringData

macros

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT