En Google, luchamos por la equidad racial de la comunidad negra. Más información

nl :: Tejido:: WeaveServerBase

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

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

Resumen

Herencia

Subclases conocidas directas:
  nl :: Weave :: Perfiles :: DeviceControl :: DeviceControlServer
  nl :: Weave :: Perfiles :: DeviceDescription :: DeviceDescriptionServer
  nl :: Weave :: Perfiles :: Echo_Next :: WeaveEchoServer
  nl :: Weave :: Perfiles :: FabricProvisioning :: FabricProvisioningServer
  nl :: Weave :: Perfiles :: Heartbeat :: WeaveHeartbeatReceiver
  nl :: Weave :: Perfiles :: NetworkProvisioning :: NetworkProvisioningServer
  nl :: Weave :: Perfiles :: ServiceProvisioning :: ServiceProvisioningServer
  nl :: Weave :: Profiles :: TokenPairing :: TokenPairingServer
  nl :: Weave :: Perfiles :: Proveedor :: Nestlabs :: DropcamLegacyPairing :: DropcamLegacyPairingServer
  nl :: Weave :: Perfiles :: WeaveEchoServer

Atributos públicos

ExchangeMgr
[SOLO LEER] Objeto de administrador de Exchange
FabricState
[LEER SOLAMENTE] Objeto de estado de la tela

Funciones estáticas públicas

SendStatusReport ( ExchangeContext *ec, uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
Envíe un informe de estado de Weave con indicadores de mensaje predeterminados al iniciador en el intercambio especificado que contiene 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íe un informe de estado de Weave con los indicadores de mensaje proporcionados 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
Determine si un mensaje de solicitud entrante a un servidor Weave debe aceptarse o descartarse.
WeaveServerBase (void)

Atributos públicos

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[SOLO LEER] Objeto de administrador de Exchange

Estado de la tela

WeaveFabricState * FabricState

[LEER SOLAMENTE] Objeto de estado de la tela

Funciones estáticas públicas

SendStatusReport

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

Envíe un informe de estado de Weave con indicadores de mensaje predeterminados 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 al contexto de intercambio sobre el que enviar el informe de estado.
[in] statusProfileId
El perfil del código de estado especificado.
[in] statusCode
El código de estado para 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íe un informe de estado de Weave con los indicadores de mensaje proporcionados 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 al contexto de intercambio sobre el que enviar el informe de estado.
[in] statusProfileId
El perfil del código de estado especificado.
[in] statusCode
El código de estado para enviar.
[in] sysError
El error del sistema asociado o correlacionado con el código de estado.
[in] sendFlags
Banderas establecidas por la aplicación para el envío del informe de estado de Weave.

Funciones protegidas

EnforceAccessControl

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

Determine si un mensaje de solicitud entrante a un servidor Weave debe aceptarse o descartarse.

Este método está diseñado para que lo utilicen las implementaciones del servidor Weave para implementar una política de control de acceso extensible para los mensajes de solicitud entrantes. Las implementaciones de servidor que se basan en objetos delegados deben llamar a este método al principio del procesamiento de mensajes para determinar si el procesamiento de mensajes debe continuar.

Este método llama al virtuales WeaveServerDelegateBase :: EnforceAccessControl () método en el delegado suministrado para evaluar la política de control de acceso para el mensaje. Las clases de delegado 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 hacer cumplir políticas de control de acceso específicas.

Detalles
Parámetros
[in] ec
El ExchangeContext sobre el que se recibió el mensaje.
[in] msgProfileId
El ID de perfil del mensaje recibido.
[in] msgType
El tipo de mensaje del mensaje recibido.
[in] msgInfo
A WeaveMessageInfo estructura que contiene información sobre el mensaje recibido.
[in] delegate
Objeto delegado proporcionado por la aplicación que se puede utilizar para anular la política de control de acceso a mensajes predeterminada.
Valores devueltos
true
Si el mensaje debe aceptarse y procesarse normalmente.
false
Si el procesamiento del mensaje debe detenerse y el mensaje debe descartarse.

WeaveServerBase

 WeaveServerBase(
  void
)