nl::Weave::WeaveServerBase

#include <src/lib/core/WeaveServerBase.h>

Weave プロファイルの非要請型応答者（サーバー）を実装するための共通の基本オブジェクト。認証済みリクエストの検証とステータスレポートの送信をカプセル化し、ファブリックの状態とエクスチェンジマネージャーに共通のデータメンバーストレージを提供します。

概要

継承

パブリック属性
`ExchangeMgr`	`WeaveExchangeManager *` [読み取り専用] Exchange マネージャーオブジェクト
`FabricState`	`WeaveFabricState *` [読み取り専用] Fabric 状態オブジェクト

静的パブリック関数
`SendStatusReport(ExchangeContext *ec, uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)`	`WEAVE_ERROR` 指定されたプロファイルのステータスコードとシステムエラーを含む、デフォルトのメッセージフラグを含む Weave ステータスレポートを、指定されたエクスチェンジのイニシエータに送信します。
`SendStatusReport(ExchangeContext *ec, uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError, uint16_t sendFlags)`	`WEAVE_ERROR` 指定されたプロファイルのステータスコードとシステムエラーを含む、指定されたメッセージフラグを含む Weave ステータスレポートを、指定されたエクスチェンジのイニシエータに送信します。

プロテクト関数
`EnforceAccessControl(ExchangeContext ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo msgInfo, WeaveServerDelegateBase *delegate)`	`bool` Weave サーバーへの受信リクエストメッセージを受け入れるか破棄するかを決定します。
`WeaveServerBase(void)`

パブリック属性

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[読み取り専用] Exchange マネージャーオブジェクト

FabricState

WeaveFabricState * FabricState

[読み取り専用] Fabric 状態オブジェクト

静的パブリック関数

SendStatusReport

WEAVE_ERROR SendStatusReport(
  ExchangeContext *ec,
  uint32_t statusProfileId,
  uint16_t statusCode,
  WEAVE_ERROR sysError
)

デフォルトのメッセージフラグ付きの Weave ステータスレポートを、指定したプロファイルのステータスコードとシステムエラーを含めて、指定したエクスチェンジのイニシエータに送信します。

詳細

パラメータ

`[in] ec`	ステータスレポートを送信するエクスチェンジコンテキストへのポインタ。
`[in] statusProfileId`	指定されたステータスコードのプロファイル。
`[in] statusCode`	送信するステータスコード。
`[in] sysError`	ステータスコードに関連付けられているシステムエラー。

SendStatusReport

WEAVE_ERROR SendStatusReport(
  ExchangeContext *ec,
  uint32_t statusProfileId,
  uint16_t statusCode,
  WEAVE_ERROR sysError,
  uint16_t sendFlags
)

指定されたプロファイルのステータスコードとシステムエラーを含む、指定されたメッセージフラグを含む Weave ステータスレポートを、指定されたエクスチェンジのイニシエータに送信します。

詳細

パラメータ

`[in] ec`	ステータスレポートを送信するエクスチェンジコンテキストへのポインタ。
`[in] statusProfileId`	指定されたステータスコードのプロファイル。
`[in] statusCode`	送信するステータスコード。
`[in] sysError`	ステータスコードに関連付けられているシステムエラー。
`[in] sendFlags`	送信される Weave ステータスレポートに対してアプリケーションが設定するフラグ。

プロテクト関数

EnforceAccessControl

bool EnforceAccessControl(
  ExchangeContext *ec,
  uint32_t msgProfileId,
  uint8_t msgType,
  const WeaveMessageInfo *msgInfo,
  WeaveServerDelegateBase *delegate
)

Weave サーバーに届いたリクエストメッセージを受け入れるか破棄するかを判断します。

このメソッドは、Weave サーバーの実装で、受信リクエストメッセージに拡張可能なアクセス制御ポリシーを実装するために使用することを目的としています。デリゲートオブジェクトに依存するサーバー実装では、メッセージ処理の早い段階でこのメソッドを呼び出して、メッセージ処理を続行するかどうかを判断する必要があります。

このメソッドは、指定されたデリゲートで仮想 WeaveServerDelegateBase::EnforceAccessControl() メソッドを呼び出して、メッセージのアクセス制御ポリシーを評価します。Weave サーバーデリゲートクラスと、標準サーバークラスから派生したアプリケーション固有のデリゲートでは、特定のアクセス制御ポリシーを適用するために仮想メソッドをオーバーライドする必要があります。

詳細

パラメータ

`[in] ec`	メッセージが受信された ExchangeContext。
`[in] msgProfileId`	受信したメッセージのプロフィール ID。
`[in] msgType`	受信したメッセージのメッセージタイプ。
`[in] msgInfo`	受信したメッセージに関する情報が含まれる WeaveMessageInfo 構造体。
`[in] delegate`	デフォルトのメッセージアクセス制御ポリシーをオーバーライドするために使用できる、アプリケーションから提供されるデリゲートオブジェクト。

戻り値

`true`	メッセージを承認して通常どおり処理する必要があるかどうか。
`false`	メッセージ処理を停止してメッセージを破棄する必要がある場合は、

WeaveServerBase

 WeaveServerBase(
  void
)