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

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

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

概要

継承

継承元: nl::Weave::WeaveServerBase
直接の既知のサブクラス:
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl< NetworkProvisioningServerImpl >
  nl::Weave::DeviceLayer:mplImplI ::

コンストラクタとデストラクタ

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
ネットワーク プロビジョニング サーバーのイベントを処理するようにデリゲートを設定します。
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

パブリック関数

init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

ネットワーク プロビジョニング サーバーの状態を初期化し、ネットワーク プロビジョニング メッセージを受け取るよう登録します。

詳細
パラメータ
[in] exchangeMgr
システムの Weave Exchange マネージャーへのポインタ。
戻り値
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
エラーが発生し、「ネットワーク追加完了」メッセージを送信できないことを示すその他の Weave またはプラットフォーム固有のエラーコード。

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
エラーが発生し、「ネットワークの取得完了」メッセージを送信できないことを示すその他の 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 またはプラットフォーム固有のエラーコード。

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 プロファイル 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
)

ネットワーク プロビジョニング サーバーのイベントを処理するようにデリゲートを設定します。

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

シャットダウン

WEAVE_ERROR Shutdown(
  void
)

ネットワーク プロビジョニング サーバーをシャットダウンします。

詳細
戻り値
WEAVE_NO_ERROR
成功時。