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

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

ネットワーク プロビジョニング プロファイルを実装するためのサーバークラス。

概要

継承

継承元: nl::Weave::WeaveServerBase
直系の既知のサブクラス:
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl&lt;NetworkProvisioningServerImpl >
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl&lt;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
以前にスキャンしたネットワークを含む「Get Networks Complete」メッセージを送信します。
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
Network Provisioning Server のイベントを処理するように委任を設定します。
Shutdown(void)
Network Provisioning Server をシャットダウンします。

プロテクト属性

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

パブリック関数

init

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
追加されたネットワークの ID。
戻り値
WEAVE_ERROR_INCORRECT_STATE
Network Provisioning Server が正しく初期化されていない場合。
WEAVE_ERROR_NO_MEMORY
PacketBuffer の割り当てに失敗した場合。
WEAVE_NO_ERROR
成功時。
other
エラーが発生したため、デバイスからネットワークの追加完了メッセージを送信できなかったことを示す、その他の Weave またはプラットフォーム固有のエラーコード。

SendGetNetworksComplete

virtual WEAVE_ERROR SendGetNetworksComplete(
  uint8_t resultCount,
  PacketBuffer *resultsTLV
)

以前にスキャンしたネットワークを含む「Get Networks Complete」メッセージを送信します。

詳細
パラメータ
[in] resultCount
スキャン結果の数。
[in] scanResultsTLV
スキャン結果。
戻り値
WEAVE_ERROR_INCORRECT_STATE
Network Provisioning Server が正しく初期化されていない場合。
WEAVE_ERROR_BUFFER_TOO_SMALL
結果バッファのサイズが十分でない場合。
WEAVE_NO_ERROR
成功時。
other
その他の Weave またはプラットフォーム固有のエラーコード。エラーが発生したため、デバイスから「ネットワークの取得完了」メッセージを送信できませんでした。

SendGetWirelessRegulatoryConfigComplete

virtual WEAVE_ERROR SendGetWirelessRegulatoryConfigComplete(
  PacketBuffer *resultsTLV
)

GetWirelessRegulatoryConfigComplete メッセージをピアに送信します。

詳細
パラメータ
[in] resultsTLV
返される無線規制構成情報を含むパケット バッファ。
戻り値
WEAVE_ERROR_INCORRECT_STATE
Network Provisioning Server が正しく初期化されていない場合。
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
Network Provisioning Server が正しく初期化されていない場合。
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 プロファイル ID。
[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
)

Network Provisioning Server のイベントを処理するように委任を設定します。

詳細
パラメータ
[in] delegate
ネットワーク プロビジョニング委任者へのポインタ。

シャットダウン

WEAVE_ERROR Shutdown(
  void
)

Network Provisioning Server をシャットダウンします。

詳細
戻り値
WEAVE_NO_ERROR
成功時。