nl :: نسج:: مظهر:: توفير الشبكة :: NetworkProvisioningServer

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

فئة الخادم لتنفيذ ملف تعريف توفير الشبكة.

ملخص

ميراث

يرث من: NL :: :: نسج WeaveServerBase
الفئات الفرعية المعروفة المباشرة:
  nl :: Weave :: DeviceLayer :: Internal :: GenericNetworkProvisioningServerImpl <NetworkProvisioningServerImpl>
  nl :: Weave :: DeviceLayer :: Internal :: GenericNetworkProvisioningServerImpl <ImplClass>

البنائين والمدمرين

NetworkProvisioningServer (void)

السمات المحمية

mCurOp
mCurOpType
uint8_t
mDelegate
mLastOpResult
struct nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer::@217

السمات العامة

StatusCode
uint16_t
StatusProfileId
uint32_t
SysError

الوظائف العامة

Init ( WeaveExchangeManager *exchangeMgr)
قم بتهيئة حالة خادم توفير الشبكة والتسجيل لتلقي رسائل توفير الشبكة.
SendAddNetworkComplete (uint32_t networkId)
virtual WEAVE_ERROR
أرسل رسالة Add Network Complete إذا تمت إضافة الشبكة بنجاح.
SendGetNetworksComplete (uint8_t resultCount, PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
أرسل رسالة Get Networks Complete تحتوي على الشبكات التي تم فحصها مسبقًا.
SendGetWirelessRegulatoryConfigComplete ( PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
أرسل رسالة GetWirelessRegulatoryConfigComplete إلى النظير.
SendNetworkScanComplete (uint8_t resultCount, PacketBuffer *scanResultsTLV)
virtual WEAVE_ERROR
أرسل رسالة استجابة Network Scan Complete تحتوي على نتائج الفحص.
SendStatusReport (uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
إرسال تقرير حالة استجابة لطلب.
SendSuccessResponse (void)
virtual WEAVE_ERROR
أرسل استجابة ناجحة لطلب توفير الشبكة.
SetDelegate ( NetworkProvisioningDelegate *delegate)
void
قم بتعيين المفوض لمعالجة أحداث خادم دعم الشبكة.
Shutdown (void)
قم بإيقاف تشغيل خادم توفير الشبكة.

السمات المحمية

mCurOp

ExchangeContext * mCurOp

mCurOpType

uint8_t mCurOpType

م مندوب

NetworkProvisioningDelegate * mDelegate

نتيجة mLastOp

struct nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer::@217 mLastOpResult

السمات العامة

رمز الحالة

uint16_t StatusCode

الحالة

uint32_t StatusProfileId

SysError

WEAVE_ERROR SysError

الوظائف العامة

فيه

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

قم بتهيئة حالة خادم توفير الشبكة والتسجيل لتلقي رسائل توفير الشبكة.

تفاصيل
المعلمات
[in] exchangeMgr
مؤشر إلى نظام Weave Exchange Manager.
إرجاع القيم
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
إذا تم بالفعل تسجيل عدد كبير جدًا من معالجات الرسائل.
WEAVE_NO_ERROR
عن النجاح.

NetworkProvisioningServer

 NetworkProvisioningServer(
  void
)

SendAddNetworkComplete

virtual WEAVE_ERROR SendAddNetworkComplete(
  uint32_t networkId
)

أرسل رسالة Add Network Complete إذا تمت إضافة الشبكة بنجاح.

تفاصيل
المعلمات
[in] networkId
معرّف الشبكة المضافة.
إرجاع القيم
WEAVE_ERROR_INCORRECT_STATE
إذا لم تتم تهيئة خادم دعم الشبكة بشكل صحيح.
WEAVE_ERROR_NO_MEMORY
عند الفشل في تخصيص PacketBuffer.
WEAVE_NO_ERROR
عن النجاح.
other
رموز خطأ أخرى خاصة بالنسيج أو النظام الأساسي تشير إلى حدوث خطأ يمنع الجهاز من إرسال رسالة "إضافة شبكة كاملة".

إرسال GetNetworksComplete

virtual WEAVE_ERROR SendGetNetworksComplete(
  uint8_t resultCount,
  PacketBuffer *resultsTLV
)

أرسل رسالة Get Networks Complete تحتوي على الشبكات التي تم فحصها مسبقًا.

تفاصيل
المعلمات
[in] resultCount
عدد نتائج الفحص.
[in] scanResultsTLV
نتائج الفحص.
إرجاع القيم
WEAVE_ERROR_INCORRECT_STATE
إذا لم تتم تهيئة خادم دعم الشبكة بشكل صحيح.
WEAVE_ERROR_BUFFER_TOO_SMALL
إذا لم يكن المخزن المؤقت للنتائج كبيرًا بدرجة كافية.
WEAVE_NO_ERROR
عن النجاح.
other
رموز خطأ أخرى خاصة بالنسيج أو النظام الأساسي تشير إلى حدوث خطأ يمنع الجهاز من إرسال رسالة Get Networks Complete.

SendGetWirelessRegulatoryConfigComplete

virtual WEAVE_ERROR SendGetWirelessRegulatoryConfigComplete(
  PacketBuffer *resultsTLV
)

أرسل رسالة GetWirelessRegulatoryConfigComplete إلى النظير.

تفاصيل
المعلمات
[in] resultsTLV
حزمة عازلة تحتوي على معلومات التكوين التنظيمي اللاسلكي المطلوب إرجاعها.
إرجاع القيم
WEAVE_ERROR_INCORRECT_STATE
إذا لم تتم تهيئة خادم دعم الشبكة بشكل صحيح.
WEAVE_ERROR_NO_MEMORY
عند الفشل في تخصيص PacketBuffer.
WEAVE_NO_ERROR
عن النجاح.
other
تشير رموز الخطأ الأخرى الخاصة بالنسيج أو النظام الأساسي إلى حدوث خطأ يمنع الجهاز من إرسال رسالة "إضافة شبكة كاملة".

SendNetworkScanComplete

virtual WEAVE_ERROR SendNetworkScanComplete(
  uint8_t resultCount,
  PacketBuffer *scanResultsTLV
)

أرسل رسالة استجابة Network Scan Complete تحتوي على نتائج الفحص.

تفاصيل
المعلمات
[in] resultCount
عدد نتائج الفحص.
[in] scanResultsTLV
نتائج الفحص.
إرجاع القيم
WEAVE_ERROR_INCORRECT_STATE
إذا لم تتم تهيئة خادم دعم الشبكة بشكل صحيح.
WEAVE_ERROR_BUFFER_TOO_SMALL
إذا لم يكن المخزن المؤقت للنتائج كبيرًا بدرجة كافية.
WEAVE_NO_ERROR
عن النجاح.
other
تشير رموز الخطأ الأخرى الخاصة بالنسيج أو النظام الأساسي إلى حدوث خطأ يمنع الجهاز من إرسال استجابة المسح الكامل.

إرسال تقرير الحالة

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

إرسال تقرير حالة استجابة لطلب.

تفاصيل
المعلمات
[in] statusProfileId
معرف ملف تعريف Weave الذي ينتمي إليه تقرير الحالة هذا.
[in] statusCode
رمز الحالة المراد تضمينه في هذه الاستجابة.
[in] sysError
رمز خطأ النظام الذي سيتم تضمينه في هذه الاستجابة.
إرجاع القيم
WEAVE_ERROR_INCORRECT_STATE
إذا لم يكن هناك طلب قيد المعالجة.
WEAVE_NO_ERROR
عن النجاح.
other
رموز خطأ أخرى خاصة بالنسيج أو النظام الأساسي تشير إلى حدوث خطأ يمنع الجهاز من إرسال تقرير الحالة.

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

أرسل استجابة ناجحة لطلب توفير الشبكة.

تفاصيل
إرجاع القيم
WEAVE_ERROR_INCORRECT_STATE
إذا لم يكن هناك طلب قيد المعالجة.
WEAVE_NO_ERROR
عن النجاح.
other
رموز خطأ أخرى خاصة بالنسيج أو النظام الأساسي تشير إلى حدوث خطأ يمنع الجهاز من إرسال استجابة النجاح.

تعيين المندوب

void SetDelegate(
  NetworkProvisioningDelegate *delegate
)

قم بتعيين المفوض لمعالجة أحداث خادم دعم الشبكة.

تفاصيل
المعلمات
[in] delegate
مؤشر لمندوب تزويد الشبكة.

اغلق

WEAVE_ERROR Shutdown(
  void
)

قم بإيقاف تشغيل خادم توفير الشبكة.

تفاصيل
إرجاع القيم
WEAVE_NO_ERROR
عن النجاح.