nl:: बुनें:: प्रोफाइल:: डिवाइस नियंत्रण:: DeviceControlDelegate

यह एक अमूर्त वर्ग है।

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

सर्वर डिवाइस पर आने वाले डिवाइस नियंत्रण संचालन को लागू करने के लिए प्रतिनिधि वर्ग।

सारांश

विरासत

: से विरासत में मिली nl :: Weave :: WeaveServerDelegateBase
प्रत्यक्ष ज्ञात उपवर्गों: nl :: Weave :: DeviceLayer :: आंतरिक :: DeviceControlServer

सार्वजनिक समारोह

EnforceAccessControl ( ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, AccessControlResult & result)
virtual void
लागू एक इनकमिंग के लिए संदेश स्तर तक पहुँच नियंत्रण DeviceControl अनुरोध संदेश।
IsPairedToAccount () const
virtual bool
यह निर्धारित करने के लिए कॉल किया जाता है कि डिवाइस वर्तमान में किसी खाते से जोड़ा गया है या नहीं।
IsResetAllowed (uint16_t resetFlags)=0
virtual bool
जांचें कि निर्दिष्ट कॉन्फ़िगरेशन को रीसेट करने की अनुमति है या नहीं।
OnConnectionMonitorTimeout (uint64_t peerNodeId, IPAddress peerAddr)=0
virtual void
इंगित करें कि एक कनेक्शन मॉनिटर टाइमआउट हो गया है।
OnFailSafeArmed (void)=0
virtual WEAVE_ERROR
इंगित करें कि डिवाइस कॉन्फ़िगरेशन विफल सुरक्षित है सशस्त्र किया गया है।
OnFailSafeDisarmed (void)=0
virtual WEAVE_ERROR
इंगित करें कि डिवाइस कॉन्फ़िगरेशन विफल सुरक्षित है निरस्त्र कर दिया गया है।
OnRemotePassiveRendezvousDone (void)=0
virtual void
इंगित करता है कि दूरस्थ निष्क्रिय मिलन प्रक्रिया समाप्त हो गई है।
OnRemotePassiveRendezvousStarted (void)=0
virtual void
इंगित करता है कि दूरस्थ निष्क्रिय मिलन प्रक्रिया शुरू हो गई है।
OnResetConfig (uint16_t resetFlags)=0
virtual WEAVE_ERROR
डिवाइस कॉन्फ़िगरेशन के सभी या उसके हिस्से को रीसेट करें।
OnSystemTestStarted (uint32_t profileId, uint32_t testId)=0
virtual WEAVE_ERROR
निर्दिष्ट सिस्टम परीक्षण प्रारंभ करें।
OnSystemTestStopped (void)=0
virtual WEAVE_ERROR
चल रहे सिस्टम परीक्षण को रोकें।
ShouldCloseConBeforeResetConfig (uint16_t resetFlags)=0
virtual bool
निर्धारित करें कि क्या सर्वर कनेक्शन, यदि मौजूद है, तो कॉन्फ़िगरेशन रीसेट से पहले बंद किया जाना चाहिए।
WillCloseRemotePassiveRendezvous (void)=0
virtual void
रिमोट पैसिव रेंडीज़वस को रोकने की तैयारी करें।
WillStartRemotePassiveRendezvous (void)=0
virtual WEAVE_ERROR
एक दूरस्थ निष्क्रिय मिलन स्थल के लिए तैयार करें।

सार्वजनिक समारोह

पहुंच नियंत्रण लागू करें

virtual void EnforceAccessControl(
  ExchangeContext *ec,
  uint32_t msgProfileId,
  uint8_t msgType,
  const WeaveMessageInfo *msgInfo,
  AccessControlResult & result
)

लागू एक इनकमिंग के लिए संदेश स्तर तक पहुँच नियंत्रण DeviceControl अनुरोध संदेश।

विवरण
मापदंडों
[in] ec
ExchangeContext जिस पर संदेश प्राप्त हुआ था।
[in] msgProfileId
प्राप्त संदेश की प्रोफाइल आईडी।
[in] msgType
प्राप्त संदेश का संदेश प्रकार।
[in] msgInfo
एक WeaveMessageInfo प्राप्त संदेश के बारे में जानकारी युक्त एक संरचना है।
[in,out] result
प्राप्त संदेश के लिए अभिगम नियंत्रण नीति मूल्यांकन के परिणाम का वर्णन करने वाला एक प्रगणित मूल्य। विधि में प्रवेश करने पर, मूल्य मूल्यांकन प्रक्रिया में वर्तमान बिंदु पर अस्थायी परिणाम का प्रतिनिधित्व करता है। वापसी पर, परिणाम संदेश के लिए अभिगम नियंत्रण नीति के अंतिम मूल्यांकन का प्रतिनिधित्व करने की उम्मीद है।

खाते में जोड़ा गया है

virtual bool IsPairedToAccount() const

यह निर्धारित करने के लिए कॉल किया जाता है कि डिवाइस वर्तमान में किसी खाते से जोड़ा गया है या नहीं।

रीसेट की अनुमति है

virtual bool IsResetAllowed(
  uint16_t resetFlags
)=0

जांचें कि निर्दिष्ट कॉन्फ़िगरेशन को रीसेट करने की अनुमति है या नहीं।

विवरण
मापदंडों
[in] resetFlags
किस कॉन्फ़िगरेशन को रीसेट करना है, यह निर्दिष्ट करने वाले फ़्लैग.
वापसी मूल्य
TRUE
यदि कॉन्फ़िगरेशन को रीसेट करने की अनुमति है।
FALSE
यदि कॉन्फ़िगरेशन को रीसेट करने की अनुमति नहीं है।

ऑनकनेक्शनमॉनिटरटाइमआउट

virtual void OnConnectionMonitorTimeout(
  uint64_t peerNodeId,
  IPAddress peerAddr
)=0

इंगित करें कि एक कनेक्शन मॉनिटर टाइमआउट हो गया है।

इस फ़ंक्शन को तब कहा जाता है जब कनेक्शन मॉनिटर टाइमआउट हुआ हो, यानी, जब एक निश्चित समय के लिए रिमोट होस्ट से लाइवनेस चेक का पता नहीं चला हो।

विवरण
मापदंडों
[in] peerNodeId
रिमोट पीयर का नोड आईडी जिससे कनेक्शन का समय समाप्त हो गया है।
[in] peerAddr
दूरस्थ सहकर्मी का पता।

ऑनफेलसेफसशस्त्र

virtual WEAVE_ERROR OnFailSafeArmed(
  void
)=0

इंगित करें कि डिवाइस कॉन्फ़िगरेशन विफल सुरक्षित है सशस्त्र किया गया है।

यह फ़ंक्शन तब कहा जाता है जब सर्वर डिवाइस कॉन्फ़िगरेशन विफल सुरक्षित क्लाइंट से अनुरोध के जवाब में सशस्त्र किया गया हो। विफल सुरक्षित स्वचालित रूप से डिवाइस कॉन्फ़िगरेशन को एक ज्ञात स्थिति में रीसेट कर देता है, यदि कॉन्फ़िगरेशन प्रक्रिया सफलतापूर्वक पूर्ण होने में विफल होती है।

विवरण
वापसी मूल्य
WEAVE_NO_ERROR
सफलता पर।
other
अन्य वीव या प्लेटफ़ॉर्म-विशिष्ट त्रुटि कोड यह इंगित करते हैं कि एक त्रुटि हुई है जो विफल को सुरक्षित होने से रोकती है।

ऑनफेल सुरक्षित निशस्त्र

virtual WEAVE_ERROR OnFailSafeDisarmed(
  void
)=0

इंगित करें कि डिवाइस कॉन्फ़िगरेशन विफल सुरक्षित है निरस्त्र कर दिया गया है।

यह फ़ंक्शन तब कहा जाता है जब सर्वर डिवाइस कॉन्फ़िगरेशन विफल सुरक्षित क्लाइंट से अनुरोध के जवाब में निरस्त्र कर दिया गया हो। कॉन्फ़िगरेशन पूर्ण होने के बाद क्लाइंट विफल सुरक्षित को निरस्त्र कर देगा।

विवरण
वापसी मूल्य
WEAVE_NO_ERROR
सफलता पर।
other
अन्य वीव या प्लेटफ़ॉर्म-विशिष्ट त्रुटि कोड यह इंगित करते हैं कि विफल सुरक्षित को निरस्त्रीकरण से रोकने में त्रुटि हुई।

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
)=0

इंगित करता है कि दूरस्थ निष्क्रिय मिलन प्रक्रिया समाप्त हो गई है।

OnRemotePassiveRendezvousशुरू किया गया

virtual void OnRemotePassiveRendezvousStarted(
  void
)=0

इंगित करता है कि दूरस्थ निष्क्रिय मिलन प्रक्रिया शुरू हो गई है।

ऑनरसेटकॉन्फिग

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
)=0

डिवाइस कॉन्फ़िगरेशन के सभी या उसके हिस्से को रीसेट करें।

रीसेट फ़्लैग के अनुसार, इस फ़ंक्शन के कार्यान्वयन से नेटवर्क, वेव फैब्रिक या सेवा कॉन्फ़िगरेशन के किसी भी संयोजन को किसी ज्ञात स्थिति में रीसेट करने की उम्मीद है।

विवरण
मापदंडों
[in] resetFlags
किस कॉन्फ़िगरेशन को रीसेट करना है, यह निर्दिष्ट करने वाले फ़्लैग.
वापसी मूल्य
WEAVE_NO_ERROR
सफलता पर।
other
अन्य वीव या प्लेटफ़ॉर्म-विशिष्ट त्रुटि कोड इंगित करते हैं कि एक त्रुटि हुई है जो डिवाइस को इसके कॉन्फ़िगरेशन को रीसेट करने से रोकती है।

ऑनसिस्टम टेस्टशुरू हुआ

virtual WEAVE_ERROR OnSystemTestStarted(
  uint32_t profileId,
  uint32_t testId
)=0

निर्दिष्ट सिस्टम परीक्षण प्रारंभ करें।

विवरण
मापदंडों
[in] profileId
अनुरोधित परीक्षण के प्रोफाइल की आईडी।
[in] testId
अनुरोधित परीक्षण की आईडी।
वापसी मूल्य
WEAVE_NO_ERROR
सफलता पर।
other
अन्य वीव या प्लेटफ़ॉर्म-विशिष्ट त्रुटि कोड यह इंगित करते हैं कि सिस्टम परीक्षण की शुरुआत को रोकने में त्रुटि हुई है।

ऑनसिस्टम टेस्ट बंद हो गया

virtual WEAVE_ERROR OnSystemTestStopped(
  void
)=0

चल रहे सिस्टम परीक्षण को रोकें।

विवरण
वापसी मूल्य
WEAVE_NO_ERROR
सफलता पर।
other
अन्य वीव या प्लेटफ़ॉर्म-विशिष्ट त्रुटि कोड यह दर्शाता है कि सिस्टम परीक्षण को रोकने में त्रुटि हुई है।

shouldCloseConBeforeResetConfig

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
)=0

निर्धारित करें कि क्या सर्वर कनेक्शन, यदि मौजूद है, तो कॉन्फ़िगरेशन रीसेट से पहले बंद किया जाना चाहिए।

कॉन्फ़िगरेशन रीसेट अनुरोध को संसाधित करते समय वांछित व्यवहार के लिए प्रतिनिधि को क्वेरी करने के लिए इस फ़ंक्शन का उपयोग किया जाता है। यदि कोई सर्वर कनेक्शन वर्तमान में सक्रिय है, तो इस विधि के लिए एक TRUE प्रतिक्रिया से उस कनेक्शन को बंद कर दिया जाएगा, इससे पहले कि कॉन्फ़िगरेशन रीसेट को OnResetConfig विधि के माध्यम से ट्रिगर किया जाए।

विवरण
मापदंडों
[in] resetFlags
किस कॉन्फ़िगरेशन को रीसेट करना है, यह निर्दिष्ट करने वाले फ़्लैग.
वापसी मूल्य
true
अगर कनेक्शन बंद करने की जरूरत है।
false
यदि कनेक्शन को बंद करने की आवश्यकता नहीं है।

WillCloseRemotePassiveRendezvous

virtual void WillCloseRemotePassiveRendezvous(
  void
)=0

रिमोट पैसिव रेंडीज़वस को रोकने की तैयारी करें।

यह सभी देखें:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
)=0

एक दूरस्थ निष्क्रिय मिलन स्थल के लिए तैयार करें।

उदाहरण के लिए, 15.4/थ्रेड नेटवर्क को जोड़ने योग्य बनाएं।

विवरण
वापसी मूल्य
WEAVE_NO_ERROR
सफलता पर।
other
अन्य वीव या प्लेटफ़ॉर्म-विशिष्ट त्रुटि कोड यह दर्शाते हैं कि रिमोट पैसिव रेंडीज़वस शुरू करने की तैयारी करते समय एक त्रुटि हुई।