nl::Weave::Profiles::DeviceControl::DeviceControlServer

#include <src/lib/profiles/device-control/DeviceControl.h>

Klasa serwera do implementacji profilu sterowania urządzeniem.

Podsumowanie

Dziedziczenie

Dziedziczy z: nl::Weave::WeaveServerBase
Bezpośrednie znane podklasy: nl::Weave::DeviceLayer::Internal::DeviceControlServer

Konstruktorzy i niszczyciele
DeviceControlServer(void)

Atrybuty chronione
mCurClientOp
mDelegate
mFailSafeArmed
bool
mFailSafeToken
uint32_t
mRemotePassiveRendezvousClientCon
mRemotePassiveRendezvousEncryptionType
uint8_t
mRemotePassiveRendezvousJoinerAddr
mRemotePassiveRendezvousJoinerCon
mRemotePassiveRendezvousKeyId
uint16_t
mRemotePassiveRendezvousOp
mRemotePassiveRendezvousTimeout
uint16_t
mRemotePassiveRendezvousTunnel
mResetFlags
uint16_t
mTunnelInactivityTimeout
uint16_t

Funkcje publiczne
Init(WeaveExchangeManager *exchangeMgr)
Zainicjuj stan serwera sterowania urządzeniem i zarejestruj się, aby otrzymywać komunikaty dotyczące sterowania urządzeniem.
IsRemotePassiveRendezvousInProgress(void) const
bool
Przywróć zdalny stan biernego rezonansu.
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
Wyślij odpowiedź z raportem o stanie na prośbę.
SendSuccessResponse(void)
virtual WEAVE_ERROR
Wyślij odpowiedź o powodzeniu na żądanie Sterowanie urządzeniem.
SetDelegate(DeviceControlDelegate *delegate)
void
Skonfiguruj osobę, której przekazano dostęp do przetwarzania zdarzeń serwera sterowania urządzeniem.
Shutdown(void)
Wyłącz serwer sterowania urządzeniem.
SystemTestTimeout(void)
void

Atrybuty chronione

mCurClientOp

ExchangeContext * mCurClientOp

mDelegate

DeviceControlDelegate * mDelegate

mFailSafeArmed

bool mFailSafeArmed

mFailSafeToken

uint32_t mFailSafeToken

mRemotePassiveRendezvousClientCon

WeaveConnection * mRemotePassiveRendezvousClientCon

mRemotePassiveRendezvousEncryptionType

uint8_t mRemotePassiveRendezvousEncryptionType

mRemotePassiveRendezvousJoinerAddr

IPAddress mRemotePassiveRendezvousJoinerAddr

mRemotePassiveRendezvousJoinerCon

WeaveConnection * mRemotePassiveRendezvousJoinerCon

mRemotePassiveRendezvousKeyId

uint16_t mRemotePassiveRendezvousKeyId

mRemotePassiveRendezvousOp

ExchangeContext * mRemotePassiveRendezvousOp

mRemotePassiveRendezvousTimeout

uint16_t mRemotePassiveRendezvousTimeout

mRemotePassiveRendezvousTunnel

WeaveConnectionTunnel * mRemotePassiveRendezvousTunnel

mResetFlags

uint16_t mResetFlags

mTunnelInactivityTimeout

uint16_t mTunnelInactivityTimeout

Funkcje publiczne

DeviceControlServer

 DeviceControlServer(
  void
)

Zainicjuj

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Zainicjuj stan serwera sterowania urządzeniem i zarejestruj się, aby otrzymywać komunikaty dotyczące sterowania urządzeniem.

Szczegóły
Parametry
[in] exchangeMgr
Wskaźnik menedżera Weave Exchange.
Zwracane wartości
WEAVE_ERROR_INCORRECT_STATE
Gdy został już zarejestrowany zdalny pasywny serwer rendezvity.
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Gdy zarejestrowanych jest zbyt wiele niechcianych modułów obsługi wiadomości.
WEAVE_NO_ERROR
Na sukces.

IsRemotePassiveRendezvousInProgress

bool IsRemotePassiveRendezvousInProgress(
  void
) const

Przywróć zdalny stan biernego rezonansu.

Szczegóły
Zwracane wartości
TRUE
jeśli trwa działanie zdalnych pasywnych rendezvous.
FALSE
jeśli zdalny pasywny rendezvous nie jest w toku.

SendStatusReport

virtual WEAVE_ERROR SendStatusReport(
  uint32_t statusProfileId,
  uint16_t statusCode,
  WEAVE_ERROR sysError
)

Wyślij odpowiedź z raportem o stanie na prośbę.

Szczegóły
Parametry
[in] statusProfileId
Identyfikator profilu Weave, którego dotyczy ten raport o stanie.
[in] statusCode
Kod stanu, który ma być uwzględniony w tej odpowiedzi.
[in] sysError
Kod błędu systemu, który zostanie uwzględniony w tej odpowiedzi.
Zwracane wartości
WEAVE_ERROR_INCORRECT_STATE
Jeśli żadne żądanie nie jest przetwarzane.
WEAVE_NO_ERROR
Na sukces.
other
Inne kody błędów Weave lub platformy wskazujące, że wystąpił błąd uniemożliwiający wysłanie raportu o stanie.

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

Wyślij odpowiedź o powodzeniu na żądanie Sterowanie urządzeniem.

Szczegóły
Zwracane wartości
WEAVE_ERROR_INCORRECT_STATE
Jeśli żadne żądanie nie jest przetwarzane.
WEAVE_NO_ERROR
Na sukces.
other
Inne kody błędów Weave lub platformy wskazujące, że wystąpił błąd uniemożliwiający wysłanie odpowiedzi z powodzeniem.

SetDelegate

void SetDelegate(
  DeviceControlDelegate *delegate
)

Skonfiguruj osobę, której przekazano dostęp do przetwarzania zdarzeń serwera sterowania urządzeniem.

Szczegóły
Parametry
[in] delegate
Wskaźnik do osoby, której przekazano dostęp do sterowania urządzeniem.

Wyłączono

WEAVE_ERROR Shutdown(
  void
)

Wyłącz serwer sterowania urządzeniem.

Szczegóły
Zwracane wartości
WEAVE_NO_ERROR
bezwarunkowo.

SystemTestTimeout

void SystemTestTimeout(
  void
)