nl::Weave::WeaveServerBase

#include <src/lib/core/WeaveServerBase.h>

Objeto de base común para implementar respondedores no solicitados (servidores) con perfil de Weave que encapsula la validación de solicitudes autenticadas y el envío de informes de estado, y proporciona almacenamiento común de los miembros de datos para el estado de la estructura y un administrador de intercambio.

Resumen

Herencia

método Subclassing:









nl::Weave::Profiles::DeviceControl::DeviceControlServernl::Weave::Profiles::DeviceDescription::DeviceDescriptionServernl::Weave::Profiles::Echo_Next::WeaveEchoServernl::Weave::Profiles::FabricProvisioning::FabricProvisioningServernl::Weave::Profiles::Heartbeat::WeaveHeartbeatReceivernl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServernl::Weave::Profiles::ServiceProvisioning::ServiceProvisioningServernl::Weave::Profiles::TokenPairing::TokenPairingServernl::Weave::Profiles::Vendor::Nestlabs::DropcamLegacyPairing::DropcamLegacyPairingServernl::Weave::Profiles::WeaveEchoServer

Atributos públicos

ExchangeMgr
[SOLO LECTURA] Objeto del administrador de Exchange
FabricState
[SOLO LECTURA] Objeto de estado de Fabric

Funciones estáticas públicas

SendStatusReport(ExchangeContext *ec, uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
Envía un informe de estado de Weave con marcas de mensaje predeterminadas al iniciador en el intercambio especificado que contenga el código de estado en el perfil especificado y el error del sistema.
SendStatusReport(ExchangeContext *ec, uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError, uint16_t sendFlags)
Envía un informe de estado de Weave con las marcas de mensaje proporcionadas al iniciador en el intercambio especificado, que contiene el código de estado en el perfil especificado y el error del sistema.

Funciones protegidas

EnforceAccessControl(ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, WeaveServerDelegateBase *delegate)
bool
Determina si se debe aceptar o descartar un mensaje de solicitud entrante a un servidor de Weave.
WeaveServerBase(void)

Atributos públicos

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[SOLO LECTURA] Objeto del administrador de Exchange

FabricState

WeaveFabricState * FabricState

[SOLO LECTURA] Objeto de estado de Fabric

Funciones estáticas públicas

SendStatusReport

WEAVE_ERROR SendStatusReport(
  ExchangeContext *ec,
  uint32_t statusProfileId,
  uint16_t statusCode,
  WEAVE_ERROR sysError
)

Envía un informe de estado de Weave con marcas de mensaje predeterminadas al iniciador en el intercambio especificado que contenga el código de estado en el perfil especificado y el error del sistema.

Detalles
Parámetros
[in] ec
Un puntero sobre el contexto de intercambio para enviar el informe de estado.
[in] statusProfileId
El perfil para el código de estado especificado.
[in] statusCode
El código de estado que se enviará.
[in] sysError
El error del sistema asociado o correlacionado con el código de estado.

SendStatusReport

WEAVE_ERROR SendStatusReport(
  ExchangeContext *ec,
  uint32_t statusProfileId,
  uint16_t statusCode,
  WEAVE_ERROR sysError,
  uint16_t sendFlags
)

Envía un informe de estado de Weave con las marcas de mensaje proporcionadas al iniciador en el intercambio especificado, que contiene el código de estado en el perfil especificado y el error del sistema.

Detalles
Parámetros
[in] ec
Un puntero sobre el contexto de intercambio para enviar el informe de estado.
[in] statusProfileId
El perfil para el código de estado especificado.
[in] statusCode
El código de estado que se enviará.
[in] sysError
El error del sistema asociado o correlacionado con el código de estado.
[in] sendFlags
Marcas establecidas por la aplicación para el informe de estado de Weave que se envía.

Funciones protegidas

EnforceAccessControl

bool EnforceAccessControl(
  ExchangeContext *ec,
  uint32_t msgProfileId,
  uint8_t msgType,
  const WeaveMessageInfo *msgInfo,
  WeaveServerDelegateBase *delegate
)

Determina si se debe aceptar o descartar un mensaje de solicitud entrante a un servidor de Weave.

Este método está diseñado para que lo usen las implementaciones del servidor de Weave a fin de implementar una política de control de acceso extensible para mensajes de solicitudes entrantes. Las implementaciones de servidor que dependen de objetos delegados deben llamar a este método al principio del procesamiento de mensajes para determinar si este debe continuar.

Este método llama al método virtual WeaveServerDelegateBase::EnforceAccessControl() en el delegado proporcionado para evaluar la política de control de acceso del mensaje. Las clases delegadas del servidor de Weave y los delegados específicos de la aplicación derivados de las clases de servidor estándar deben anular el método virtual para aplicar políticas de control de acceso específicas.

Detalles
Parámetros
[in] ec
Es el ExchangeContext mediante el cual se recibió el mensaje.
[in] msgProfileId
El ID de perfil del mensaje recibido.
[in] msgType
El tipo de mensaje recibido.
[in] msgInfo
Una estructura de WeaveMessageInfo que contiene información sobre el mensaje recibido.
[in] delegate
El objeto delegado que proporciona la aplicación y que se puede usar para anular la política de control de acceso a los mensajes predeterminada.
Valores que se muestran
true
Si el mensaje se debe aceptar y procesar como de costumbre.
false
Si el procesamiento del mensaje debe detenerse y el mensaje debe descartarse.

WeaveServerBase

 WeaveServerBase(
  void
)