nl::Weave::WeaveServerBase

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

Typowy, podstawowy obiekt do implementowania niepożądanych użytkowników (serwerów) profilu Weave, który obejmuje weryfikację uwierzytelnionych żądań i wysyłanie raportów o stanie oraz zapewnia wspólną pamięć masową dla stanu sieci szkieletowej i menedżera giełdy.

Podsumowanie

Dziedziczenie

Znane podklasy:









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

Atrybuty publiczne
ExchangeMgr
[TYLKO DO ODCZYTU] Obiekt menedżera Exchange
FabricState
[TYLKO DO ODCZYTU] Obiekt stanu Fabric

Publiczne funkcje statyczne
SendStatusReport(ExchangeContext *ec, uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
Wyślij do inicjatora na określonej giełdzie raport o stanie Weave z domyślnymi flagami wiadomości, zawierający kod stanu w określonym profilu i błąd systemu.
SendStatusReport(ExchangeContext *ec, uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError, uint16_t sendFlags)
Wyślij do inicjatora wiadomości raport o stanie Weave z podanymi flagami wiadomości na określonej giełdzie, zawierający kod stanu w określonym profilu i błąd systemu.

Funkcje chronione
EnforceAccessControl(ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, WeaveServerDelegateBase *delegate)
bool
Określ, czy przychodząca wiadomość z żądaniem do serwera Weave powinna zostać zaakceptowana czy odrzucona.
WeaveServerBase(void)

Atrybuty publiczne

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[TYLKO DO ODCZYTU] Obiekt menedżera Exchange

FabricState

WeaveFabricState * FabricState

[TYLKO DO ODCZYTU] Obiekt stanu Fabric

Publiczne funkcje statyczne

SendStatusReport

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

Wyślij do inicjatora na określonej giełdzie raport o stanie Weave z domyślnymi flagami wiadomości, zawierający kod stanu w określonym profilu i błąd systemu.

Szczegóły
Parametry
[in] ec
Wskaźnik do kontekstu giełdy, na temat którego ma zostać wysłany raport o stanie.
[in] statusProfileId
Profil z określonym kodem stanu.
[in] statusCode
Kod stanu do wysłania.
[in] sysError
Błąd systemu powiązany z kodem stanu lub z nim związany.

SendStatusReport

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

Wyślij do inicjatora wiadomości raport o stanie Weave z podanymi flagami wiadomości na określonej giełdzie, zawierający kod stanu w określonym profilu i błąd systemu.

Szczegóły
Parametry
[in] ec
Wskaźnik do kontekstu giełdy, na temat którego ma zostać wysłany raport o stanie.
[in] statusProfileId
Profil z określonym kodem stanu.
[in] statusCode
Kod stanu do wysłania.
[in] sysError
Błąd systemu powiązany z kodem stanu lub z nim związany.
[in] sendFlags
Flagi ustawione przez aplikację na potrzeby wysyłanego raportu o stanie Weave.

Funkcje chronione

EnforceAccessControl

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

Określ, czy przychodząca wiadomość z żądaniem do serwera Weave powinna zostać zaakceptowana czy odrzucona.

Ta metoda jest przeznaczona dla wdrożeń serwerów Weave do wdrażania rozszerzalnych zasad kontroli dostępu dla wiadomości przychodzących. Implementacje serwerów, które korzystają z obiektów przekazywania dostępu, powinny wywoływać tę metodę na wczesnym etapie przetwarzania wiadomości, aby określić, czy przetwarzanie wiadomości powinno być kontynuowane.

Ta metoda wywołuje wirtualną metodę WeaveServerInstanceBase::EnforceAccessControl() w podanym delegacji, aby ocenić zasadę kontroli dostępu dla wiadomości. Klasy delegata serwera Weave i delegaci do konkretnych aplikacji pochodzący ze standardowych klas serwera powinny zastąpić metodę wirtualną, aby egzekwować określone zasady kontroli dostępu.

Szczegóły
Parametry
[in] ec
ExchangeContext, przez które została odebrana wiadomość.
[in] msgProfileId
Identyfikator profilu odebranej wiadomości.
[in] msgType
Typ odebranej wiadomości.
[in] msgInfo
Struktura WeaveMessageInfo zawierająca informacje o odebranej wiadomości.
[in] delegate
Obiekt delegata dostarczony przez aplikację, który może służyć do zastępowania domyślnej zasady kontroli dostępu do wiadomości.
Zwracane wartości
true
Czy wiadomość powinna zostać zaakceptowana i przetworzona normalnie.
false
Jeśli przetwarzanie wiadomości powinno zostać zatrzymane, a wiadomość powinna zostać odrzucona.

WeaveServerBase

 WeaveServerBase(
  void
)