nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager

#include <src/lib/profiles/service-directory/ServiceDirectory.h>

O objeto gerenciador do diretório de serviços do Weave.

Resumo

O gerenciador de serviços do Weave é a interface principal de aplicativos para o serviço de diretório. Assim, ele oculta as complicações inerentes à pesquisa da entrada de diretório associada a um endpoint de serviço, fazendo a pesquisa DNS em um ou mais nomes de host encontrados, tentando se conectar, protegendo a conexão e assim por diante. Ele também pode gerenciar um cache de informações do diretório de serviços.

Construtores e destruidores
WeaveServiceManager(void)
Esse método inicializa a instância do WeaveServiceManager.
~WeaveServiceManager(void)
Este método destrói a instância WeaveServiceManager.

Tipos públicos
@303{
  kWeave_DefaultSendTimeout = 15000
} 		enum
OnConnectBegin)(struct ServiceConnectBeginArgs &args) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::OnConnectBegin
void(*
Um callback do aplicativo feito imediatamente antes do estabelecimento da conexão.
OnServiceEndpointQueryBegin)(void) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::OnServiceEndpointQueryBegin
void(*
Um callback do aplicativo para marcar o horário de uma consulta de saída do diretório de serviços.
OnServiceEndpointQueryEndWithTimeInfo)(uint64_t timeQueryReceiptMsec, uint32_t timeProcessMsec) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::OnServiceEndpointQueryEndWithTimeInfo
void(*
Um callback de aplicativo para fornecer valores de tempo de uma resposta do diretório de serviços.
RootDirectoryAccessor)(uint8_t *aDirectory, uint16_t aLength) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::RootDirectoryAccessor
Uma função de acesso às informações do diretório raiz.
StatusHandler)(void *anAppState, WEAVE_ERROR anError, StatusReport *aStatusReport) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::StatusHandler
void(*
Um gerenciador para condições de erro e status.

Funções públicas
SetConnectBeginCallback(OnConnectBegin aConnectBegin)
void
Defina uma função de callback para ser chamada imediatamente antes do estabelecimento da conexão.
cancel(uint64_t aServiceEp, void *aAppState)
void
Esse método cancela uma solicitação de conexão.
clearCache(void)
void
Esse método limpa o estado e o cache do gerenciador se o estado estiver no estado terminal kServiceMgrState_Resolved, o que significa que a resposta do endpoint do diretório de serviços foi recebida.
connect(uint64_t aServiceEp, WeaveAuthMode aAuthMode, void *aAppState, StatusHandler aStatusHandler, WeaveConnection::ConnectionCompleteFunct aConnectionCompleteHandler, const uint32_t aConnectTimeoutMsecs, const InterfaceId aConnectIntf)
As solicitações desse método se conectam a um serviço do Weave.
init(WeaveExchangeManager *aExchangeMgr, uint8_t *aCache, uint16_t aCacheLen, RootDirectoryAccessor aAccessor, WeaveAuthMode aDirAuthMode, OnServiceEndpointQueryBegin aServiceEndpointQueryBegin, OnServiceEndpointQueryEndWithTimeInfo aServiceEndpointQueryEndWithTimeInfo, OnConnectBegin aConnectBegin)
Esse método inicializa o objeto do gerenciador de serviços.
lookup(uint64_t aServiceEp, HostPortList *outHostPortList)
Esse método procura informações de diretório para um endpoint de serviço.
lookup(uint64_t aServiceEp, uint8_t *aControlByte, uint8_t **aDirectoryEntry)
Esse método procura informações de diretório para um endpoint de serviço.
onConnectionClosed(WEAVE_ERROR aError)
void
Esse método lida com o evento de conexão fechado informado pelo contexto de troca do Weave associado.
onConnectionComplete(WEAVE_ERROR aError)
void
Esse método processa o evento de conexão concluída para a transação de consulta do endpoint de serviço.
onResponseReceived(uint32_t aProfileId, uint8_t aMsgType, PacketBuffer *aMsg)
void
Esse método processa qualquer mensagem de resposta na conversa com o serviço de diretório.
onResponseTimeout(void)
void
Esse método processa o evento de tempo limite, em que nenhuma resposta foi recebida do serviço de diretório.
relocate(WEAVE_ERROR aError)
void
Esse método realoca o cache do diretório de serviços.
relocate(void)
void
Esse método realoca o cache do diretório de serviços.
replaceOrAddCacheEntry(uint16_t port, const char *hostName, uint8_t hostLen, uint64_t serviceEndpointId)
Adicione a entrada de diretório de substituição de um nome de host e ID de porta no início da lista de diretórios.
reset(WEAVE_ERROR aError)
void
Esse método redefine o gerenciador de serviços para o estado inicial.
reset(void)
void
Esse método redefine o gerenciador de serviços para o estado inicial.
unresolve(WEAVE_ERROR aError)
void
Esse método invalida o cache do diretório de serviços.
unresolve(void)
void
Esse método invalida o cache do diretório de serviços.

Classes
nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::ConnectRequest

Essa classe representa uma única transação gerenciada pelo gerenciador de serviços.

Tipos públicos

@303

 @303
Propriedades
kWeave_DefaultSendTimeout

Número de milissegundos que uma resposta precisa ser recebida para a consulta do diretório antes que o contexto de troca expire.

OnConnectBegin

void(* OnConnectBegin)(struct ServiceConnectBeginArgs &args)

Um callback de aplicativo feito imediatamente antes do estabelecimento da conexão.

Esse callback pode ser usado por aplicativos para observar e, opcionalmente, alterar os argumentos transmitidos para #WeaveConnection::Connect() durante o estabelecimento de uma conexão de serviço. Esse callback será chamado para a conexão com o endpoint do serviço de destino e para a conexão com o endpoint do Diretório de serviços caso seja necessário realizar uma pesquisa de diretório.

OnServiceEndpointQueryBegin

void(* OnServiceEndpointQueryBegin)(void)

Um callback de aplicativo para marcar o horário de uma consulta de saída do diretório de serviços.

Isso é chamado quando estamos prestes a enviar a solicitação de consulta do endpoint do serviço. Ele é usado para corresponder a OnServiceEndpointQueryEnd para compensar o tempo de transmissão da mensagem.

OnServiceEndpointQueryEndWithTimeInfo

void(* OnServiceEndpointQueryEndWithTimeInfo)(uint64_t timeQueryReceiptMsec, uint32_t timeProcessMsec)

Um callback de aplicativo para fornecer valores de tempo de uma resposta do diretório de serviços.

Isso é chamado quando recebemos informações de tempo da resposta da consulta do diretório de serviços. Esse callback só vai acontecer se uma resposta for analisada e as informações de tempo forem incluídas.

Detalhes
Parâmetros
[in] timeQueryReceiptMsec
O número de ms desde a época POSIX, quando a consulta foi recebida no lado do servidor.
[in] timeProcessMsec
O número de ms gastos no processamento desta consulta.

RootDirectoryAccessor

WEAVE_ERROR(* RootDirectoryAccessor)(uint8_t *aDirectory, uint16_t aLength)

Uma função de acesso às informações do diretório raiz.

Você precisa começar em algum lugar, e com o diretório de serviços, você precisa começar com um diretório stub que contenha o endereço de um servidor que possa ser acessado para acessar tudo o mais. Como a disposição e a procedência dessas informações provavelmente variam de acordo com o dispositivo, fornecemos um callback de acessador aqui.

Detalhes
Parâmetros
[out] aDirectory
Um ponteiro para um buffer para gravar as informações do diretório.
[in] aLength
O comprimento do buffer fornecido em bytes.
Retornos
WEAVE_NO_ERROR em caso de sucesso. Caso contrário, o processo de carregamento seria cancelado.

StatusHandler

void(* StatusHandler)(void *anAppState, WEAVE_ERROR anError, StatusReport *aStatusReport)

Um gerenciador para condições de erro e status.

Um usuário do gerenciador de serviços pode ser informado sobre problemas ao tentar executar uma solicitação de conexão de duas maneiras. Ele pode receber um relatório de status do serviço ou um WEAVE_ERROR gerado internamente. Em ambos os casos, as informações são enviadas por esse callback.

Detalhes
Parâmetros
[in] anAppState
Um ponteiro para um objeto de aplicativo transmitido para a chamada conect() correspondente.
[in] anError
Um código de erro do Weave indicando que ocorreu um erro ao tentar executar a solicitação de conexão. Ele deverá ser WEAVE_NO_ERROR caso não tenha surgido nenhum erro e um relatório de status esteja disponível.
[in] aStatusReport
Um ponteiro para um relatório de status gerado pelo serviço de diretório remoto. Esse argumento será NULL no caso em que não houver um relatório de status e um erro interno for transmitido no argumento anterior.

Funções públicas

SetConnectBeginCallback

void SetConnectBeginCallback(
  OnConnectBegin aConnectBegin
)

Define uma função de callback a ser chamada imediatamente antes do estabelecimento da conexão.

Detalhes
Parâmetros
[in] aConnectBegin
Um ponteiro para a função de callback. Um valor NULL desativa o callback.

WeaveServiceManager

 WeaveServiceManager(
  void
)

Esse método inicializa a instância WeaveServiceManager.

init() precisa ser chamado para inicializar essa instância.

cancelar

void cancel(
  uint64_t aServiceEp,
  void *aAppState
)

Esse método cancela uma solicitação de conexão.

Esse método cancela uma solicitação de conexão considerando o ID do endpoint do serviço e o objeto de estado do aplicativo transmitido no momento da solicitação como identificadores. Se for a última solicitação de conexão, esse método também vai limpar qualquer estado de conexão de diretório de serviço pendente.

Detalhes
Parâmetros
[in] aServiceEp
O ID do endpoint de serviço da solicitação que está sendo cancelada.
[in] anAppState
Um ponteiro para o objeto de estado do app fornecido à chamada connect().

clearCache

void clearCache(
  void
)

Esse método limpará o estado e o cache do gerenciador se ele estiver no estado terminal kServiceMgrState_Resolved, o que significa que a resposta do endpoint do Diretório de serviços foi recebida.

conectar

WEAVE_ERROR connect(
  uint64_t aServiceEp,
  WeaveAuthMode aAuthMode,
  void *aAppState,
  StatusHandler aStatusHandler,
  WeaveConnection::ConnectionCompleteFunct aConnectionCompleteHandler,
  const uint32_t aConnectTimeoutMsecs,
  const InterfaceId aConnectIntf
)

As solicitações desse método se conectam a um serviço do Weave.

Esta é a chamada de conexão de nível superior. Ele basicamente produz uma conexão segura com o serviço Weave, considerando um endpoint de serviço e um modo de autenticação, ou falha na tentativa.

Esse método só pode ser chamado após uma chamada bem-sucedida para init(), e uma solicitação de conexão pode ser cancelada por cancel().

Esse método pode ser chamado antes que o cache local seja preenchido com dados provisionados por padrão ou uma viagem ao serviço de diretório. O gerenciador de serviços apenas enfileira a solicitação antes que o conteúdo do cache possa ser determinado.

Detalhes
Parâmetros
[in] aServiceEp
O identificador do endpoint do serviço, conforme definido em ServiceDirectory.h, para o serviço de interesse.
[in] aAuthMode
O modo de autenticação a ser usado ao se conectar ao serviço de interesse.
[in] aAppState
Um ponteiro para um objeto de estado do aplicativo, transmitido aos callbacks como um argumento.
[in] aStatusHandler
Um callback para invocar no caso de um erro que ocorra antes da conclusão da conexão.
[in] aConnectionCompleteHandler
Um callback para invocar no caso em que a conexão solicitada for concluída. Observe que a conexão pode falhar com um código de erro do Weave.
[in] aConnectTimeoutMsecs
O tempo limite de conexão TCP opcional em milissegundos.
[in] aConnectIntf
A interface opcional em que a conexão será estabelecida.
Retornos
WEAVE_NO_ERROR em caso de sucesso. Caso contrário, um código de erro correspondente.

init

WEAVE_ERROR init(
  WeaveExchangeManager *aExchangeMgr,
  uint8_t *aCache,
  uint16_t aCacheLen,
  RootDirectoryAccessor aAccessor,
  WeaveAuthMode aDirAuthMode,
  OnServiceEndpointQueryBegin aServiceEndpointQueryBegin,
  OnServiceEndpointQueryEndWithTimeInfo aServiceEndpointQueryEndWithTimeInfo,
  OnConnectBegin aConnectBegin
)

Esse método inicializa o objeto do gerenciador de serviços.

Para ser usado, é necessário inicializar um objeto do gerenciador de serviços. Após uma chamada bem-sucedida para esse método, os clientes podem começar a chamar connect(), lookup() e outros métodos.

Detalhes
Parâmetros
[in] aExchangeMgr
Um ponteiro para o gerenciador de trocas a ser usado em todas as trocas de perfis do diretório de serviços.
[in] aCache
Um ponteiro para um buffer que pode ser usado para armazenar em cache informações de diretório.
[in] aCacheLen
O tamanho em bytes do cache.
[in] aAccessor
O callback, conforme definido em ServiceDirectory.h, para invocar e carregar o diretório raiz como ponto de partida para a pesquisa de diretórios.
[in] aDirAuthMode
O modo de autenticação a ser usado ao se comunicar com o serviço de diretório.
[in] aServiceEndpointQueryBegin
Um ponteiro de função do tipo OnServiceEndpointQueryBegin que é chamado no início de uma solicitação de diretório de serviço e permite que o código do aplicativo marque o horário se quiser usar a sincronização de tempo oferecida pelo protocolo do diretório de serviço.
[in] aServiceEndpointQueryEndWithTimeInfo
Um ponteiro de função do tipo OnServiceEndpointQueryEndWithTimeInfo, que é chamado ao receber um diretório de serviço que permite que os aplicativos sejam sincronizados com o serviço Weave usando os campos de tempo fornecidos na resposta. Esse callback seria feito depois que o gerenciador de serviços recebesse uma resposta com informações de tempo. O cache já deve ter sido preenchido com sucesso antes que o callback seja feito.
[in] aConnectBegin
Um ponteiro de função do tipo OnConnectBegin, que é chamado imediatamente antes do estabelecimento da conexão e permite que os aplicativos observem e, opcionalmente, alterem os argumentos transmitidos para #WeaveConnection::Connect(). Um valor NULL (padrão) desativa o callback.
Retornos
WEAVE_ERROR_INVALID_ARGUMENT se um argumento de função for inválido. Caso contrário, WEAVE_NO_ERROR.

lookup

WEAVE_ERROR lookup(
  uint64_t aServiceEp,
  HostPortList *outHostPortList
)

Esse método procura informações de diretório para um endpoint de serviço.

Se o diretório de serviço tiver sido resolvido, ou seja, se uma operação connect() tiver sido concluída, esse método vai preencher o objeto HostPortList fornecido.

Observação: a HostPortList está vinculada ao objeto WeaveServiceManager. ele permanece válido até que o cache do diretório de serviços seja apagado ou até que outra pesquisa do diretório de serviços ocorra.

Detalhes
Parâmetros
[in] aServiceEp
O identificador do endpoint do serviço a ser procurado.
[out] outHostPortList
O ponteiro para HostPortList que será preenchido em uma pesquisa bem-sucedida da entrada de diretório. Não pode ser nulo.
Valores de retorno
WEAVE_NO_ERROR
em caso de sucesso. Caso contrário, um código de erro será retornado.
WEAVE_ERROR_INVALID_SERVICE_EP
se o endpoint de serviço fornecido não for encontrado.
WEAVE_ERROR_INVALID_DIRECTORY_ENTRY_TYPE
se o diretório contiver um tipo de entrada de diretório desconhecido.

lookup

WEAVE_ERROR lookup(
  uint64_t aServiceEp,
  uint8_t *aControlByte,
  uint8_t **aDirectoryEntry
)

Esse método procura informações de diretório para um endpoint de serviço.

Se o diretório de serviços tiver sido resolvido, ou seja, se houver uma operação connect() bem-sucedida, esse método retornará uma entrada de diretório considerando um identificador de endpoint de serviço.

Esse método expõe os detalhes da implementação interna do diretório de serviços. As implementações devem favorecer o uso da variante desse método que gera a HostPortList.

Detalhes
Parâmetros
[in] aServiceEp
O identificador do endpoint do serviço a ser pesquisado.
[out] aControlByte
Um ponteiro para o local onde gravar o byte de controle de entrada do diretório.
[out] aDirectoryEntry
Um ponteiro-ponteiro para ser direcionado à entrada do diretório.
Valores de retorno
WEAVE_NO_ERROR
em caso de sucesso. Caso contrário, um código de erro será retornado.
WEAVE_ERROR_INVALID_SERVICE_EP
se o endpoint de serviço fornecido não for encontrado.
WEAVE_ERROR_INVALID_DIRECTORY_ENTRY_TYPE
se o diretório contiver um tipo de entrada de diretório desconhecido.

onConnectionClosed

void onConnectionClosed(
  WEAVE_ERROR aError
)

Esse método lida com o evento de conexão fechado informado pelo contexto de troca do Weave associado.

Detalhes
Parâmetros
[in] aError
Um erro do Weave indicando o motivo do encerramento da conexão.

onConnectionComplete

void onConnectionComplete(
  WEAVE_ERROR aError
)

Esse método lida com o evento de conexão concluída para a transação de consulta do endpoint de serviço.

Há algumas possibilidades. Primeiro, a conexão pode ter falhado. Nesse caso, terminamos. Caso contrário, a conexão estará completa e queremos abrir um contexto de troca e enviar uma consulta de diretório.

Detalhes
Parâmetros
[in] aError
Um erro do Weave se houver algum erro durante a configuração da conexão.

onResponseReceived

void onResponseReceived(
  uint32_t aProfileId,
  uint8_t aMsgType,
  PacketBuffer *aMsg
)

Esse método lida com qualquer mensagem de resposta na conversa com o serviço de diretório.

Detalhes
Parâmetros
[in] aProfileId
O ID do perfil dessa mensagem recebida.
[in] aMsgType
O tipo específico de perfil para esta mensagem.
[in] aMsg
O conteúdo desta mensagem.

onResponseTimeout

void onResponseTimeout(
  void
)

Esse método processa o evento de tempo limite, em que nenhuma resposta foi recebida do serviço de diretório.

se mudar

void relocate(
  WEAVE_ERROR aError
)

Esse método realoca o cache do diretório de serviços.

Quando um endpoint de serviço retorna um relatório de status com o código de status kStatus_Relocations, o aplicativo pode chamar unresolve() para limpar o cache e cancelar solicitações de conexão. Esse método simplifica o tratamento de erros chamando unresolve() na primeira vez e reset() quando o problema ainda não foi resolvido.

Essa versão do método, aqui para compatibilidade com versões anteriores, registra um erro e chama relocate(void).

Detalhes
Parâmetros
[in] aError
um erro a ser registrado.
Confira também:
relocate(void)

transferir

void relocate(
  void
)

Esse método realoca o cache do diretório de serviços.

Quando um endpoint de serviço retorna um relatório de status com o código kStatus_Relocated, o aplicativo pode chamar unresolve() para limpar o cache e cancelar as solicitações de conexão. Esse método simplifica o processamento de erros chamando unresolve() na primeira vez e reset() se o problema ainda não tiver sido resolvido.

Consulte também:
relocate(WEAVE_ERROR)

replaceOrAddCacheEntry

WEAVE_ERROR replaceOrAddCacheEntry(
  uint16_t port,
  const char *hostName,
  uint8_t hostLen,
  uint64_t serviceEndpointId
)

Adicione a entrada de diretório de substituição de um nome de host e um ID de porta no início da lista de diretórios.

redefinir

void reset(
  WEAVE_ERROR aError
)

Esse método redefine o gerenciador de serviços para o estado inicial.

Este método redefine todos os estados do gerenciador de serviços, incluindo o estado das comunicações, o estado do cache e o estado de quaisquer solicitações de conexão pendentes.

Essa versão do método, aqui para compatibilidade com versões anteriores, registra um erro e chama reset(void).

Detalhes
Parâmetros
[in] aError
O erro que acionou esta operação.
Consulte também:
reset(void)

redefinir

void reset(
  void
)

Esse método redefine o gerenciador de serviços para o estado inicial.

Esse método redefine todos os estados do gerenciador de serviços, incluindo o estado de comunicações, de cache e de todas as solicitações de conexão pendentes.

Consulte também:
reset(WEAVE_ERROR)

unresolve

void unresolve(
  WEAVE_ERROR aError
)

Esse método invalida o cache do diretório de serviços.

Esse método define o estado do cache do diretório de serviços para que, na próxima solicitação, o gerenciador de serviços emita uma consulta do diretório de serviços.

Essa versão do método, aqui para compatibilidade com versões anteriores, registra um erro e chama unresolve(void).

Detalhes
Parâmetros
[in] aError
O erro que acionou essa operação.
Confira também:
unresolve(void)

não resolvido

void unresolve(
  void
)

Esse método invalida o cache do diretório de serviços.

Esse método define o estado do cache do diretório de serviços para que, na próxima solicitação, o gerenciador de serviços emita uma consulta do diretório de serviços.

Consulte também:
unresolve(WEAVE_ERROR)

~WeaveServiceManager

 ~WeaveServiceManager(
  void
)

Este método destrói a instância WeaveServiceManager.