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

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

El objeto de 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. Como tal, oculta las complicaciones inherentes a la búsqueda de la entrada del directorio asociada con un extremo del servicio, realizar una búsqueda de DNS en uno o más de los nombres de host que se encuentran allí, intentar conectarse, proteger la conexión, etcétera. 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 de 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 el tiempo 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 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 a la que se debe llamar 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 el estado se encuentra en el estado terminal kServiceMgrState_Resolved, 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 para un extremo de servicio.
lookup(uint64_t aServiceEp, uint8_t *aControlByte, uint8_t **aDirectoryEntry)
Este método busca información de directorio para un extremo de servicio.
onConnectionClosed(WEAVE_ERROR aError)
void
Este método controla el evento de cierre de conexión informado por 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 de 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ó respuesta del servicio de directorio.
relocate(WEAVE_ERROR aError)
void
Este método reubica la caché del directorio de servicios.
relocate(void)
void
Este método 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 de anulación 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 de aplicación realizada inmediatamente antes del establecimiento de la conexión.

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

OnServiceEndpointQueryBegin

void(* OnServiceEndpointQueryBegin)(void)

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

Se llama a este método cuando estamos por enviar una solicitud de consulta al extremo del servicio. Se usa para coincidir con OnServiceEndpointQueryEnd para 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 sobre la hora de la respuesta a la consulta del directorio de servicios. Ten en cuenta que esta devolución de llamada solo se produce si una respuesta se analiza correctamente y se incluye información sobre la hora.

Detalles
Parámetros
[in] timeQueryReceiptMsec
El número de ms desde el ciclo de entrenamiento POSIX, cuando se recibió la consulta 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 acceso para la información del directorio raíz.

Debes comenzar en algún lugar, y con el directorio de servicios debes comenzar con un directorio stub que contiene la dirección de un servidor al que puedes presionar para obtener todo lo demás. Debido a que es probable que la disposición y la procedencia de esta información varíen de un dispositivo a otro, proporcionamos una devolución de llamada del 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 del búfer determinado en bytes.
Resultado que se muestra
WEAVE_NO_ERROR si se ejecuta de forma correcta; de lo contrario, se anulará el proceso de carga.

StatusHandler

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

Un controlador para las condiciones de error y estado.

Se puede informar a un usuario del administrador de servicios sobre problemas cuando intenta ejecutar una solicitud de conexión de dos maneras. Puede recibir un informe de estado del servicio o un WEAVE_ERROR generado de forma interna. En cualquier caso, la información proviene de 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 conect() correspondiente.
[in] anError
Un código de error de Weave que indica que se produjo un error cuando se intentó ejecutar la solicitud de conexión. Debe ser WEAVE_NO_ERROR en caso de que no surgiera ningún error y de que haya un informe de estado disponible.
[in] aStatusReport
Un puntero a 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 a la que se debe llamar inmediatamente antes del establecimiento de la conexión.

Detalles
Parámetros
[in] aConnectBegin
Un puntero para la función de devolución de llamada. Un valor NULL 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 de extremo de 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
Es un puntero al objeto de estado de la app proporcionado a la llamada a connect().

clearCache

void clearCache(
  void
)

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

conectar

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 Connect de nivel superior. Básicamente, produce una conexión segura con el servicio de Weave si se proporciona un extremo de servicio y un modo de autenticación (o deja de intentarlo).

Solo se puede llamar a este método después de 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 proporcionados de forma predeterminada o de un viaje al servicio de directorio. El administrador de servicios solo pone en cola la solicitud antes de que se pueda determinar el contenido de la caché.

Detalles
Parámetros
[in] aServiceEp
Es el identificador de extremo del servicio, como se define en ServiceDirectory.h, para el servicio de interés.
[in] aAuthMode
El modo de autenticación que se usa cuando te conectas al servicio de interés.
[in] aAppState
Un puntero a un objeto de estado de la aplicación, que se pasa a las devoluciones de llamada como un argumento.
[in] aStatusHandler
Una devolución de llamada que se invocará en caso de que se produzca un error antes de que se complete la conexión.
[in] aConnectionCompleteHandler
Una devolución de llamada que se invocará en el caso en 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 se indica en milisegundos.
[in] aConnectIntf
La interfaz opcional sobre la que se debe establecer la conexión.
Resultado que se muestra
WEAVE_NO_ERROR si la operación se realizó correctamente; de lo contrario, un código de error respectivo.

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 usarse, se debe inicializar un objeto de administrador de servicios. Después de una llamada exitosa a este método, los clientes pueden comenzar a llamar a connect(), lookup() y a otros métodos.

Detalles
Parámetros
[in] aExchangeMgr
Un puntero al administrador de intercambios para usar en todos los intercambios de perfiles del directorio de servicios.
[in] aCache
Un puntero a 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
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 de directorios.
[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 del tipo OnServiceEndpointQueryBegin, 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 tiempo que ofrece el protocolo del directorio de servicios.
[in] aServiceEndpointQueryEndWithTimeInfo
Un puntero de función del tipo OnServiceEndpointQueryEndWithTimeInfo, que se llama cuando se recibe un directorio de servicios que permite que las aplicaciones se sincronicen con el servicio de Weave mediante los campos de tiempo proporcionados en la respuesta. Esta devolución de llamada se realiza después de que el administrador del servicio recibe una respuesta con información de hora. La caché debería completarse correctamente antes de realizar la devolución de llamada.
[in] aConnectBegin
Un puntero de función de tipo OnConnectBegin, que se llama inmediatamente antes del establecimiento de la conexión y permite que las aplicaciones observen y, de manera opcional, modifiquen los argumentos que se pasan a #WeaveConnection::Connect(). Si el valor es NULL (predeterminado), se inhabilitará la devolución de llamada.
Resultado que se 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 para un extremo de servicio.

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

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

Detalles
Parámetros
[in] aServiceEp
El identificador del extremo del servicio que se debe buscar.
[out] outHostPortList
El puntero a HostPortList que se propagará cuando se busque correctamente la entrada del directorio. No debe ser NULL.
Valores de retorno
WEAVE_NO_ERROR
en el éxito; de lo contrario, un código de error respectivo.
WEAVE_ERROR_INVALID_SERVICE_EP
si no se encuentra el extremo del servicio determinado.
WEAVE_ERROR_INVALID_DIRECTORY_ENTRY_TYPE
El directorio if 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 para un extremo de servicio.

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

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

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

onConnectionClosed

void onConnectionClosed(
  WEAVE_ERROR aError
)

Este método controla el evento de cierre de conexión informado por 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 de servicio.

Hay dos posibilidades. Primero, es posible que la conexión haya fallado, en cuyo caso ya estamos listos. De lo contrario, la conexión estará completa. Lo que queremos hacer es abrir un contexto de intercambio y enviar una consulta al directorio.

Detalles
Parámetros
[in] aError
Un error de Weave si hay 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 del 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ó respuesta del servicio de directorio.

reubicar

void relocate(
  WEAVE_ERROR aError
)

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

Cuando un extremo de servicio devuelve un informe de estado con el código de estado kStatus_Relocated, 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() por primera vez y a reset() si aún no se resolvió el problema.

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

Detalles
Parámetros
[in] aError
un error por registrar.
También:
relocate(void)

reubicar

void relocate(
  void
)

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

Cuando un extremo de servicio devuelve un informe de estado con el código de estado kStatus_Relocated, 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() por primera vez y a reset() si aún no se resolvió el problema.

También:
reubicar(WEAVE_ERROR)

replaceOrAddCacheEntry

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

Agrega la entrada de directorio de anulación 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 las comunicaciones, el de caché y el de cualquier solicitud de conexión pendiente.

Esta versión del método, en este caso 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.
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 las comunicaciones, el de caché y el de cualquier solicitud de conexión pendiente.

También:
restablecer(WEAVE_ERROR)

sin 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 del servicio emita una consulta del directorio.

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

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

sin 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 del servicio emita una consulta del directorio.

También:
unresolve(WEAVE_ERROR)

~WeaveServiceManager

 ~WeaveServiceManager(
  void
)

Este método destruye la instancia WeaveServiceManager.