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

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

El objeto administrador del directorio de servicios de Weave.

Resumen

El administrador de servicios de Weave es la interfaz principal de las aplicaciones al servicio de directorio. Así, oculta las complicaciones inherentes a la búsqueda de la entrada del directorio asociada con un extremo de servicio, realizar búsquedas de DNS en uno o más nombres de host que se encuentran allí, intentar conectarse, proteger la conexión, etc. También puede administrar una caché de información del directorio de servicios.

Constructores y destructores
WeaveServiceManager(void)
Este método inicializa la instancia WeaveServiceManager.
~WeaveServiceManager(void)
Este método destruye la instancia WeaveServiceManager.

Tipos públicos
@303{
  kWeave_DefaultSendTimeout = 15000
} 		enum
OnConnectBegin)(struct ServiceConnectBeginArgs &args) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::OnConnectBegin
void(*
Una devolución de llamada a la aplicación realizada inmediatamente antes del establecimiento de la conexión.
OnServiceEndpointQueryBegin)(void) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::OnServiceEndpointQueryBegin
void(*
Una devolución de llamada de la aplicación para marcar la hora de una consulta saliente del directorio de servicios.
OnServiceEndpointQueryEndWithTimeInfo)(uint64_t timeQueryReceiptMsec, uint32_t timeProcessMsec) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::OnServiceEndpointQueryEndWithTimeInfo
void(*
Una devolución de llamada de la aplicación para entregar valores de tiempo desde una respuesta del directorio de servicios.
RootDirectoryAccessor)(uint8_t *aDirectory, uint16_t aLength) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::RootDirectoryAccessor
Una función de descriptor de acceso para la información del directorio raíz.
StatusHandler)(void *anAppState, WEAVE_ERROR anError, StatusReport *aStatusReport) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::StatusHandler
void(*
Un controlador para las condiciones de error y estado.

Funciones públicas
SetConnectBeginCallback(OnConnectBegin aConnectBegin)
void
Configura una función de devolución de llamada para que se llame inmediatamente antes del establecimiento de la conexión.
cancel(uint64_t aServiceEp, void *aAppState)
void
Este método cancela una solicitud de conexión.
clearCache(void)
void
Este método borra el estado y la caché del administrador si se encuentra en el estado kServiceMgrState_Resolved de la terminal, lo que significa que se recibió la respuesta del extremo del Directorio de servicios.
connect(uint64_t aServiceEp, WeaveAuthMode aAuthMode, void *aAppState, StatusHandler aStatusHandler, WeaveConnection::ConnectionCompleteFunct aConnectionCompleteHandler, const uint32_t aConnectTimeoutMsecs, const InterfaceId aConnectIntf)
Este método solicita conectarse a un servicio de Weave.
init(WeaveExchangeManager *aExchangeMgr, uint8_t *aCache, uint16_t aCacheLen, RootDirectoryAccessor aAccessor, WeaveAuthMode aDirAuthMode, OnServiceEndpointQueryBegin aServiceEndpointQueryBegin, OnServiceEndpointQueryEndWithTimeInfo aServiceEndpointQueryEndWithTimeInfo, OnConnectBegin aConnectBegin)
Este método inicializa el objeto del administrador de servicios.
lookup(uint64_t aServiceEp, HostPortList *outHostPortList)
Este método busca información de directorio de un extremo de servicio.
lookup(uint64_t aServiceEp, uint8_t *aControlByte, uint8_t **aDirectoryEntry)
Este método busca información de directorio de un extremo de servicio.
onConnectionClosed(WEAVE_ERROR aError)
void
Este método controla el evento de conexión cerrada que informa el contexto de intercambio de Weave asociado.
onConnectionComplete(WEAVE_ERROR aError)
void
Este método controla el evento de conexión completada para la transacción de consulta del extremo del servicio.
onResponseReceived(uint32_t aProfileId, uint8_t aMsgType, PacketBuffer *aMsg)
void
Este método controla cualquier mensaje de respuesta en la conversación con el servicio de directorio.
onResponseTimeout(void)
void
Este método controla el evento de tiempo de espera, en el que no se recibió ninguna respuesta del servicio de directorio.
relocate(WEAVE_ERROR aError)
void
Con este método, se reubica la caché del directorio de servicios.
relocate(void)
void
Con este método, se reubica la caché del directorio de servicios.
replaceOrAddCacheEntry(uint16_t port, const char *hostName, uint8_t hostLen, uint64_t serviceEndpointId)
Agrega la entrada de directorio anulada de un nombre de host y un ID de puerto al comienzo de la lista de directorios.
reset(WEAVE_ERROR aError)
void
Este método restablece el administrador de servicios a su estado inicial.
reset(void)
void
Este método restablece el administrador de servicios a su estado inicial.
unresolve(WEAVE_ERROR aError)
void
Este método invalida la caché del directorio de servicios.
unresolve(void)
void
Este método invalida la caché del directorio de servicios.

Clases
nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::ConnectRequest

Esta clase representa una sola transacción administrada por el administrador de servicios.

Tipos públicos

@303

 @303
Propiedades
kWeave_DefaultSendTimeout

Es la cantidad de milisegundos que se debe recibir una respuesta para la consulta del directorio antes de que se agote el tiempo de espera del contexto de intercambio.

OnConnectBegin

void(* OnConnectBegin)(struct ServiceConnectBeginArgs &args)

Una devolución de llamada a la aplicación realizada inmediatamente antes del establecimiento de la conexión.

Las aplicaciones pueden usar esta devolución de llamada para observar y, opcionalmente, modificar los argumentos pasados a #WeaveConnection::Connect() durante el proceso de establecimiento de una conexión de servicio. Se llamará a esta devolución de llamada para la conexión al extremo del servicio de destino y la conexión con el extremo del Directorio de servicios en caso de que se deba realizar una búsqueda en el directorio.

OnServiceEndpointQueryBegin

void(* OnServiceEndpointQueryBegin)(void)

Una devolución de llamada de la aplicación para marcar la hora de una consulta saliente del directorio de servicios.

Se llama a este método cuando estamos a punto de enviar una solicitud de consulta del extremo del servicio. Esto se usa para coincidir con OnServiceEndpointQueryEnd a fin de compensar el tiempo de vuelo del mensaje.

OnServiceEndpointQueryEndWithTimeInfo

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

Una devolución de llamada de la aplicación para entregar valores de tiempo desde una respuesta del directorio de servicios.

Se llama a este método cuando obtenemos información de tiempo de la respuesta de la consulta del directorio de servicios. Ten en cuenta que esta devolución de llamada solo se realizará si una respuesta se analiza correctamente y se incluye información de tiempo.

Detalles
Parámetros
[in] timeQueryReceiptMsec
La cantidad de ms desde el ciclo de entrenamiento POSIX, cuando la consulta se recibió en el servidor.
[in] timeProcessMsec
La cantidad de ms dedicados al procesamiento de esta consulta.

RootDirectoryAccessor

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

Una función de descriptor de acceso para la información del directorio raíz.

Debes empezar en algún lugar y con el directorio de servicio debes comenzar con un directorio stub que contiene la dirección de un servidor al que puedas acceder para todo lo demás. Debido a que la disposición y el origen de esta información probablemente varíen de un dispositivo a otro, proporcionamos una devolución de llamada de descriptor de acceso aquí.

Detalles
Parámetros
[out] aDirectory
Un puntero a un búfer para escribir la información del directorio.
[in] aLength
Es la longitud, expresada en bytes, del búfer determinado.
Qué muestra
WEAVE_NO_ERROR si la operación fue exitosa; de lo contrario, el proceso de carga se anularía.

StatusHandler

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

Un controlador para las condiciones de error y estado.

Un usuario del administrador del servicio puede ser informado de los problemas al intentar ejecutar una solicitud de conexión de una de dos maneras. Puede recibir un informe de estado del servicio o un WEAVE_ERROR generado internamente. En cualquier caso, la información se obtiene mediante esta devolución de llamada.

Detalles
Parámetros
[in] anAppState
Un puntero a un objeto de la aplicación que se pasó a la llamada de conect() correspondiente.
[in] anError
Código de error de Weave que indica que se produjo un error durante el proceso de ejecución de la solicitud de conexión. El valor debe ser WEAVE_NO_ERROR para los casos en que no haya surgido ningún error y haya un informe de estado disponible.
[in] aStatusReport
Un puntero para un informe de estado generado por el servicio de directorio remoto. Este argumento será NULL en el caso de que no haya un informe de estado y se pase un error interno en el argumento anterior.

Funciones públicas

SetConnectBeginCallback

void SetConnectBeginCallback(
  OnConnectBegin aConnectBegin
)

Configura una función de devolución de llamada para que se llame inmediatamente antes del establecimiento de la conexión.

Detalles
Parámetros
[in] aConnectBegin
Un puntero para la función de devolución de llamada. Si el valor es NULL, se inhabilita la devolución de llamada.

WeaveServiceManager

 WeaveServiceManager(
  void
)

Este método inicializa la instancia WeaveServiceManager.

Ten en cuenta que se debe llamar a init() para inicializar aún más esta instancia.

cancelar

void cancel(
  uint64_t aServiceEp,
  void *aAppState
)

Este método cancela una solicitud de conexión.

Este método cancela una solicitud de conexión a partir del ID del extremo del servicio y el objeto de estado de la aplicación que se pasó en el momento de la solicitud como identificadores. Si es la última solicitud de conexión, este método también borra cualquier estado de conexión pendiente del directorio de servicios.

Detalles
Parámetros
[in] aServiceEp
El ID del extremo del servicio de la solicitud que se cancelará.
[in] anAppState
Un puntero para el objeto de estado de la app asignado a la llamada connect().

clearCache

void clearCache(
  void
)

Este método borra el estado y la caché del administrador si se encuentra en el estado kServiceMgrState_Resolved de la terminal, lo que significa que se recibió la respuesta del extremo del Directorio de servicios.

connect

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

Este método solicita conectarse a un servicio de Weave.

Esta es la llamada de conexión de nivel superior. Básicamente, produce una conexión segura al servicio de Weave con un extremo de servicio y un modo de autenticación, o bloques que lo prueban.

Solo se puede llamar a este método después de realizar una llamada exitosa a init(), y es posible que cancel() cancele una solicitud de conexión.

Se puede llamar a este método antes de que la caché local se llene con datos de los datos aprovisionados predeterminados o de un viaje al servicio de directorio. El administrador de servicios coloca la solicitud en cola antes de que se pueda determinar el contenido de la caché.

Detalles
Parámetros
[in] aServiceEp
El identificador de extremo del servicio, como se define en ServiceDirectory.h, para el servicio en cuestión.
[in] aAuthMode
El modo de autenticación que se debe usar cuando te conectas al servicio en cuestión.
[in] aAppState
Un puntero a un objeto de estado de la aplicación, que se pasa a las devoluciones de llamada como argumento.
[in] aStatusHandler
Es una devolución de llamada para invocar en caso de que ocurra un error antes de que se complete la conexión.
[in] aConnectionCompleteHandler
Una devolución de llamada para invocar en caso de que se complete la conexión solicitada. Ten en cuenta que la conexión puede fallar con un código de error de Weave.
[in] aConnectTimeoutMsecs
El tiempo de espera opcional de la conexión TCP en milisegundos.
[in] aConnectIntf
La interfaz opcional a través de la que se establecerá la conexión.
Qué muestra
WEAVE_NO_ERROR si la operación es exitosa; de lo contrario, se muestra un código de error correspondiente.

init

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

Este método inicializa el objeto del administrador de servicios.

Para usarlo, se debe inicializar un objeto del administrador de servicios. Después de realizar una llamada exitosa a este método, los clientes pueden comenzar a llamar a connect(), lookup() y otros métodos.

Detalles
Parámetros
[in] aExchangeMgr
Un puntero al administrador de Exchange que se usa para todos los intercambios de perfiles del directorio de servicios.
[in] aCache
Un puntero para un búfer que se puede usar para almacenar en caché la información del directorio.
[in] aCacheLen
La longitud de la caché en bytes.
[in] aAccessor
Es la devolución de llamada, como se define en ServiceDirectory.h, que se invocará para cargar el directorio raíz como punto de partida para la búsqueda del directorio.
[in] aDirAuthMode
El modo de autenticación que se usa cuando se comunica con el servicio de directorio.
[in] aServiceEndpointQueryBegin
Un puntero de función de tipo OnServiceEndpointQueryBegin, al que se llama al inicio de una solicitud de directorio de servicios y permite que el código de la aplicación marque la hora si desea usar la sincronización de hora que ofrece el protocolo del directorio de servicios.
[in] aServiceEndpointQueryEndWithTimeInfo
Un puntero de función de tipo OnServiceEndpointQueryEndWithTimeInfo, al que se llama cuando se recibe un directorio de servicio que permite que las aplicaciones se sincronicen con el servicio de Weave mediante los campos de tiempo que se proporcionan en la respuesta. Esta devolución de llamada se realizará después de que el administrador del servicio reciba una respuesta con información de tiempo. La caché ya debería completarse con éxito antes de que se realice la devolución de llamada.
[in] aConnectBegin
Un puntero de función de tipo OnConnectBegin, al que se llama inmediatamente antes del establecimiento de la conexión y que permite que las aplicaciones observen y alteren, de manera opcional, los argumentos que se pasaron a #WeaveConnection::Connect(). Un valor NULL (el valor predeterminado) inhabilita la devolución de llamada.
Qué muestra
WEAVE_ERROR_INVALID_ARGUMENT si el argumento de una función no es válido; de lo contrario, WEAVE_NO_ERROR.

lookup

WEAVE_ERROR lookup(
  uint64_t aServiceEp,
  HostPortList *outHostPortList
)

Este método busca información de directorio de un extremo de servicio.

Si se resolvió el directorio de servicio, es decir, si se realizó una operación connect() correcta, este método propagará el objeto HostPortList proporcionado.

Nota: HostPortList está vinculado al objeto WeaveServiceManager; sigue siendo válido hasta que se borre la caché del directorio de servicios o hasta que se realice otra búsqueda en el directorio de servicios.

Detalles
Parámetros
[in] aServiceEp
Es el identificador del extremo de servicio que se buscará.
[out] outHostPortList
El puntero a HostPortList que se propagará cuando se realice correctamente la búsqueda de la entrada del directorio. No debe ser NULO.
Valores que se muestran
WEAVE_NO_ERROR
en caso de éxito; de lo contrario, un código de error respectivo.
WEAVE_ERROR_INVALID_SERVICE_EP
si no se encuentra el extremo de servicio dado.
WEAVE_ERROR_INVALID_DIRECTORY_ENTRY_TYPE
si el directorio contiene un tipo de entrada de directorio desconocido.

lookup

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

Este método busca información de directorio de un extremo de servicio.

Si se resolvió el directorio de servicios, es decir, si la operación connect() se realizó correctamente, este método mostrará una entrada de directorio con un identificador de extremo del servicio.

Este método expone los detalles de la implementación interna del directorio de servicio. Las implementaciones deben favorecer el uso de la variante de este método que genera la HostPortList.

Detalles
Parámetros
[in] aServiceEp
Es el identificador del extremo de servicio que se buscará.
[out] aControlByte
Un puntero al lugar para escribir el byte de control de entrada del directorio.
[out] aDirectoryEntry
Un puntero que se dirigirá a la entrada del directorio.
Valores que se muestran
WEAVE_NO_ERROR
en caso de éxito; de lo contrario, un código de error respectivo.
WEAVE_ERROR_INVALID_SERVICE_EP
si no se encuentra el extremo de servicio dado.
WEAVE_ERROR_INVALID_DIRECTORY_ENTRY_TYPE
si el directorio contiene un tipo de entrada de directorio desconocido.

onConnectionClosed

void onConnectionClosed(
  WEAVE_ERROR aError
)

Este método controla el evento de conexión cerrada que informa el contexto de intercambio de Weave asociado.

Detalles
Parámetros
[in] aError
Un error de Weave que indica el motivo por el que se cierra esta conexión.

onConnectionComplete

void onConnectionComplete(
  WEAVE_ERROR aError
)

Este método controla el evento de conexión completada para la transacción de consulta del extremo del servicio.

Hay un par de posibilidades. En primer lugar, es posible que la conexión haya fallado. En ese caso, ya terminamos. De lo contrario, la conexión está completa y lo que queremos hacer es abrir un contexto de intercambio y enviar una consulta de directorio.

Detalles
Parámetros
[in] aError
Se mostrará un error de Weave si se produce algún error durante la configuración de la conexión.

onResponseReceived

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

Este método controla cualquier mensaje de respuesta en la conversación con el servicio de directorio.

Detalles
Parámetros
[in] aProfileId
El ID de perfil de este mensaje entrante.
[in] aMsgType
El tipo específico de perfil para este mensaje.
[in] aMsg
El contenido de este mensaje.

onResponseTimeout

void onResponseTimeout(
  void
)

Este método controla el evento de tiempo de espera, en el que no se recibió ninguna respuesta del servicio de directorio.

reubicar

void relocate(
  WEAVE_ERROR aError
)

Con este método, se reubica la caché del directorio de servicios.

Cuando un extremo de servicio muestra un informe de estado con el código de estado kStatus_Reassigned, la aplicación puede llamar a unresolve() para borrar la caché y cancelar las solicitudes de conexión. Este método simplifica el manejo de errores llamando a unresolve() la primera vez y a reset() si el problema aún no se resolvió.

Esta versión del método (aquí para la retrocompatibilidad) toma y registra un error y, luego, llama a relocate(void) .

Detalles
Parámetros
[in] aError
que se registre un error.
Consulta también:
relocate(void)

reubicar

void relocate(
  void
)

Con este método, se reubica la caché del directorio de servicios.

Cuando un extremo de servicio muestra un informe de estado con el código de estado kStatus_Reassigned, la aplicación puede llamar a unresolve() para borrar la caché y cancelar las solicitudes de conexión. Este método simplifica el manejo de errores llamando a unresolve() la primera vez y a reset() si el problema aún no se resolvió.

Consulta también:
relocate(WEAVE_ERROR)

replaceOrAddCacheEntry

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

Agrega la entrada de directorio anulada de un nombre de host y un ID de puerto al comienzo de la lista de directorios.

restablecer

void reset(
  WEAVE_ERROR aError
)

Este método restablece el administrador de servicios a su estado inicial.

Este método restablece todos los estados del administrador de servicios, incluidos el estado de comunicaciones, el estado de caché y el estado de cualquier solicitud de conexión pendiente.

Esta versión del método (aquí para la retrocompatibilidad) toma y registra un error y, luego, llama a reset(void) .

Detalles
Parámetros
[in] aError
El error que activó esta operación.
Consulta también:
reset(void)

restablecer

void reset(
  void
)

Este método restablece el administrador de servicios a su estado inicial.

Este método restablece todos los estados del administrador de servicios, incluidos el estado de comunicaciones, el de caché y el de cualquier solicitud de conexión pendiente.

Consulta también:
reset(WEAVE_ERROR)

no resolver

void unresolve(
  WEAVE_ERROR aError
)

Este método invalida la caché del directorio de servicios.

Este método establece el estado de caché del directorio de servicios para que, en la próxima solicitud, el administrador de servicios emita una consulta en el directorio de servicios.

Esta versión del método (aquí para la retrocompatibilidad) toma y registra un error y, luego, llama a unresolve(void) .

Detalles
Parámetros
[in] aError
El error que activó esta operación.
Consulta también:
unresolve(void)

no resolver

void unresolve(
  void
)

Este método invalida la caché del directorio de servicios.

Este método establece el estado de caché del directorio de servicios para que, en la próxima solicitud, el administrador de servicios emita una consulta en el directorio de servicios.

Consulta también:
unresolve(WEAVE_ERROR)

~WeaveServiceManager

 ~WeaveServiceManager(
  void
)

Este método destruye la instancia WeaveServiceManager.