SRP

Esta enumeração especifica um estado de item de cliente SRP (informações de serviço ou host).

Essa enumeração representa o modo de endereço usado pelo servidor SRP.

O modo de endereço especifica como o endereço e o número da porta são determinados pelo servidor SRP e como essas informações são publicadas nos Dados da Rede de Threads.

Representa o estado de um servidor SRP.

Este tipo de ponteiro de função define o retorno de chamada usado pelo cliente SRP para notificar o usuário quando ele é iniciado ou interrompido automaticamente.

Isso só é usado quando o recurso de auto-start OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_API_ENABLE está habilitado.

Esse retorno de chamada é invocado quando o modo de inicialização automática está habilitado e o cliente SRP é iniciado ou interrompido automaticamente.

Esta estrutura representa uma entrada do pool de serviço do cliente SRP.

Este tipo de ponteiro de função define o retorno de chamada usado pelo cliente SRP para notificar o usuário sobre alterações / eventos / erros.

Este retorno de chamada é invocado em um registro bem-sucedido de uma atualização (ou seja, adicionar / remover informações do host e / ou alguns serviços) com o servidor SRP, ou se houver uma falha ou erro (por exemplo, o servidor rejeita uma atualização a solicitação ou o cliente atinge o tempo limite esperando por uma resposta, etc.).

No caso de um recadastramento bem sucedida de uma atualização, aError parâmetro seria OT_ERROR_NONE e a informação de acolhimento e a lista completa de serviços é fornecido como parâmetros de entrada para a chamada de retorno. Note-se que informação e serviços de acolhimento cada controlar o seu próprio estado no correspondente mState variável membro da estrutura de dados relacionada (o estado indica se o hospedeiro-Informação / serviço está registado ou removido ou ainda sendo adicionados / removidos, etc).

A lista de serviços removidos é passado como seus próprios lista ligada aRemovedServices no retorno de chamada. Note-se que quando o retorno de chamada é invocado, o cliente SRP (implementação OpenThread) é feito com as instâncias removidas de serviços enumeradas no aRemovedServices e há faixas mais longas / lojas-los (ou seja, se a partir do retorno de chamada que chamamos otSrpClientGetServices() os serviços removidos não será presente na lista devolvida). Fornecer uma lista separada de serviços removidos no retorno de chamada ajuda a indicar ao usuário quais itens foram removidos e permite que o usuário reivindique / reutilize as instâncias.

Se o servidor rejeitar uma solicitação de atualização SRP, o código de resposta DNS (RFC 2136) será mapeado para os seguintes erros:

• (0) NOERROR Sucesso (sem condição de erro) -> OT_ERROR_NONE
• (1) FORMERR Server incapaz de interpretar devido a erro de formato -> OT_ERROR_PARSE
• (2) O servidor SERVFAIL encontrou uma falha interna -> OT_ERROR_FAILED
• (3) NXDOMAIN Nome que deveria existir, não existe -> OT_ERROR_NOT_FOUND
• (4) NOTIMP Server não suporta o tipo de consulta (OpCode) -> OT_ERROR_NOT_IMPLEMENTED
• (5) RECUSADO Servidor recusado por razões de política / segurança -> OT_ERROR_SECURITY
• (6) YXDOMAIN Algum nome que não deveria existir, existe -> OT_ERROR_DUPLICATED
• (7) YXRRSET Algum RRset que não deveria existir, existe -> OT_ERROR_DUPLICATED
• (8) NXRRSET Algum RRset que deveria existir, não existe -> OT_ERROR_NOT_FOUND
• (9) O serviço NOTAUTH não tem autoridade para a zona -> OT_ERROR_SECURITY
• (10) NOTZONE Um nome não está na zona -> OT_ERROR_PARSE
• (20) Mau nome de BADNAME -> OT_ERROR_PARSE
• (21) BADALG Algoritmo ruim -> OT_ERROR_SECURITY
• (22) BADTRUN Truncamento ruim -> OT_ERROR_PARSE
• Outros códigos de resposta -> OT_ERROR_FAILED

Os seguintes erros também são possíveis:

• OT_ERROR_RESPONSE_TIMEOUT: Tempo limite esgotado ao aguardar a resposta do servidor (o cliente continuaria a tentar novamente).
• OT_ERROR_INVALID_ARGS: A estrutura de serviço fornecido é inválido (por exemplo, nome do serviço ruim ou otDnsTxtEntry ).
• OT_ERROR_NO_BUFS: Buffer insuficiente para preparar ou enviar a mensagem de atualização.

Observe que em caso de falha, o cliente continua a operação, ou seja, prepara e (re) transmite a mensagem de atualização do SRP para o servidor, após algum intervalo de espera. A repetição esperar começa intervalo entre o valor mínimo e é aumentada pelo fator de crescimento cada fracasso, até o valor máximo (consulte configuração de parâmetros OPENTHREAD_CONFIG_SRP_CLIENT_MIN_RETRY_WAIT_INTERVAL e aqueles relacionados para mais detalhes).

Esta estrutura representa as informações do host do cliente SRP.

Esta estrutura representa um serviço de cliente SRP.

Os valores nesta estrutura, incluindo os buffers de cadeias para os nomes e as entradas de registo TXT, deve persistir e estadia constante após um exemplo desta estrutura é passado para OpenThread de otSrpClientAddService() ou otSrpClientRemoveService() .

Essa enumeração representa o modo de endereço usado pelo servidor SRP.

O modo de endereço especifica como o endereço e o número da porta são determinados pelo servidor SRP e como essas informações são publicadas nos Dados da Rede de Threads.

Este tipo opaco representa um host de serviço SRP.

Essa estrutura inclui as configurações LEASE e KEY-LEASE do servidor SRP.

Este tipo opaco representa um serviço SRP.

O tipo de sinalizador de serviço para indicar quais serviços incluir ou excluir ao pesquisar (ou iterar) na lista de serviços SRP.

Esta é uma combinação de sinalizadores de bits. O bit de sinalizadores específicos são definidos na enumeração OT_SRP_SERVER_FLAG_* .

Esta função lida com atualizações de serviço SRP.

Esta função é chamada pelo servidor SRP para notificar que um host SRP e possivelmente serviços SRP estão sendo atualizados. É importante que as atualizações SRP não são confirmadas até que o manipulador retorna o resultado chamando otSrpServerHandleServiceUpdateResult ou o tempo limite após aTimeout .

Um observador de serviço SRP deve sempre chamar otSrpServerHandleServiceUpdateResult com o código de erro OT_ERROR_NONE imediatamente após receber os eventos de atualização.

Um manipulador mais genérico pode realizar validações no host / serviços SRP e rejeitar as atualizações SRP se qualquer validação falhar. Por exemplo, um Advertising Proxy deve anunciar (ou remover) o host e os serviços em um link compatível com multicast e retorna o código de erro específico se ocorrer alguma falha.

O ID de uma transação de atualização de serviço SRP no servidor SRP.

Esta função adiciona um serviço a ser registrado no servidor.

Após uma chamada bem-sucedida para esta função, otSrpClientCallback será chamado para relatar o status da adição de serviço / Registro com o servidor SRP.

O otSrpClientService instância que está sendo apontado por aService deve persistir e permanecer inalterada depois de voltar de esta função (com OT_ERROR_NONE ). OpenThread salvará o ponteiro para a instância do serviço.

O otSrpClientService instância não é mais controlado pelo OpenThread e somente quando pode ser recuperado

• Ele é removido explicitamente por uma chamada para otSrpClientRemoveService() ou removido juntamente com outros serviços por uma chamada para otSrpClientRemoveHostAndServices() and only after the otSrpClientCallback` é chamado indicando o serviço foi removido. Ou,
• Uma chamada para otSrpClientClearHostAndServices() que remove o host e todos os serviços relacionados imediatamente.

Esta função aloca uma nova entrada de serviço do pool.

A instância de entrada de serviço retornada será inicializada da seguinte maneira:

• mService.mName irá apontar para uma memória intermédia de cadeia alocado que pode ser recuperado usando a função otSrpClientBuffersGetServiceEntryServiceNameString() .
• mService.mInstanceName irá apontar para uma memória intermédia de cadeia alocado que pode ser recuperado usando a função otSrpClientBuffersGetServiceEntryInstanceNameString() .
• mService.mSubTypeLabels pontos a uma matriz que é devolvido a partir otSrpClientBuffersGetSubTypeLabelsArray() .
• mService.mTxtEntries irá apontar para mTxtEntry .
• mService.mNumTxtEntries será definido para um.
• Outros mService campos (porta, prioridade, em peso) são postos a zero.
• mTxtEntry.mKey é definido como NULL (valor é tratado como já codificado).
• mTxtEntry.mValue irá apontar para uma memória intermédia atribuída, que pode ser recuperado usando a função otSrpClientBuffersGetServiceEntryTxtBuffer() .
• mTxtEntry.mValueLength está definido para zero.
• Todos os dados / buffers de string e matrizes relacionados são zerados.

Esta função libera todas as entradas de serviço alocadas anteriormente.

Esta função libera uma entrada de serviço previamente alocada.

O aService deve ser previamente alocados usando otSrpClientBuffersAllocateService() e ainda não liberados. Caso contrário, o comportamento desta função é indefinido.

Esta função obtém a matriz de entradas de endereço IPv6 para usar como lista de endereços de host de cliente SRP.

Esta função obtém o buffer de string a ser usado para o nome de host do cliente SRP.

Esta função obtém o buffer de string para o nome da instância de serviço de uma entrada de serviço.

Esta função obtém o buffer de string para o nome do serviço de uma entrada de serviço.

Esta função obtém o buffer para o registro TXT de uma entrada de serviço.

Esta função obtém a matriz para rótulos de subtipos de serviço da entrada de serviço.

Esta função limpa todas as informações do host e todos os serviços.

Ao contrário otSrpClientRemoveHostAndServices() que envia uma mensagem de atualização para o servidor para remover toda a informação, esta função apaga todas as informações imediatamente, sem qualquer interação com o servidor.

Esta função limpa um serviço, removendo-o imediatamente da lista de serviços do cliente.

Ao contrário otSrpClientRemoveService() que envia uma mensagem de atualização para o servidor para remover o serviço, esta função limpa a serviço da lista de serviços do cliente, sem qualquer interação com o servidor. Em uma chamada bem-sucedida para esta função, o otSrpClientCallback não será chamado eo aService entrada pode ser recuperada e reutilizada pelo chamador imediatamente.

Esta função pode ser usada juntamente com uma chamada subsequente para otSrpClientAddService() (potencialmente reutilizando o mesmo aService entrada com os mesmos nomes de serviços e de instância) para atualizar alguns dos parâmetros de um serviço já existente.

Esta função desativa o modo de inicialização automática.

Isto só está disponível quando o recurso de auto-start OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_API_ENABLE está habilitado.

Desativar o modo de inicialização automática não interromperá o cliente se ele já estiver em execução, mas o cliente interromperá o monitoramento dos dados de rede do thread para verificar se o servidor SRP selecionado ainda está presente nele.

Note-se que uma chamada para otSrpClientStop() também irá desativar o modo de auto-start.

Esta função ativa o modo de inicialização automática.

Isto só está disponível quando o recurso de auto-start OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_API_ENABLE está habilitado.

Configuração opção OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_DEFAULT_MODE Especifica o modo de auto-start padrão (se ele está ativado ou desativado no início da OT pilha).

Quando a inicialização automática está habilitada, o cliente SRP monitora os Thread Network Data para entradas de serviço do servidor SRP e inicia e interrompe automaticamente o cliente quando um servidor SRP é detectado.

Se vários servidores SRP forem encontrados, um aleatório será selecionado. Se o servidor SRP selecionado não for mais detectado (não estiver mais presente no Thread Network Data), o cliente SRP será interrompido e, em seguida, poderá alternar para outro servidor SRP (se disponível).

Quando o cliente SRP é explicitamente começou através de uma chamada bem-sucedida para otSrpClientStart() , o dado endereço do servidor SRP em otSrpClientStart() continuará a ser utilizado independentemente do estado do modo de auto-start e se o mesmo endereço do servidor SRP é descoberto ou não nos dados da rede do segmento. Neste caso, apenas uma explícita otSrpClientStop() chamada vai parar o cliente.

Esta função obtém o nome de domínio que está sendo usado pelo cliente SRP.

Esta função requer OPENTHREAD_CONFIG_SRP_CLIENT_DOMAIN_NAME_API_ENABLE para ser ativado.

Se o nome de domínio não for definido, "default.service.arpa" será usado.

Esta função obtém as informações do host.

Esta função obtém o intervalo de concessão de chave usado em solicitações de atualização de SRP.

Observe que esta é a duração do aluguel solicitada pelo cliente SRP. O servidor pode escolher aceitar um intervalo de aluguel diferente.

Esta função obtém o intervalo de concessão usado nas solicitações de atualização SRP.

Observe que esta é a duração do aluguel solicitada pelo cliente SRP. O servidor pode escolher aceitar um intervalo de aluguel diferente.

Esta função obtém o endereço de soquete (endereço IPv6 e número da porta) do servidor SRP que está sendo usado pelo cliente SRP.

Se o cliente não estiver em execução, o endereço não é especificado (todo zero) com número de porta zero.

Esta função obtém a lista de serviços gerenciados pelo cliente.

Esta função indica o estado atual do modo de partida automática (habilitado ou desabilitado).

Isto só está disponível quando o recurso de auto-start OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_API_ENABLE está habilitado.

Esta função indica se o cliente SRP está em execução ou não.

Este método indica se o modo "inclusão de registro de chave de serviço" está habilitado ou desabilitado.

Esta função está disponível quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE configuração é habilitado.

Esta função converte um otSrpClientItemState a uma corda.

Esta função inicia o processo de remoção das informações do host e de todos os serviços.

Depois de voltar de esta função, otSrpClientCallback será chamado para relatar o status da solicitação de remoção com o servidor SRP.

Se a informação de acolhimento deve ser permanentemente removidos do servidor, aRemoveKeyLease deve ser definido como true que remove o arrendamento chave associada com o anfitrião no servidor. Caso contrário, o registro de aluguel da chave é mantido como antes, o que garante que o servidor mantenha o nome do host em reserva para quando o cliente for mais uma vez capaz de fornecer e registrar seu (s) serviço (s).

O aSendUnregToServer determina o comportamento quando a informação de acolhimento ainda não está registrado com o servidor. Se aSendUnregToServer está definido como false (que é o / valor esperado padrão), então o cliente SRP irá remover imediatamente a informação e os serviços de acolhimento sem enviar uma mensagem de atualização de servidor (não há necessidade de atualizar o servidor, se nada for registrado ainda com ele). Se aSendUnregToServer está definido como true , em seguida, o cliente SRP irá enviar uma mensagem de atualização para o servidor. Observe que, se a informação de acolhimento é registrado, em seguida, o valor de aSendUnregToServer não importa e o cliente SRP sempre enviar uma mensagem de atualização para o servidor solicitar a remoção de todas as informações.

Uma situação onde aSendUnregToServer pode ser útil é em uma redefinição do dispositivo / reboot, chamador pode querer remover quaisquer serviços previamente registrado com o servidor. Neste caso, chamador pode otSrpClientSetHostName() e, em seguida, solicitar otSrpClientRemoveHostAndServices() com aSendUnregToServer como true .

Esta função solicita que um serviço seja cancelado no servidor.

Após uma chamada bem-sucedida para esta função, otSrpClientCallback será chamado para relatar o status da solicitação de remoção com o servidor SRP.

O otSrpClientService instância que está sendo apontado por aService deve persistir e permanecer inalterada depois de voltar de esta função (com OT_ERROR_NONE ). OpenThread manterá a instância do serviço durante o processo de remoção. Somente após a otSrpClientCallback é chamado indicando a instância de serviço é removido da lista de atendimento ao cliente SRP e pode ser ser libertado / reutilizados.

Esta função define o retorno de chamada para notificar o chamador de eventos / alterações do cliente SRP.

O cliente SRP permite que um único retorno de chamada seja registrado. Portanto, chamadas consecutivas para esta função substituirão quaisquer funções de retorno de chamada definidas anteriormente.

Esta função define o nome de domínio a ser usado pelo cliente SRP.

Esta função requer OPENTHREAD_CONFIG_SRP_CLIENT_DOMAIN_NAME_API_ENABLE para ser ativado.

Se não for definido, "default.service.arpa" será usado.

O buffer de nome string apontada por aName deve persistir e permanecer inalterada depois de voltar de esta função. OpenThread manterá o ponteiro para a string.

O nome de domínio pode ser definido antes cliente é iniciado ou após a largada, mas antes de informações de host é registrado com o servidor (informações do anfitrião deve ser em qualquer STATE_TO_ADD ou STATE_TO_REMOVE ).

Esta função define / atualiza a lista de endereços IPv6 do host.

Os endereços IPv6 do host podem ser definidos / alterados antes do início ou durante a operação do cliente SRP (por exemplo, para adicionar / remover ou alterar um endereço de host registrado anteriormente), exceto quando as informações do host estão sendo removidas (o cliente está ocupado lidando com uma solicitação de remoção de um anterior chamada para otSrpClientRemoveHostAndServices() e informações de acolhimento continuam a ser em qualquer STATE_TO_REMOVE ou STATE_REMOVING estados).

A matriz de endereços IPv6 anfitrião apontado por aAddresses deve persistir e permanecer inalterada depois de voltar de esta função (com OT_ERROR_NONE ). OpenThread salvará o ponteiro para a matriz.

Após uma chamada bem-sucedida para esta função, otSrpClientCallback será chamado para relatar o status do registro de endereço com o servidor SRP.

This function sets the host name label.

After a successful call to this function, otSrpClientCallback will be called to report the status of host info registration with SRP server.

The name string buffer pointed to by aName MUST persist and stay unchanged after returning from this function. OpenThread will keep the pointer to the string.

The host name can be set before client is started or after start but before host info is registered with server (host info should be in either STATE_TO_ADD or STATE_REMOVED ).

This function sets the key lease interval used in SRP update requests.

Changing the lease interval does not impact the accepted lease interval of already registered services/host-info. It only affects any future SRP update messages (ie, adding new services and/or refreshes of existing services).

This function sets the lease interval used in SRP update requests.

Changing the lease interval does not impact the accepted lease interval of already registered services/host-info. It only affects any future SRP update messages (ie, adding new services and/or refreshes of the existing services).

This function enables/disables "service key record inclusion" mode.

When enabled, SRP client will include KEY record in Service Description Instructions in the SRP update messages that it sends.

This function is available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE configuration is enabled.

This function starts the SRP client operation.

SRP client will prepare and send "SRP Update" message to the SRP server once all the following conditions are met:

• The SRP client is started - otSrpClientStart() is called.
• Host name is set - otSrpClientSetHostName() is called.
• At least one host IPv6 address is set - otSrpClientSetHostName() is called.
• At least one service is added - otSrpClientAddService() is called.

It does not matter in which order these functions are called. When all conditions are met, the SRP client will wait for a short delay before preparing an "SRP Update" message and sending it to server. This delay allows for user to add multiple services and/or IPv6 addresses before the first SRP Update message is sent (ensuring a single SRP Update is sent containing all the info). The config OPENTHREAD_CONFIG_SRP_CLIENT_UPDATE_TX_DELAY specifies the delay interval.

This function stops the SRP client operation.

This function stops any further interactions with the SRP server. Note that it does not remove or clear host info and/or list of services. It marks all services to be added/removed again once the client is (re)started.

This function returns the address mode being used by the SRP server.

This function returns the sequence number used with anycast address mode.

The sequence number is included in "DNS/SRP Service Anycast Address" entry published in the Network Data.

This function returns the domain authorized to the SRP server.

If the domain if not set by SetDomain, "default.service.arpa." will be returned. A trailing dot is always appended even if the domain is set without it.

This function returns SRP server LEASE and KEY-LEASE configurations.

This function returns the next registered host on the SRP server.

This function returns the state of the SRP server.

This function reports the result of processing a SRP update to the SRP server.

The Service Update Handler should call this function to return the result of its processing of a SRP update.

This function finds the next matching service on the host.

The combination of flags and service and instance names enables iterating over the full list of services and/or a subset of them matching certain conditions, or finding a specific service.

To iterate over all services of a host: service = otSrpServerHostFindNextService(host, service, OT_SRP_SERVER_FLAGS_ANY_SERVICE, NULL, NULL);

To iterate over base services only (exclude sub-types): service = otSrpServerHostFindNextService(host, service, OT_SRP_SERVER_FLAGS_BASE_TYPE_SERVICE_ONLY, NULL, NULL);

To iterate over sub-types of a specific instance name instanceName : service = otSrpServerHostFindNextService(host, service, OT_SRP_SERVER_FLAGS_SUB_TYPE_SERVICE_ONLY, NULL, instanceName);

To find a specific service with service name serviceName and service instance name instanceName : service = otSrpServerHostFindNextService(host, NULL, OT_SRP_SERVER_FLAGS_ANY_SERVICE, serviceName, instanceName);

To find the base type service with a given service instance name instanceName : service = otSrpServerHostFindNextService(host, NULL, OT_SRP_SERVER_FLAGS_BASE_TYPE_SERVICE_ONLY, NULL, instanceName);

This function returns the addresses of given host.

This function returns the full name of the host.

This function returns the next service (excluding any sub-type services) of given host.

This function tells if the SRP service host has been deleted.

A SRP service host can be deleted but retains its name for future uses. In this case, the host instance is not removed from the SRP server/registry.

This function returns the full service instance name of the service.

This function returns the host which the service instance reside on.

This function returns the full service instance name of the service.

This function returns the port of the service instance.

This function returns the priority of the service instance.

This function returns the full service name of the service.

This function gets the sub-type label from service name.

This function is intended to be used when the aService is a sub-type, ie, otSrpServerServiceIsSubType() for the service returns TRUE. If it is not a sub-type this function returns OT_ERROR_INVALID_ARGS .

The full service name for a sub-type service follows " ._sub. . .". This function copies the into the aLabel buffer.

The aLabel is ensured to always be null-terminated after returning even in case of failure.

This function returns the TXT record data of the service instance.

This function returns the weight of the service instance.

This function indicates whether or not the SRP service has been deleted.

A SRP service can be deleted but retains its name for future uses. In this case, the service instance is not removed from the SRP server/registry. It is guaranteed that all services are deleted if the host is deleted.

This function indicates whether or not the SRP service is sub-type.

This function sets the address mode to be used by the SRP server.

This function sets the sequence number used with anycast address mode.

This function sets the domain on the SRP server.

A trailing dot will be appended to aDomain if it is not already there. This function should only be called before the SRP server is enabled.

This function enables/disables the SRP server.

This function sets SRP server LEASE and KEY-LEASE configurations.

When a non-zero LEASE time is requested from a client, the granted value will be limited in range [aMinLease, aMaxLease]; and a non-zero KEY-LEASE will be granted in range [aMinKeyLease, aMaxKeyLease]. For zero LEASE or KEY-LEASE time, zero will be granted.

This function sets the SRP service updates handler on SRP server.