O Google tem o compromisso de promover a igualdade racial para as comunidades negras. Saiba como.

IPv6

Este módulo inclui funções que controlam a comunicação do IPv6.

Resumo

Enumerações

anonymous enum{
  OT_ADDRESS_ORIGIN_THREAD = 0,
  OT_ADDRESS_ORIGIN_SLAAC = 1,
  OT_ADDRESS_ORIGIN_DHCPV6 = 2,
  OT_ADDRESS_ORIGIN_MANUAL = 3
}
tipo enumerado
Origens de endereço IPv6.
anonymous enum{
  OT_ECN_NOT_CAPABLE = 0x0,
  OT_ECN_CAPABLE_0 = 0x2,
  OT_ECN_CAPABLE_1 = 0x1,
  OT_ECN_MARKED = 0x3
}
tipo enumerado
Status ECN, representados como no cabeçalho do IP.
anonymous enum{
  OT_IP6_PROTO_HOP_OPTS = 0,
  OT_IP6_PROTO_TCP = 6,
  OT_IP6_PROTO_UDP = 17,
  OT_IP6_PROTO_IP6 = 41,
  OT_IP6_PROTO_ROUTING = 43,
  OT_IP6_PROTO_FRAGMENT = 44,
  OT_IP6_PROTO_ICMP6 = 58,
  OT_IP6_PROTO_NONE = 59,
  OT_IP6_PROTO_DST_OPTS = 60
}
tipo enumerado
Números de protocolo de Internet.

Typedefs

otIp6Address typedef
struct otIp6Address
Essa estrutura representa um endereço IPv6.
otIp6AddressCallback)(const otIp6AddressInfo *aAddressInfo, bool aIsAdded, void *aContext) typedef
void(*
Esse ponteiro de função é chamado quando um endereço IPv6 interno é adicionado ou removido.
otIp6AddressComponents typedef
Essa estrutura representa os componentes de um endereço IPv6.
otIp6AddressInfo typedef
otIp6InterfaceIdentifier typedef
Esta estrutura representa o identificador de interface de um endereço IPv6.
otIp6NetworkPrefix typedef
Essa estrutura representa o prefixo de rede de um endereço IPv6 (64 bits mais importantes do endereço).
otIp6Prefix typedef
struct otIp6Prefix
Essa estrutura representa um prefixo IPv6.
otIp6ReceiveCallback)(otMessage *aMessage, void *aContext) typedef
void(*
Esse ponteiro de função é chamado quando um datagrama IPv6 é recebido.
otIp6RegisterMulticastListenersCallback)(void *aContext, otError aError, uint8_t aMlrStatus, const otIp6Address *aFailedAddresses, uint8_t aFailedAddressNum) typedef
void(*
Esse ponteiro de função é chamado com os resultados da otIp6RegisterMulticastListeners.
otIp6SlaacPrefixFilter)(otInstance *aInstance, const otIp6Prefix *aPrefix) typedef
bool(*
Esse ponteiro de função permite que o usuário filtre prefixos e não permita que um endereço SLAAC com base em um prefixo seja adicionado.
otMessageInfo typedef
struct otMessageInfo
Essa estrutura representa os endereços de soquetes IPv6 locais e de peering.
otNetifAddress typedef
Essa estrutura representa um endereço unicast de interface de rede IPv6.
otNetifMulticastAddress typedef
Essa estrutura representa um endereço multicast de interface de rede IPv6.
otSockAddr typedef
struct otSockAddr
Essa estrutura representa um endereço de soquete IPv6.

Variables

OT_TOOL_PACKED_END

Funções

otIp6AddUnicastAddress(otInstance *aInstance, const otNetifAddress *aAddress)
Adicione um endereço de interface de rede à interface Thread.
otIp6AddUnsecurePort(otInstance *aInstance, uint16_t aPort)
Essa função adiciona uma porta à lista de portas não seguras permitidas.
otIp6AddressFromString(const char *aString, otIp6Address *aAddress)
Essa função converte uma string de endereço IPv6 legível em uma representação binária.
otIp6AddressToString(const otIp6Address *aAddress, char *aBuffer, uint16_t aSize)
void
Essa função converte um determinado endereço IPv6 em uma string legível.
otIp6ArePrefixesEqual(const otIp6Prefix *aFirst, const otIp6Prefix *aSecond)
bool
Teste se dois prefixos IPv6 são o mesmo.
otIp6GetMulticastAddresses(otInstance *aInstance)
Receba a lista de endereços multicast IPv6 inscritos na interface Thread.
otIp6GetUnicastAddresses(otInstance *aInstance)
const otNetifAddress *
Veja a lista de endereços IPv6 atribuídos à interface Thread.
otIp6GetUnsecurePorts(otInstance *aInstance, uint8_t *aNumEntries)
const uint16_t *
Essa função retorna um ponteiro para a lista de portas não seguras.
otIp6IsAddressEqual(const otIp6Address *aFirst, const otIp6Address *aSecond)
bool
Teste se dois endereços IPv6 são iguais.
otIp6IsAddressUnspecified(const otIp6Address *aAddress)
bool
Esta função indica se um determinado endereço IPv6 é ou não o endereço não especificado.
otIp6IsEnabled(otInstance *aInstance)
bool
Esta função indica se a interface IPv6 está ativa ou não.
otIp6IsMulticastPromiscuousEnabled(otInstance *aInstance)
bool
Verifique se o modo promíscuo multicast está ativado na interface Thread.
otIp6IsReceiveFilterEnabled(otInstance *aInstance)
bool
Esta função indica se o tráfego de controle da linha de execução é ou não filtrado ao enviar datagramas IPv6 por meio do callback especificado em otIp6SetReceiveCallback().
otIp6IsSlaacEnabled(otInstance *aInstance)
bool
Essa função indica se o módulo SLAAC está ativado ou não.
otIp6NewMessage(otInstance *aInstance, const otMessageSettings *aSettings)
Alocar um novo buffer de mensagem para enviar uma mensagem IPv6.
otIp6NewMessageFromBuffer(otInstance *aInstance, const uint8_t *aData, uint16_t aDataLength, const otMessageSettings *aSettings)
Alocar um novo buffer de mensagem e gravar o datagrama IPv6 no buffer de mensagem para enviar uma mensagem IPv6.
otIp6PrefixMatch(const otIp6Address *aFirst, const otIp6Address *aSecond)
uint8_t
Essa função retorna o tamanho da correspondência de prefixo (bits) para dois endereços IPv6.
otIp6PrefixToString(const otIp6Prefix *aPrefix, char *aBuffer, uint16_t aSize)
void
Essa função converte um determinado prefixo IPv6 em uma string legível.
otIp6ProtoToString(uint8_t aIpProto)
const char *
Essa função converte um determinado número de protocolo IP em uma string legível.
otIp6RegisterMulticastListeners(otInstance *aInstance, const otIp6Address *aAddresses, uint8_t aAddressNum, const uint32_t *aTimeout, otIp6RegisterMulticastListenersCallback aCallback, void *aContext)
Essa função registra listeners de multicast para o roteador de backbone principal.
otIp6RemoveAllUnsecurePorts(otInstance *aInstance)
void
Essa função remove todas as portas da lista de portas não seguras permitidas.
otIp6RemoveUnicastAddress(otInstance *aInstance, const otIp6Address *aAddress)
Remova um endereço de interface de rede da interface Thread.
otIp6RemoveUnsecurePort(otInstance *aInstance, uint16_t aPort)
Essa função remove uma porta da lista de portas não seguras permitidas.
otIp6SelectSourceAddress(otInstance *aInstance, otMessageInfo *aMessageInfo)
Essa função realiza a seleção de endereços de origem do OpenThread.
otIp6Send(otInstance *aInstance, otMessage *aMessage)
Essa função envia um datagrama IPv6 pela interface Thread.
otIp6SetAddressCallback(otInstance *aInstance, otIp6AddressCallback aCallback, void *aCallbackContext)
void
Essa função registra um callback para notificar as mudanças internas no endereço IPv6.
otIp6SetEnabled(otInstance *aInstance, bool aEnabled)
Essa função exibe a interface IPv6 para baixo/baixo.
otIp6SetMeshLocalIid(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
Essa função define o IID do mesh local (para fins de teste).
otIp6SetMulticastPromiscuousEnabled(otInstance *aInstance, bool aEnabled)
void
Ativa o modo promíscuo multicast na interface de linha de execução.
otIp6SetReceiveCallback(otInstance *aInstance, otIp6ReceiveCallback aCallback, void *aCallbackContext)
void
Essa função registra um callback para fornecer datagramas IPv6 recebidos.
otIp6SetReceiveFilterEnabled(otInstance *aInstance, bool aEnabled)
void
Esta função define se o tráfego de controle da linha de execução é ou não filtrado ao enviar datagramas IPv6 por meio do callback especificado em otIp6SetReceiveCallback().
otIp6SetSlaacEnabled(otInstance *aInstance, bool aEnabled)
void
Essa função ativa/desativa o módulo SLAAC.
otIp6SetSlaacPrefixFilter(otInstance *aInstance, otIp6SlaacPrefixFilter aFilter)
void
Essa função define o gerenciador de filtros do módulo SLAAC.
otIp6SockAddrToString(const otSockAddr *aSockAddr, char *aBuffer, uint16_t aSize)
void
Essa função converte um determinado endereço de soquete IPv6 em uma string legível.
otIp6SubscribeMulticastAddress(otInstance *aInstance, const otIp6Address *aAddress)
Inscrever a interface Thread em um endereço multicast de interface de rede.
otIp6UnsubscribeMulticastAddress(otInstance *aInstance, const otIp6Address *aAddress)
Cancele a inscrição da interface Thread para um endereço de multicast da interface de rede.

Estruturas

OtIp6Address (link em inglês)

Essa estrutura representa um endereço IPv6.

otIp6AddressComponents

Essa estrutura representa os componentes de um endereço IPv6.

otIp6AddressInfo (em inglês)

Essa estrutura representa as informações de endereço IPv6.

otIp6InterfaceIdentifier (link em inglês)

Esta estrutura representa o identificador de interface de um endereço IPv6.

otIp6NetworkPrefix (em inglês)

Essa estrutura representa o prefixo de rede de um endereço IPv6 (64 bits mais importantes do endereço).

otIp6Prefix (em inglês)

Essa estrutura representa um prefixo IPv6.

otMessageInfo (em inglês)

Essa estrutura representa os endereços de soquetes IPv6 locais e de peering.

OtNetifAddress

Essa estrutura representa um endereço unicast de interface de rede IPv6.

otNetifMulticastAddress (link em inglês)

Essa estrutura representa um endereço multicast de interface de rede IPv6.

otSockAddr (em inglês)

Essa estrutura representa um endereço de soquete IPv6.

Sindicatos

otIp6InterfaceIdentifier::OT_TOOL_PACKED_FIELD

Enumerações

enumeração anônima

 anonymous enum

Origens de endereço IPv6.

Propriedades
OT_ADDRESS_ORIGIN_DHCPV6

Endereço atribuído DHCPv6.

OT_ADDRESS_ORIGIN_MANUAL

Endereço atribuído manualmente.

OT_ADDRESS_ORIGIN_SLAAC

Endereço atribuído do SLAAC.

OT_ADDRESS_ORIGIN_THREAD

Endereço atribuído da conversa (ALOC, RLOC, MLEID etc.)

enumeração anônima

 anonymous enum

Status ECN, representados como no cabeçalho do IP.

Propriedades
OT_ECN_CAPABLE_0

ECT(0)

OT_ECN_CAPABLE_1

ECT(1)

OT_ECN_MARKED

Congestionamento encontrado (CE)

OT_ECN_NOT_CAPABLE

Não ECT

enumeração anônima

 anonymous enum

Números de protocolo de Internet.

Propriedades
OT_IP6_PROTO_DST_OPTS

Opções de destino para IPv6.

OT_IP6_PROTO_FRAGMENT

Cabeçalho do fragmento para IPv6.

OT_IP6_PROTO_HOP_OPTS

Opção IPv6 de salto por salto.

OT_IP6_PROTO_ICMP6

ICMP para IPv6.

OT_IP6_PROTO_IP6

Encapsulamento de IPv6.

OT_IP6_PROTO_NONE

Nenhum cabeçalho a seguir para IPv6.

OT_IP6_PROTO_ROUTING

Cabeçalho de roteamento para IPv6.

OT_IP6_PROTO_TCP

Protocolo de controle de transmissão.

OT_IP6_PROTO_UDP

Datagrama do usuário

Typedefs

OtIp6Address

struct otIp6Address otIp6Address

Essa estrutura representa um endereço IPv6.

OtIp6AddressCallback

void(* otIp6AddressCallback)(const otIp6AddressInfo *aAddressInfo, bool aIsAdded, void *aContext)

Esse ponteiro de função é chamado quando um endereço IPv6 interno é adicionado ou removido.

Detalhes
Parâmetros
[in] aAddressInfo
Um ponteiro para informações de endereço IPv6.
[in] aIsAdded
Verdadeiro se o aAddress foi adicionado, FALSO se aAddress foi removido.
[in] aContext
Um ponteiro para contexto específico do aplicativo.

OtIp6AddressComponents

struct otIp6AddressComponents otIp6AddressComponents

Essa estrutura representa os componentes de um endereço IPv6.

OtIp6AddressInfo

struct otIp6AddressInfo otIp6AddressInfo

OtIp6InterfaceIdentifier

struct otIp6InterfaceIdentifier otIp6InterfaceIdentifier

Esta estrutura representa o identificador de interface de um endereço IPv6.

otIp6NetworkPrefix

struct otIp6NetworkPrefix otIp6NetworkPrefix

Essa estrutura representa o prefixo de rede de um endereço IPv6 (64 bits mais importantes do endereço).

otIp6Prefix

struct otIp6Prefix otIp6Prefix

Essa estrutura representa um prefixo IPv6.

OtIp6ReceiveCallback

void(* otIp6ReceiveCallback)(otMessage *aMessage, void *aContext)

Esse ponteiro de função é chamado quando um datagrama IPv6 é recebido.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para o buffer de mensagem que contém o datagrama IPv6 recebido. Essa função transfere a propriedade de aMessage para o receptor do callback. A mensagem deve ser liberada pelo destinatário do callback depois que for processada (consulte otMessageFree()).
[in] aContext
Um ponteiro para contexto específico do aplicativo.

otIp6RegisterMulticastListenersCallback

void(* otIp6RegisterMulticastListenersCallback)(void *aContext, otError aError, uint8_t aMlrStatus, const otIp6Address *aFailedAddresses, uint8_t aFailedAddressNum)

Esse ponteiro de função é chamado com os resultados da otIp6RegisterMulticastListeners.

Detalhes
Parâmetros
[in] aContext
Um ponteiro para o contexto do usuário.
[in] aError
OT_ERROR_NONE ao enviar MLR.req e receber MLR.rsp, OT_ERROR_RESPONSE_REFUND quando não é possível receber MLR.rsp, OT_ERROR_PARSE em caso de falha ao analisar MLR.rsp.
[in] aMlrStatus
Status do registro de listener do multicast quando aError é OT_ERROR_NONE.
[in] aFailedAddresses
Um ponteiro para os endereços IPv6 com falha quando aError é OT_ERROR_NONE.
[in] aFailedAddressNum
O número de endereços IPv6 com falha quando aError é OT_ERROR_NONE.
Veja também:
otIp6RegisterMulticastListeners

otIp6SlaacPrefixFilter

bool(* otIp6SlaacPrefixFilter)(otInstance *aInstance, const otIp6Prefix *aPrefix)

Esse ponteiro de função permite que o usuário filtre prefixos e não permita que um endereço SLAAC com base em um prefixo seja adicionado.

otIp6SetSlaacPrefixFilter() pode ser usado para definir o gerenciador de filtros. O gerenciador de filtros é invocado pelo módulo SLAAC quando está prestes a adicionar um endereço SLAAC com base em um prefixo. O valor de retorno booleano determina se o endereço é filtrado (não adicionado) ou não.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aPrefix
Um ponteiro para o prefixo sobre o qual o endereço SLAAC está prestes a ser adicionado.
Valores de retorno
TRUE
Indica que o endereço SLAAC com base no prefixo deve ser filtrado e NÃO adicionado.
FALSE
Indica que o endereço SLAAC com base no prefixo deve ser adicionado.

OtMessageInfo

struct otMessageInfo otMessageInfo

Essa estrutura representa os endereços de soquetes IPv6 locais e de peering.

OtNetifAddress

struct otNetifAddress otNetifAddress

Essa estrutura representa um endereço unicast de interface de rede IPv6.

OtNetifMulticastAddress

struct otNetifMulticastAddress otNetifMulticastAddress

Essa estrutura representa um endereço multicast de interface de rede IPv6.

OtSockAddr

struct otSockAddr otSockAddr

Essa estrutura representa um endereço de soquete IPv6.

Variables

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otIp6InterfaceIdentifier OT_TOOL_PACKED_END

Funções

OtIp6AdicionarUnicastAddress

otError otIp6AddUnicastAddress(
  otInstance *aInstance,
  const otNetifAddress *aAddress
)

Adicione um endereço de interface de rede à interface Thread.

A instância transmitida aAddress é copiada pela interface Thread. A interface Thread aceita apenas um número fixo de endereços unicast adicionados externamente. Consulte OPENTHREAD_CONFIG_IP6_MAX_EXT_UCAST_ADDRS.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aAddress
Um ponteiro para um endereço de interface de rede.
Valores de retorno
OT_ERROR_NONE
O endereço da interface de rede foi adicionado ou atualizado.
OT_ERROR_INVALID_ARGS
O endereço IP indicado por aAddress é um endereço interno.
OT_ERROR_NO_BUFS
A interface de rede já está armazenando o máximo permitido de endereços externos.

OtIp6AddUnsecurePort

otError otIp6AddUnsecurePort(
  otInstance *aInstance,
  uint16_t aPort
)

Essa função adiciona uma porta à lista de portas não seguras permitidas.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aPort
O valor da porta.
Valores de retorno
OT_ERROR_NONE
A porta foi adicionada à lista de portas não seguras permitidas.
OT_ERROR_INVALID_ARGS
A porta é inválida (o valor 0 está reservado para uso interno).
OT_ERROR_NO_BUFS
A lista de portas não seguras está cheia.

OtIp6AddressFromString

otError otIp6AddressFromString(
  const char *aString,
  otIp6Address *aAddress
)

Essa função converte uma string de endereço IPv6 legível em uma representação binária.

Detalhes
Parâmetros
[in] aString
Um ponteiro para uma string terminada em NULL.
[out] aAddress
Um ponteiro para um endereço IPv6.
Valores de retorno
OT_ERROR_NONE
A string foi analisada com sucesso.
OT_ERROR_INVALID_ARGS
Falha ao analisar a string.

OtIp6AddressToString

void otIp6AddressToString(
  const otIp6Address *aAddress,
  char *aBuffer,
  uint16_t aSize
)

Essa função converte um determinado endereço IPv6 em uma string legível.

A string de endereço IPv6 é formatada como 16 valores hexadecimais separados por ':' (por exemplo, "%x:%x:%x:...:%x").

Se a string resultante não couber no aBuffer (dentro de caracteres aSize), ela será truncada, mas a string resultante sempre será nula.

Detalhes
Parâmetros
[in] aAddress
Um ponteiro para um endereço IPv6 (NÃO pode ser NULL).
[out] aBuffer
Um ponteiro para uma matriz de caracteres para gerar a string (NÃO DEVE ser NULL).
[in] aSize
O tamanho de aBuffer (em bytes). É recomendável usar OT_IP6_ADDRESS_STRING_SIZE.

otIp6ArePrefixesEqual

bool otIp6ArePrefixesEqual(
  const otIp6Prefix *aFirst,
  const otIp6Prefix *aSecond
)

Teste se dois prefixos IPv6 são o mesmo.

Detalhes
Parâmetros
[in] aFirst
Um ponteiro para o primeiro prefixo IPv6 a ser comparado.
[in] aSecond
Um ponteiro para o segundo prefixo IPv6 a ser comparado.
Valores de retorno
TRUE
Os dois prefixos IPv6 são o mesmo.
FALSE
Os dois prefixos IPv6 não são iguais.

otIp6GetMulticastAddresses

const otNetifMulticastAddress * otIp6GetMulticastAddresses(
  otInstance *aInstance
)

Receba a lista de endereços multicast IPv6 inscritos na interface Thread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para o primeiro endereço multicast da interface de rede.

otIp6GetUnicastAddresses

const otNetifAddress * otIp6GetUnicastAddresses(
  otInstance *aInstance
)

Veja a lista de endereços IPv6 atribuídos à interface Thread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para o primeiro endereço da interface de rede.

OtIp6GetUnsecurePorts

const uint16_t * otIp6GetUnsecurePorts(
  otInstance *aInstance,
  uint8_t *aNumEntries
)

Essa função retorna um ponteiro para a lista de portas não seguras.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aNumEntries
Número de entradas na lista.
Retorna
Um ponteiro para a lista de portas não seguras.

otIp6IsAddressEqual

bool otIp6IsAddressEqual(
  const otIp6Address *aFirst,
  const otIp6Address *aSecond
)

Teste se dois endereços IPv6 são iguais.

Detalhes
Parâmetros
[in] aFirst
Um ponteiro para o primeiro endereço IPv6 a ser comparado.
[in] aSecond
Um ponteiro para o segundo endereço IPv6 a ser comparado.
Valores de retorno
TRUE
Os dois endereços IPv6 são iguais.
FALSE
Os dois endereços IPv6 não são iguais.

OtIp6IsAddressUnspecified

bool otIp6IsAddressUnspecified(
  const otIp6Address *aAddress
)

Esta função indica se um determinado endereço IPv6 é ou não o endereço não especificado.

Detalhes
Parâmetros
[in] aAddress
Um ponteiro para um endereço IPv6.
Valores de retorno
TRUE
Se o endereço IPv6 for o endereço não especificado.
FALSE
Se o endereço IPv6 não for o endereço não especificado.

OtIp6IsEnabled

bool otIp6IsEnabled(
  otInstance *aInstance
)

Esta função indica se a interface IPv6 está ativa ou não.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
TRUE
A interface IPv6 está ativada.
FALSE
A interface IPv6 está desativada.

otIp6IsMulticastPromiscuousEnabled

bool otIp6IsMulticastPromiscuousEnabled(
  otInstance *aInstance
)

Verifique se o modo promíscuo multicast está ativado na interface Thread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Veja também:
otIp6SetMulticastPromiscuousEnabled

otIp6IsReceiveFilterEnabled

bool otIp6IsReceiveFilterEnabled(
  otInstance *aInstance
)

Esta função indica se o tráfego de controle da linha de execução é ou não filtrado ao enviar datagramas IPv6 por meio do callback especificado em otIp6SetReceiveCallback().

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Verdadeiro se o tráfego de controle da linha de execução for filtrado. Caso contrário, o valor será FALSO.
Veja também:
otIp6SetReceiveCallback
otIp6SetReceiveFilterEnabled

OtIp6IsSlaacEnabled

bool otIp6IsSlaacEnabled(
  otInstance *aInstance
)

Essa função indica se o módulo SLAAC está ativado ou não.

Essa função exige que o recurso de tempo de compilação OPENTHREAD_CONFIG_IP6_SLAAC_ENABLE esteja ativado.

Detalhes
Valores de retorno
TRUE
O módulo SLAAC está ativado.
FALSE
O módulo SLAAC está desativado.

OtIp6NewMessage

otMessage * otIp6NewMessage(
  otInstance *aInstance,
  const otMessageSettings *aSettings
)

Alocar um novo buffer de mensagem para enviar uma mensagem IPv6.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aSettings
Um ponteiro para as configurações de mensagem ou NULL para definir as configurações padrão.
Retorna
Um ponteiro para o buffer da mensagem ou NULL se nenhum buffer de mensagem estiver disponível ou os parâmetros forem inválidos.
Veja também:
otMessageFree

OtIp6NewMessageFromBuffer

otMessage * otIp6NewMessageFromBuffer(
  otInstance *aInstance,
  const uint8_t *aData,
  uint16_t aDataLength,
  const otMessageSettings *aSettings
)

Alocar um novo buffer de mensagem e gravar o datagrama IPv6 no buffer de mensagem para enviar uma mensagem IPv6.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aData
Um ponteiro para o buffer de datagramas IPv6.
[in] aDataLength
O tamanho do buffer do datagrama IPv6 apontado por aData.
[in] aSettings
Um ponteiro para as configurações de mensagem ou NULL para definir as configurações padrão.
Retorna
Um ponteiro para a mensagem ou NULL se um cabeçalho IPv6 malformado ou buffers de mensagem insuficientes estiverem disponíveis.
Veja também:
otMessageFree

otIp6PrefixMatch

uint8_t otIp6PrefixMatch(
  const otIp6Address *aFirst,
  const otIp6Address *aSecond
)

Essa função retorna o tamanho da correspondência de prefixo (bits) para dois endereços IPv6.

Detalhes
Parâmetros
[in] aFirst
Um ponteiro para o primeiro endereço IPv6.
[in] aSecond
Um ponteiro para o segundo endereço IPv6.
Retorna
O tamanho da correspondência de prefixo em bits.

otIp6PrefixToString

void otIp6PrefixToString(
  const otIp6Prefix *aPrefix,
  char *aBuffer,
  uint16_t aSize
)

Essa função converte um determinado prefixo IPv6 em uma string legível.

A string de endereço IPv6 é formatada como "%x:%x:%x:...[::]/plen".

Se a string resultante não couber no aBuffer (dentro de caracteres aSize), ela será truncada, mas a string resultante sempre será nula.

Detalhes
Parâmetros
[in] aPrefix
Um ponteiro para um prefixo IPv6 (NÃO DEVE ser NULL).
[out] aBuffer
Um ponteiro para uma matriz de caracteres para gerar a string (NÃO DEVE ser NULL).
[in] aSize
O tamanho de aBuffer (em bytes). É recomendável usar OT_IP6_PREFIX_STRING_SIZE.

otIp6ProtoToString

const char * otIp6ProtoToString(
  uint8_t aIpProto
)

Essa função converte um determinado número de protocolo IP em uma string legível.

Detalhes
Parâmetros
[in] aIpProto
Um número de protocolo IP (enumeração de OT_IP6_PROTO_*).
Retorna
String que representa aIpProto.

otIp6RegisterMulticastListeners

otError otIp6RegisterMulticastListeners(
  otInstance *aInstance,
  const otIp6Address *aAddresses,
  uint8_t aAddressNum,
  const uint32_t *aTimeout,
  otIp6RegisterMulticastListenersCallback aCallback,
  void *aContext
)

Essa função registra listeners de multicast para o roteador de backbone principal.

Observação: disponível apenas quando OPENTHREAD_CONFIG_TMF_PROXY_MLR_ENABLE e OPENTHREAD_CONFIG_COMMISSIONER_ENABLE estiverem ativados.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aAddresses
Uma matriz de endereços multicast a ser registrada.
[in] aAddressNum
O número de endereços multicast a serem registrados (0 se aAddresses for NULL).
[in] aTimeout
Um ponteiro para o valor de tempo limite (em segundos) a ser incluído em MLR.req. Um valor de tempo limite de 0 remove o listener de multicast correspondente. Se NULL, MLR.req não teria Timeout Tlv por padrão.
[in] aCallback
Um ponteiro para a função de callback.
[in] aContext
Um ponteiro para o contexto do usuário.
Valores de retorno
OT_ERROR_NONE
MLR.req enviado com sucesso. O aCallback será chamado se esse método retornar OT_ERROR_NONE.
OT_ERROR_BUSY
Se um registro anterior estava em andamento.
OT_ERROR_INVALID_ARGS
quando um ou mais argumentos são inválidos;
OT_ERROR_INVALID_STATE
Se o dispositivo não estiver em um estado válido para enviar MLR.req (por exemplo, "Comissionário não iniciado", "Roteador de backbone principal" não encontrado).
OT_ERROR_NO_BUFS
Se não houver buffers de mensagem suficientes.
Consulte também:
otIp6RegisterMulticastListenersCallback

OtIp6RemoveAllUnsecurePorts

void otIp6RemoveAllUnsecurePorts(
  otInstance *aInstance
)

Essa função remove todas as portas da lista de portas não seguras permitidas.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.

OtIp6RemoveUnicastAddress

otError otIp6RemoveUnicastAddress(
  otInstance *aInstance,
  const otIp6Address *aAddress
)

Remova um endereço de interface de rede da interface Thread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aAddress
Um ponteiro para um endereço IP.
Valores de retorno
OT_ERROR_NONE
Remoção do endereço da interface de rede.
OT_ERROR_INVALID_ARGS
O endereço IP indicado por aAddress é um endereço interno.
OT_ERROR_NOT_FOUND
O endereço IP indicado por aAddress não foi encontrado.

OtIp6RemoveUnSecurePort

otError otIp6RemoveUnsecurePort(
  otInstance *aInstance,
  uint16_t aPort
)

Essa função remove uma porta da lista de portas não seguras permitidas.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aPort
O valor da porta.
Valores de retorno
OT_ERROR_NONE
A porta foi removida da lista de portas não seguras permitidas.
OT_ERROR_INVALID_ARGS
A porta é inválida (o valor 0 está reservado para uso interno).
OT_ERROR_NOT_FOUND
A porta não foi encontrada na lista de portas não seguras.

OtIp6SelectSourceAddress

otError otIp6SelectSourceAddress(
  otInstance *aInstance,
  otMessageInfo *aMessageInfo
)

Essa função realiza a seleção de endereços de origem do OpenThread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in,out] aMessageInfo
Um ponteiro para as informações da mensagem.
Valores de retorno
OT_ERROR_NONE
Encontrado um endereço de origem e está preenchido no mSockAddr de aMessageInfo.
OT_ERROR_NOT_FOUND
Nenhum endereço de origem foi encontrado e aMessageInfo não foi alterado.

OtIp6Send

otError otIp6Send(
  otInstance *aInstance,
  otMessage *aMessage
)

Essa função envia um datagrama IPv6 pela interface Thread.

O autor da chamada transfere a propriedade de aMessage ao fazer esta chamada. O OpenThread liberará aMessage quando o processamento for concluído, incluindo quando um valor diferente de OT_ERROR_NONE for retornado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aMessage
Um ponteiro para o buffer de mensagem que contém o datagrama IPv6.
Valores de retorno
OT_ERROR_NONE
A mensagem foi processada.
OT_ERROR_DROP
A mensagem foi bem formada, mas não foi totalmente processada devido às regras de processamento de pacote.
OT_ERROR_NO_BUFS
Não foi possível alocar os buffers de mensagem necessários ao processar o datagrama.
OT_ERROR_NO_ROUTE
Não há rota para o host.
OT_ERROR_INVALID_SOURCE_ADDRESS
O endereço de origem é inválido (por exemplo, um endereço anycast ou um endereço multicast).
OT_ERROR_PARSE
Um cabeçalho incorreto foi encontrado ao processar a mensagem.

OtIp6SetAddressCallback

void otIp6SetAddressCallback(
  otInstance *aInstance,
  otIp6AddressCallback aCallback,
  void *aCallbackContext
)

Essa função registra um callback para notificar as mudanças internas no endereço IPv6.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aCallback
Um ponteiro para uma função chamada quando um endereço IPv6 interno é adicionado ou removido. NULL para desativar o callback.
[in] aCallbackContext
Um ponteiro para contexto específico do aplicativo.

OtIp6SetEnabled

otError otIp6SetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Essa função exibe a interface IPv6 para baixo/baixo.

Chame esta função para ativar/desativar a comunicação IPv6.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aEnabled
VERDADEIRO para ativar IPv6, FALSO caso contrário.
Valores de retorno
OT_ERROR_NONE
A interface IPv6 foi ativada/desativada.
OT_ERROR_INVALID_STATE
A interface IPv6 não está disponível porque o dispositivo está operando no modo de link bruto (aplicável somente quando o recurso OPENTHREAD_CONFIG_LINK_RAW_ENABLE está ativado).

OtIp6SetMeshLocalIid

otError otIp6SetMeshLocalIid(
  otInstance *aInstance,
  const otIp6InterfaceIdentifier *aIid
)

Essa função define o IID do mesh local (para fins de teste).

Disponível apenas quando a OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE está ativada.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aIid
Um ponteiro para o IID local da malha a ser definido.
Valores de retorno
OT_ERROR_NONE
O IDID do Mesh local foi definido.
OT_ERROR_INVALID_STATE
Os protocolos da conversa estão ativados.

otIp6SetMulticastPromiscuousEnabled

void otIp6SetMulticastPromiscuousEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Ativa o modo promíscuo multicast na interface de linha de execução.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aEnabled
TRUE para ativar o modo promíscuo multicast. FALSO, caso contrário.
Consulte também:
otIp6IsMulticastPromiscuousEnabled

OtIp6SetReceiveCallback

void otIp6SetReceiveCallback(
  otInstance *aInstance,
  otIp6ReceiveCallback aCallback,
  void *aCallbackContext
)

Essa função registra um callback para fornecer datagramas IPv6 recebidos.

Por padrão, esse callback não transmite tráfego de controle de linha de execução. Consulte otIp6SetReceiveFilterEnabled() para alterar a configuração do filtro de tráfego de controle de linha de execução.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aCallback
Um ponteiro para uma função chamada quando um datagrama IPv6 é recebido ou NULL para desativar o retorno de chamada.
[in] aCallbackContext
Um ponteiro para contexto específico do aplicativo.
Veja também:
otIp6IsReceiveFilterEnabled
otIp6SetReceiveFilterEnabled

otIp6SetReceiveFilterEnabled

void otIp6SetReceiveFilterEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Esta função define se o tráfego de controle da linha de execução é ou não filtrado ao enviar datagramas IPv6 por meio do callback especificado em otIp6SetReceiveCallback().

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aEnabled
Verdadeiro se o tráfego de controle da linha de execução for filtrado. Caso contrário, o valor será FALSO.
Consulte também:
otIp6SetReceiveCallback
otIsReceiveIp6FilterEnabled

OtIp6SetSlaacEnabled

void otIp6SetSlaacEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Essa função ativa/desativa o módulo SLAAC.

Essa função exige que o recurso de tempo de compilação OPENTHREAD_CONFIG_IP6_SLAAC_ENABLE esteja ativado.

Quando o módulo SLAAC está ativado, endereços SLAAC (com base em prefixos de malha nos dados de rede) são adicionados à interface. Quando o módulo SLAAC é desativado, qualquer endereço SLAAC adicionado anteriormente é removido.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aEnabled
VERDADEIRO para ativar e FALSO para desativar.

otIp6SetSlaacPrefixFilter

void otIp6SetSlaacPrefixFilter(
  otInstance *aInstance,
  otIp6SlaacPrefixFilter aFilter
)

Essa função define o gerenciador de filtros do módulo SLAAC.

Essa função exige que o recurso de tempo de compilação OPENTHREAD_CONFIG_IP6_SLAAC_ENABLE esteja ativado.

O gerenciador de filtros é chamado pelo módulo SLAAC quando está prestes a adicionar um endereço SLAAC com base em um prefixo para decidir se o endereço deve ser adicionado ou não.

Um gerenciador de filtros NULL desativa a filtragem e permite que todos os endereços SLAAC sejam adicionados.

Se essa função não for chamada, o filtro padrão usado pelo módulo SLAAC será NULL (a filtragem está desativada).

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aFilter
Um ponteiro para o gerenciador de filtro de prefixo do SLAAC ou NULL para desativar a filtragem.

otIp6SockAddrToString

void otIp6SockAddrToString(
  const otSockAddr *aSockAddr,
  char *aBuffer,
  uint16_t aSize
)

Essa função converte um determinado endereço de soquete IPv6 em uma string legível.

A string de endereço do soquete IPv6 é formatada como "[

]:" em que `
é exibido como 16 valores hexadecimais separados por ':' e é o número da porta em formato decimal (por exemplo, "[%x:%x:...:%x]:%u")

Se a string resultante não couber no aBuffer (dentro de caracteres aSize), ela será truncada, mas a string resultante sempre será nula.

Detalhes
Parâmetros
[in] aSockAddr
Um ponteiro para um endereço de soquete IPv6 (NÃO pode ser NULL).
[out] aBuffer
Um ponteiro para uma matriz de caracteres para gerar a string (NÃO DEVE ser NULL).
[in] aSize
O tamanho de aBuffer (em bytes). É recomendável usar OT_IP6_SOCK_ADDR_STRING_SIZE.

OtIp6SubscribeMulticastAddress

otError otIp6SubscribeMulticastAddress(
  otInstance *aInstance,
  const otIp6Address *aAddress
)

Inscrever a interface Thread em um endereço multicast de interface de rede.

A instância passada aAddress será copiada pela interface Thread. A interface Thread aceita apenas um número fixo de endereços multicast adicionados externamente. Consulte OPENTHREAD_CONFIG_IP6_MAX_EXT_MCAST_ADDRS.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aAddress
Um ponteiro para um endereço IP.
Valores de retorno
OT_ERROR_NONE
Você se inscreveu no endereço de multicast da interface de rede.
OT_ERROR_ALREADY
O endereço multicast já está inscrito.
OT_ERROR_INVALID_ARGS
O endereço IP indicado por aAddress é um endereço multicast inválido.
OT_ERROR_REJECTED
O endereço IP indicado por aAddress é um endereço multicast interno.
OT_ERROR_NO_BUFS
A interface de rede já está armazenando o máximo permitido de endereços multicast externos.

otIp6CancelMulticastAddress

otError otIp6UnsubscribeMulticastAddress(
  otInstance *aInstance,
  const otIp6Address *aAddress
)

Cancele a inscrição da interface Thread para um endereço de multicast da interface de rede.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aAddress
Um ponteiro para um endereço IP.
Valores de retorno
OT_ERROR_NONE
A inscrição no endereço multicast da interface de rede foi cancelada.
OT_ERROR_REJECTED
O endereço IP indicado por aAddress é um endereço interno.
OT_ERROR_NOT_FOUND
O endereço IP indicado por aAddress não foi encontrado.

Macros

OT_IP6_ADDRESS_SIZE

 OT_IP6_ADDRESS_SIZE 16

Tamanho de um endereço IPv6 (bytes)

OT_IP6_ADDRESS_STRING_SIZE

 OT_IP6_ADDRESS_STRING_SIZE 40

Tamanho recomendado para representação de string de um endereço IPv6.

OT_IP6_IID_SIZE

 OT_IP6_IID_SIZE 8

Tamanho de um identificador de interface IPv6 (bytes)

OT_IP6_MAX_MLR_ADDRESSES

 OT_IP6_MAX_MLR_ADDRESSES 15

Número máximo de endereços IPv6 compatíveis com o registro de listener do multicast.

OT_IP6_PREFIX_BITSIZE

 OT_IP6_PREFIX_BITSIZE (OT_IP6_PREFIX_SIZE * 8)

Tamanho de um prefixo IPv6 (bits)

OT_IP6_PREFIX_SIZE

 OT_IP6_PREFIX_SIZE 8

Tamanho de um prefixo IPv6 (bytes)

OT_IP6_PREFIX_STRING_SIZE

 OT_IP6_PREFIX_STRING_SIZE 45

Tamanho recomendado para representação de string de um prefixo IPv6.

OT_IP6_SOCK_ADDR_STRING_SIZE

 OT_IP6_SOCK_ADDR_STRING_SIZE 48

Tamanho recomendado para representação de string de um endereço de soquete IPv6.

Recursos

Os tópicos de referência da API OpenThread são originados do código-fonte, disponível no GitHub. Para saber mais ou contribuir com nossa documentação, consulte Recursos.