nl:: بافت:: پروفایل ها:: تامین شبکه:: NetworkProvisioning Delegate

این یک کلاس انتزاعی است.

#include <src/lib/profiles/network-provisioning/NetworkProvisioning.h>

اختصاص کلاس برای اجرای عملیات تامین شبکه.

خلاصه

وراثت

از: nl::Weave::WeaveServerDelegateBase به ارث می برد
زیر کلاس های مستقیم شناخته شده:
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl< NetworkProvisioningServerImpl >
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl< ImplClass >

صفات عمومی

Server
[فقط بخوانید] شی سروری که این نماینده به آن پیوست شده است.

توابع عمومی

EnforceAccessControl ( ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, AccessControlResult & result)
virtual void
کنترل دسترسی در سطح پیام را برای پیام درخواست تامین شبکه ورودی اعمال کنید.
HandleAddNetwork (PacketBuffer *networkInfoTLV)=0
virtual WEAVE_ERROR
یک شبکه خاص اضافه کنید.
HandleDisableNetwork (uint32_t networkId)=0
virtual WEAVE_ERROR
شبکه مشخص شده را غیرفعال کنید.
HandleEnableNetwork (uint32_t networkId)=0
virtual WEAVE_ERROR
شبکه مشخص شده را فعال کنید.
HandleGetNetworks (uint8_t flags)=0
virtual WEAVE_ERROR
شبکه های پیکربندی شده را دریافت کنید.
HandleGetWirelessRegulatoryConfig (void)
virtual WEAVE_ERROR
اطلاعات پیکربندی تنظیمی بی سیم را دریافت کنید.
HandleRemoveNetwork (uint32_t networkId)=0
virtual WEAVE_ERROR
یک شبکه پیکربندی شده را حذف کنید.
HandleScanNetworks (uint8_t networkType)=0
virtual WEAVE_ERROR
اسکن شبکه را انجام دهید.
HandleSetRendezvousMode (uint16_t rendezvousMode)=0
virtual WEAVE_ERROR
حالت قرار ملاقات را تنظیم کنید.
HandleSetWirelessRegulatoryConfig ( PacketBuffer *regConfigTLV)
virtual WEAVE_ERROR
اطلاعات پیکربندی تنظیمی بی سیم را تنظیم کنید.
HandleTestConnectivity (uint32_t networkId)=0
virtual WEAVE_ERROR
اتصال شبکه مشخص شده را تست کنید.
HandleUpdateNetwork (PacketBuffer *networkInfoTLV)=0
virtual WEAVE_ERROR
پیکربندی یک شبکه را به روز کنید.
IsPairedToAccount () const
virtual bool
برای تعیین اینکه آیا دستگاه در حال حاضر با یک حساب جفت شده است یا خیر، فراخوانی می شود.

صفات عمومی

سرور

NetworkProvisioningServer * Server

[فقط بخوانید] شی سروری که این نماینده به آن پیوست شده است.

توابع عمومی

EnforceAccessControl

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

کنترل دسترسی در سطح پیام را برای پیام درخواست تامین شبکه ورودی اعمال کنید.

جزئیات
مولفه های
[in] ec
ExchangeContext که پیام از طریق آن دریافت شده است.
[in] msgProfileId
شناسه پروفایل پیام دریافتی
[in] msgType
نوع پیام پیام دریافتی
[in] msgInfo
ساختار WeaveMessageInfo حاوی اطلاعاتی در مورد پیام دریافتی.
[in,out] result
یک مقدار شمارش شده که نتیجه ارزیابی خط مشی کنترل دسترسی را برای پیام دریافتی توصیف می کند. پس از ورود به روش، مقدار نشان دهنده نتیجه آزمایشی در نقطه فعلی در فرآیند ارزیابی است. پس از بازگشت، انتظار می رود که نتیجه ارزیابی نهایی سیاست کنترل دسترسی برای پیام را نشان دهد.

HandleAddNetwork

virtual WEAVE_ERROR HandleAddNetwork(
  PacketBuffer *networkInfoTLV
)=0

یک شبکه خاص اضافه کنید.

جزئیات
مولفه های
[in] networkInfoTLV
پیکربندی شبکه در TLV کدگذاری شده است.
ارزش های بازگشتی
WEAVE_NO_ERROR
در مورد موفقیت
other
سایر کدهای خطای Weave یا پلتفرم خاص که نشان می دهد خطایی رخ داده است که مانع از افزودن شبکه توسط دستگاه می شود.
همچنین ببینید:
NetworkProvisioningDataElementTags برای انواع معتبر.

HandleDisableNetwork

virtual WEAVE_ERROR HandleDisableNetwork(
  uint32_t networkId
)=0

شبکه مشخص شده را غیرفعال کنید.

جزئیات
مولفه های
[in] networkId
شناسه شبکه برای غیرفعال کردن
ارزش های بازگشتی
WEAVE_NO_ERROR
در مورد موفقیت
other
سایر کدهای خطای Weave یا پلتفرم خاص که نشان می دهد خطایی رخ داده است که مانع از غیرفعال کردن شبکه توسط دستگاه می شود.

HandleEnableNetwork

virtual WEAVE_ERROR HandleEnableNetwork(
  uint32_t networkId
)=0

شبکه مشخص شده را فعال کنید.

جزئیات
مولفه های
[in] networkId
شناسه شبکه برای فعال کردن.
ارزش های بازگشتی
WEAVE_NO_ERROR
در مورد موفقیت
other
سایر کدهای خطای Weave یا پلتفرم خاص که نشان می دهد خطایی رخ داده است که مانع فعال کردن شبکه توسط دستگاه می شود.

HandleGetNetworks

virtual WEAVE_ERROR HandleGetNetworks(
  uint8_t flags
)=0

شبکه های پیکربندی شده را دریافت کنید.

جزئیات
مولفه های
[in] flags
پرچم برای فیلتر کردن شبکه های بازیابی شده
ارزش های بازگشتی
WEAVE_NO_ERROR
در مورد موفقیت
other
سایر کدهای خطای Weave یا پلتفرم خاص که نشان می دهد خطایی رخ داده است که مانع از دریافت شبکه های پیکربندی شده توسط دستگاه می شود.

HandleGetWirelessRegulatoryConfig

virtual WEAVE_ERROR HandleGetWirelessRegulatoryConfig(
  void
)

اطلاعات پیکربندی تنظیمی بی سیم را دریافت کنید.

جزئیات
ارزش های بازگشتی
WEAVE_NO_ERROR
در مورد موفقیت
other
سایر کدهای خطای Weave یا پلتفرم خاص که نشان می دهد خطایی رخ داده است که مانع از دریافت اطلاعات درخواستی توسط دستگاه می شود.

HandleRemoveNetwork

virtual WEAVE_ERROR HandleRemoveNetwork(
  uint32_t networkId
)=0

یک شبکه پیکربندی شده را حذف کنید.

جزئیات
مولفه های
[in] networkId
شناسه شبکه برای حذف.
ارزش های بازگشتی
WEAVE_NO_ERROR
در مورد موفقیت
other
سایر کدهای خطای Weave یا پلتفرم خاص که نشان می دهد خطایی رخ داده است که مانع از حذف شبکه توسط دستگاه می شود.

HandleScanNetworks

virtual WEAVE_ERROR HandleScanNetworks(
  uint8_t networkType
)=0

اسکن شبکه را انجام دهید.

جزئیات
مولفه های
[in] networkType
فناوری (به عنوان مثال، WiFi یا Thread) برای اسکن.
ارزش های بازگشتی
WEAVE_NO_ERROR
در مورد موفقیت
other
سایر کدهای خطای Weave یا پلتفرم خاص که نشان می دهد خطایی رخ داده است که دستگاه را از انجام اسکن شبکه باز می دارد.
همچنین ببینید:
NetworkType برای انواع معتبر.

HandleSetRendezvousMode

virtual WEAVE_ERROR HandleSetRendezvousMode(
  uint16_t rendezvousMode
)=0

حالت قرار ملاقات را تنظیم کنید.

جزئیات
مولفه های
[in] rendezvousMode
حالت قرار ملاقات برای استفاده.
ارزش های بازگشتی
WEAVE_NO_ERROR
در مورد موفقیت
other
سایر کدهای خطای Weave یا پلتفرم خاص که نشان می دهد خطایی رخ داده است که مانع از تنظیم حالت قرار ملاقات توسط دستگاه می شود.
همچنین ببینید:
RendezvousModeFlags برای حالت های معتبر.

HandleSetWirelessRegulatoryConfig

virtual WEAVE_ERROR HandleSetWirelessRegulatoryConfig(
  PacketBuffer *regConfigTLV
)

اطلاعات پیکربندی تنظیمی بی سیم را تنظیم کنید.

جزئیات
مولفه های
[in] regConfigTLV
یک بسته بافر حاوی اطلاعات پیکربندی تنظیمی بی سیم جدید که در قالب TLV کدگذاری شده است.
ارزش های بازگشتی
WEAVE_NO_ERROR
در مورد موفقیت
other
سایر کدهای خطای Weave یا پلتفرم خاص که نشان می دهد خطایی رخ داده است که مانع از تنظیم اطلاعات درخواستی توسط دستگاه می شود.

HandleTestConnectivity

virtual WEAVE_ERROR HandleTestConnectivity(
  uint32_t networkId
)=0

اتصال شبکه مشخص شده را تست کنید.

جزئیات
مولفه های
[in] networkId
شناسه شبکه برای تست اتصال.
ارزش های بازگشتی
WEAVE_NO_ERROR
در مورد موفقیت
other
سایر کدهای خطای Weave یا پلتفرم خاص که نشان می دهد خطایی رخ داده است که مانع از آزمایش اتصال دستگاه می شود.

HandleUpdateNetwork

virtual WEAVE_ERROR HandleUpdateNetwork(
  PacketBuffer *networkInfoTLV
)=0

پیکربندی یک شبکه را به روز کنید.

جزئیات
مولفه های
[in] networkInfoTLV
پیکربندی شبکه در TLV کدگذاری شده است.
ارزش های بازگشتی
WEAVE_NO_ERROR
در مورد موفقیت
other
سایر کدهای خطای Weave یا پلتفرم خاص که نشان می دهد خطایی رخ داده است که مانع از به روز رسانی شبکه توسط دستگاه می شود.
همچنین ببینید:
NetworkProvisioningDataElementTags برای انواع معتبر.

IsPairedToAccount

virtual bool IsPairedToAccount() const 

برای تعیین اینکه آیا دستگاه در حال حاضر با یک حساب جفت شده است یا خیر، فراخوانی می شود.