nl ：：織り::プロファイル:: NetworkProvisioning ：： NetworkProvisioningServer
#include <src/lib/profiles/network-provisioning/NetworkProvisioning.h>ネットワークプロビジョニングプロファイルを実装するためのサーバークラス。
概要
継承
：から継承NL ::織り:: WeaveServerBase直接既知のサブクラス： nl :: Weave :: DeviceLayer :: Internal :: GenericNetworkProvisioningServerImpl <NetworkProvisioningServerImpl> nl :: Weave :: DeviceLayer :: Internal :: GenericNetworkProvisioningServerImpl <ImplClass> 保護された属性
mCurOpType
uint8_t mCurOpType
mLastOpResult
struct nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer::@217 mLastOpResult
パブリック属性
StatusCode
uint16_t StatusCode
StatusProfileId
uint32_t StatusProfileId
公共機能
初期化
WEAVE_ERROR Init(
WeaveExchangeManager *exchangeMgr
)
ネットワークプロビジョニングサーバーの状態を初期化し、ネットワークプロビジョニングメッセージを受信するように登録します。
| 詳細 | | パラメーター | [in] exchangeMgr | システムWeaveExchangeManagerへのポインター。 |
|
| 戻り値 | WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS | すでに登録されているメッセージハンドラーが多すぎる場合。 | WEAVE_NO_ERROR | 成功時。 |
|
NetworkProvisioningServer
NetworkProvisioningServer(
void
)
SendAddNetworkComplete
virtual WEAVE_ERROR SendAddNetworkComplete(
uint32_t networkId
)
ネットワークが正常に追加された場合は、「ネットワークの追加完了」メッセージを送信します。
| 詳細 | | パラメーター | [in] networkId | 追加されたネットワークのID。 |
|
| 戻り値 | WEAVE_ERROR_INCORRECT_STATE | ネットワークプロビジョニングサーバーが正しく初期化されていない場合。 | WEAVE_ERROR_NO_MEMORY | PacketBufferの割り当てに失敗した場合。 | WEAVE_NO_ERROR | 成功時。 | other | デバイスがネットワーク完了の追加メッセージを送信できないエラーが発生したことを示すその他のウィーブまたはプラットフォーム固有のエラーコード。 |
|
SendGetNetworksComplete
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 | デバイスがGetNetworksCompleteメッセージを送信できないエラーが発生したことを示すその他のWeaveまたはプラットフォーム固有のエラーコード。 |
|
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
)
スキャンの結果を含むネットワークスキャン完了応答メッセージを送信します。
| 詳細 | | パラメーター | [in] resultCount | スキャン結果の数。 | [in] scanResultsTLV | スキャン結果。 |
|
| 戻り値 | WEAVE_ERROR_INCORRECT_STATE | ネットワークプロビジョニングサーバーが正しく初期化されていない場合。 | WEAVE_ERROR_BUFFER_TOO_SMALL | 結果バッファが十分に大きくない場合。 | WEAVE_NO_ERROR | 成功時。 | other | デバイスがスキャン完了応答を送信できないエラーが発生したことを示すその他のウィーブまたはプラットフォーム固有のエラーコード。 |
|
SendStatusReport
virtual WEAVE_ERROR SendStatusReport(
uint32_t statusProfileId,
uint16_t statusCode,
WEAVE_ERROR sysError
)
リクエストに対するステータスレポートの応答を送信します。
| 詳細 | | パラメーター | [in] statusProfileId | このステータスレポートに関連する織りプロファイルID。 | [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 | デバイスが成功応答を送信できないエラーが発生したことを示すその他のWeaveまたはプラットフォーム固有のエラーコード。 |
|
SetDelegate
void SetDelegate(
NetworkProvisioningDelegate *delegate
)
Network ProvisioningServerイベントを処理するようにデリゲートを設定します。
| 詳細 | | パラメーター | [in] delegate | ネットワークプロビジョニングデリゲートへのポインタ。 |
|
シャットダウン
WEAVE_ERROR Shutdown(
void
)
ネットワークプロビジョニングサーバーをシャットダウンします。
