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

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

Classe de serveur permettant d'implémenter le profil Device Control.

Résumé

Héritage

Hérite de: nl::Weave::WeaveServerBase
Sous-classes directes connues: nl::Weave::DeviceLayer::Internal::DeviceControlServer

Constructeurs et destructeurs

DeviceControlServer(void)

Attributs protégés

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

Fonctions publiques

Init(WeaveExchangeManager *exchangeMgr)
Initialisez l'état du serveur de contrôle des appareils et enregistrez-le pour recevoir les messages de contrôle des appareils.
IsRemotePassiveRendezvousInProgress(void) const
bool
Renvoie l'état de Rendezvous passifs distants.
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
Envoyez une réponse de rapport d'état à une requête.
SendSuccessResponse(void)
virtual WEAVE_ERROR
Envoyez une réponse positive à une requête de contrôle des appareils.
SetDelegate(DeviceControlDelegate *delegate)
void
Configurez le délégué pour qu'il traite les événements du serveur de contrôle des appareils.
Shutdown(void)
Arrêtez le serveur de contrôle des appareils.
SystemTestTimeout(void)
void

Attributs protégés

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

Fonctions publiques

DeviceControlServer

 DeviceControlServer(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Initialisez l'état du serveur de contrôle des appareils et enregistrez-le pour recevoir les messages de contrôle des appareils.

Détails
Paramètres
[in] exchangeMgr
Pointeur vers le gestionnaire Weave Exchange.
Valeurs de retour
WEAVE_ERROR_INCORRECT_STATE
Lorsqu'un serveur de rendez-vous passif distant a déjà été enregistré.
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Lorsqu'un trop grand nombre de gestionnaires de messages non sollicités sont enregistrés.
WEAVE_NO_ERROR
Pour la réussite.

IsRemotePassiveRendezvousInProgress

bool IsRemotePassiveRendezvousInProgress(
  void
) const 

Renvoie l'état de Rendezvous passifs distants.

Détails
Valeurs de retour
TRUE
si des rendez-vous passifs distants sont en cours.
FALSE
si le programme de rendez-vous passifs à distance n'est pas en cours.

SendStatusReport

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

Envoyez une réponse de rapport d'état à une requête.

Détails
Paramètres
[in] statusProfileId
ID du profil Weave auquel ce rapport d'état se rapporte.
[in] statusCode
Code d'état à inclure dans cette réponse.
[in] sysError
Code d'erreur système à inclure dans cette réponse.
Valeurs de retour
WEAVE_ERROR_INCORRECT_STATE
Si aucune demande n'est en cours de traitement.
WEAVE_NO_ERROR
Pour la réussite.
other
D'autres codes d'erreur spécifiques à la plate-forme ou Weave indiquant qu'une erreur s'est produite et empêchant l'envoi du rapport d'état

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

Envoyez une réponse positive à une requête de contrôle des appareils.

Détails
Valeurs de retour
WEAVE_ERROR_INCORRECT_STATE
Si aucune demande n'est en cours de traitement.
WEAVE_NO_ERROR
Pour la réussite.
other
D'autres codes d'erreur spécifiques à la plate-forme ou Weave indiquant qu'une erreur s'est produite et empêchant l'envoi de la réponse positive

SetDelegate

void SetDelegate(
  DeviceControlDelegate *delegate
)

Configurez le délégué pour qu'il traite les événements du serveur de contrôle des appareils.

Détails
Paramètres
[in] delegate
Pointeur vers le délégué de contrôle des appareils.

Arrêt

WEAVE_ERROR Shutdown(
  void
)

Arrêtez le serveur de contrôle des appareils.

Détails
Valeurs de retour
WEAVE_NO_ERROR
sans conditions.

SystemTestTimeout

void SystemTestTimeout(
  void
)