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

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

کلاس سرور برای پیاده سازی نمایه تامین شبکه.

خلاصه

ارث

از: nl::Weave::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
اگر شبکه با موفقیت اضافه شد، یک پیام افزودن شبکه کامل ارسال کنید.
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

صفات عمومی

کد وضعیت 

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 یا پلتفرم خاص که نشان می دهد خطایی رخ داده است که مانع از ارسال پیام Add Network Complete توسط دستگاه می شود.

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 یا پلتفرم خاص که نشان می دهد خطایی رخ داده است که مانع از ارسال پیام دریافت شبکه کامل توسط دستگاه می شود.

SendGetWirelessRegulatoryConfigComplete 

virtual WEAVE_ERROR SendGetWirelessRegulatoryConfigComplete(
  PacketBuffer *resultsTLV
)

یک پیام GetWirelessRegulatoryConfigComplete به همتا ارسال کنید.

جزئیات
پارامترها
[in] resultsTLV
یک بسته بافر حاوی اطلاعات پیکربندی تنظیمی بی سیم که باید برگردانده شود.
ارزش های بازگشتی
WEAVE_ERROR_INCORRECT_STATE
اگر سرور تامین شبکه به درستی مقداردهی اولیه نشده باشد.
WEAVE_ERROR_NO_MEMORY
در مورد عدم تخصیص PacketBuffer.
WEAVE_NO_ERROR
در مورد موفقیت
other
سایر کدهای خطای Weave یا پلتفرم خاص که نشان می دهد خطایی رخ داده است که مانع از ارسال پیام Add Network Complete توسط دستگاه می شود.

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 یا پلتفرم خاص که نشان می دهد خطایی رخ داده است که مانع از ارسال پاسخ اسکن کامل توسط دستگاه می شود.

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
در مورد موفقیت