nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer

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

فئة الخادم لتنفيذ الملف الشخصي لإدارة الحسابات على الشبكة.

ملخّص

الاكتساب

موروث من: nl::Weave::WeaveServerBase
الفئات الفرعية المعروفة المباشرة:
  nl::Weave::DeviceLayer::internal::PersonalNetworkEnrollmentingServerImpl< NetworkProvisioningServerImpl >
  Server ::WeaveCover::DeviceNetwork:internal}:

الدلالة والهياكل
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
أرسِل رسالة "إضافة شبكة مكتملة" إذا تمت إضافة الشبكة بنجاح.
SendGetNetworksComplete(uint8_t resultCount, PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
أرسِل رسالة "الحصول على الشبكات كاملة" تحتوي على الشبكات التي تم فحصها سابقًا.
SendGetWirelessRegulatoryConfigComplete(PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
أرسِل رسالة GetWirelessRegulatoryConfigComplete إلى النظير.
SendNetworkScanComplete(uint8_t resultCount, PacketBuffer *scanResultsTLV)
virtual WEAVE_ERROR
أرسل رسالة استجابة مكتملة للبحث عن الشبكة تحتوي على نتائج الفحص.
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

mDelegate

NetworkProvisioningDelegate * mDelegate

mLastOpResult

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

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

StatusCode

uint16_t StatusCode

StatusProfileId

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
)

أرسِل رسالة "إضافة شبكة مكتملة" إذا تمت إضافة الشبكة بنجاح.

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

SendGetNetworksComplete

virtual WEAVE_ERROR SendGetNetworksComplete(
  uint8_t resultCount,
  PacketBuffer *resultsTLV
)

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

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

SendGetWirelessRegulatoryConfigComplete

virtual WEAVE_ERROR SendGetWirelessRegulatoryConfigComplete(
  PacketBuffer *resultsTLV
)

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

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

SendNetworkScanComplete

virtual WEAVE_ERROR SendNetworkScanComplete(
  uint8_t resultCount,
  PacketBuffer *scanResultsTLV
)

أرسل رسالة استجابة مكتملة للبحث عن الشبكة تحتوي على نتائج الفحص.

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

SendStatusReport

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
رموز الخطأ الأخرى في Weave أو النظام الأساسي والتي تشير إلى حدوث خطأ يمنع الجهاز من إرسال تقرير الحالة.

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

يمكنك إرسال رد ناجح على طلب إدارة حسابات الشبكة.

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

SetDelegate

void SetDelegate(
  NetworkProvisioningDelegate *delegate
)

اضبط المفوَّض لمعالجة أحداث خادم إدارة حسابات الشبكة.

التفاصيل
المَعلمات
[in] delegate
مؤشر يؤدي إلى "مفوّض إدارة الحسابات على الشبكة".

إيقاف التشغيل

WEAVE_ERROR Shutdown(
  void
)

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

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