ソースコードのディレクトリ一覧

• src/app/contextBroker/ (メイン・プログラム)
• src/lib/logMsg/ (ロギング)
• src/lib/parseArgs/ (CLI 引数のパーシング)
• src/lib/common/ (すべてのライブラリの共通の型と関数)
• src/lib/orionTypes/ (共通タイプ)
• src/lib/rest/ (REST インタフェース、外部ライブラリ microhttpd を使用)
• src/lib/ngsi/ (一般的な NGSI タイプ)
• src/lib/ngsi10/ (一般的な NGSI10 タイプ, NGSI10 = コンテキスト管理)
• src/lib/ngsi9/ (C一般的な NGSI9 タイプ, NGSI9 = コンテキスト・アベイラビリティ管理)
• src/lib/apiTypesV2/ (NGSIv2 タイプ)
• src/lib/parse/ (ペイロード・パーシングのための共通の関数とタイプ)
• src/lib/jsonParse/ (外部ライブラリ Boost property_tree を使用した NGSIv1 リクエストの JSON ペイロードのパーシング)
• src/lib/jsonParseV2/ (外部ライブラリ rapidjson を使用して NGSIv2 リクエストの JSON ペイロードのパーシング)
• src/lib/serviceRoutines/ (NGSIv1 のサービス・ルーチン)
• src/lib/serviceRoutinesV2/ (NGSIv2 のサービス・ルーチン)
• src/lib/convenience/ (NGSIv1 のコンビニエンス・オペレーション)
• src/lib/mongoBackend/ (データベース操作の実装)
• src/lib/mongoDriver/ (MongoDB へのデータベース・インターフェース)
• src/lib/ngsiNotify/ (NGSI 通知)
• src/lib/mqtt/ (MQTT 通知)
• src/lib/alarmMgr/ (アラーム管理の実装)
• src/lib/cache/ (サブスクリプション・キャッシュの実装)
• src/lib/logSummary/ (ログ・サマリの実装)
• src/lib/metricsMgr/ (メトリック・マネージャの実装)
• src/lib/expressions/ (カスタム通知式のサポート)

src/app/contextBroker/

主なプログラムは contextBroker.cpp で、次のような目的で使用されています :

• コマンドライン・パラメータをパーシングして処理します
• Broker のライブラリを初期化します
• Broker がサポートする REST サービスを定義する、サービス・ベクタ (RestService xxxV) を設定するためには、orionRestServicesInit() をコールします。動詞/メソッドごとに1つのベクタです
• 別のスレッドで実行される REST インターフェイスを起動します

これは、コマンドライン・パラメータを追加するときに使用するファイルです。Broker の REST サービスを追加するには、同じディレクトリの orionRestServices.cpp を編集する必要があります。orionRestServices.cpp、Orion のすべてのサービスがセットアップされ、REST サービスを開始するための restInit() の呼び出しが行われます。

これらの2つの重要なトピックの詳細については、クックブックを参照してください。

トップ

src/lib/logMsg/

ログ・メッセージ・ライブラリは、ログ・ラインをログ・ファイルに書き込みます。デフォルト・ロケーションは、/tmp/contextBroker.log で、 CLI パラメータ -logDir を使用して変更できます。Broker のデバッグを支援する以外に、最も重要な作業はトランザクション・タグです。

logMsg.cpp/h の lmTransactionStart() を参照してください。Broker のデバッグについては、 traceLevels.h にある (特に -t CLI パラメータを使って設定された) トレース・レベルを見てください。また、トレースをオンにするには、トレース・レベルを設定するだけでは不十分であることに注意してください。-logLevel DEBUG オプションも使用する必要があります。

トップ

src/lib/parseArgs/

CLI パラメータのパーシングは、parseArgs ライブラリによって処理されます。その入力は PaArgument ベクトルであり、contextBroker.cpp で定義されているすべての CLI パラメータを記述します。Orion にコマンドライン・パラメータを追加する方法の詳細については、クックブックを参照してください。

トップ

src/lib/common/

共通ライブラリは、Broker のすべてのソースコードのための共通の基本的なヘルプ・モジュールを含んでいます :

• JsonHelper:NGSIv2 で JSON 出力をレンダリングするヘルパークラス
• MimeType: MimeType enum と、文字列から/への MimeType 定数のためのヘルパー関数
• RenderFormat: RenderFormat enum と、文字列から/への RenderFormat 定数のためのヘルパー関数
• SyncQOverflow: SyncQOverflow テンプレート (本当に ngsiNotify ライブラリ に属します)
• Timer: 現在の時刻を取得するためのクラス
• clockFunctions: struct timespec に加算/減算するためのヘルパー関数
• defaultValues: デフォルトのサービスパスの定義
• errorMessages: Broker がレスポンスするすべてのエラー文字列の共通の場所
• globals: 共通の定義、変数 および関数
• idCheck: サブスクリプション/レジストレーション id の妥当性チェック
• limits: 文字列の長さなどの制限の定義
• macroSubstitute: カスタム通知で使用される変数置換の関数 (実際には ngsiNotify ライブラリ に属します)
• sem: セマフォの定義と、セマフォを初期化/取得/提供する関数
• statistics: 統計情報のマクロとカウンタの時間測定
• string: 文字列パーシング/操作関数
• tag: JSON レンダリング用のマクロ/関数
• wsStrip: 先頭と末尾の空白から文字列を取り除く関数
• logTracing: ロギング・サブシステムのヘルパー関数

トップ

src/lib/orionTypes/

orionTypes ライブラリで、重要なタイプがあります。そのうちのいくつかは ngsi ライブラリにあるものと似ています :

• EntityType
• EntityTypeVector
• EntityTypeResponse
• EntityTypeVectorResponse
• QueryContextRequestVector
• QueryContextResponseVector
• UpdateContextRequestVector

これらのタイプは、NGSIv2 リクエストとレスポンスに使用されます。

ライブラリには他にもいくつかのモジュールが含まれています :

• OrionValueType は、属性/メタデータ値の "JSON タイプ" を追跡するために使用されるタイプです
• areas は、Point, Line, Box, Circle, Polygon などの幾何学的図形を含みます

トップ

src/lib/rest/

rest ライブラリは、Broker が外部ライブラリ microhttpd とやり取りする場所です。このライブラリは、受信 REST 接続とそのレスポンスに使用されます。

restInit()

rest.cpp の restInit()関数は、メイン・プログラムから (実際は、main から呼び出される orionRestServicesInit 関数から) REST サービスの非常に重要なベクトルを受け取る関数です - Broker がサポートする一連のサービスを定義するベクトル

restStart()

restart() は、microhttpd デーモン (MHD_start_daemon() を呼び出します)、IPv4 または IPv6 あるいはその両方を起動します。

おそらく、このライブラリの中で最も重要な機能は、microhttpd が接続の受信時に呼び出すコールバック関数です。この関数は connectionTreat() と呼ばれ、MHD_start_daemon() 関数のパラメータの1つです。

connectionTreat()

connectionTreat() は、microhttpd から何度でも呼ばれます。これは REST モジュール全体の中心であるため、これは非常に重要です。

microhttpd が connectionTreat() を初めて呼び出しは、REST リクエストを Broker に送信したいクライアントからの接続が受け入れられ、リクエストの最初の部分 (HTTP ヘッダを含む) が読み込まれたときです。

connectionTreat() への2回目の呼び出しはペイロード・データであり、第3、第4、第5などのペイロード・データを持つコールが存在する可能性があります。connectionTreat() への最後の呼び出しはデータ長がゼロです。7番目のパラメータ size_t* upload_data_size を参照してください。

リクエストにペイロードがない場合、connectionTreat の呼び出しは2回だけになります。

connectionTreat の7番目のパラメータは、connectionTreat へ size_t の最後の呼び出しのポインタであり、このポインタは値0を含む size_t 変数を指します。

この最後のコールバックを受信した後、ペイロードをパーシングして処理することができます。これはかなりの数のチェックの後に connectionTreat() の終わりに呼び出される orion::requestServe() によって処理されます。

リクエストの URI パラメータは、connectionTreat() の最初の呼び出しから準備ができており、値 MHD_GET_ARGUMENT_KIND を持つ第2パラメータとともに MHD 関数 MHD_get_connection_values() を使用して収集されます。HTTP ヘッダは MHD_get_connection_values() を呼び出すのと同じ方法で収集されますが、MHD_HEADER_KIND が第2のパラメーターとして使用されます。

内部的には、Broker は、HTTP ヘッダ用の ConnectionInfo タイプと URI パラメータ用の別のタイプの構造体の内部にベクトルを保持します。

microhttpd ライブラリの詳細については、gnu.orgの専用ページを参照してください。

Request flow

RQ-01: リクエストの受信

• クライアントはリクエストを送信します (ステップ1)
• connectionTreat() は、MHD (microhttpd) からの着信接続の broker コールバック関数です。このコールバックは、src/lib/rest/rest.cpp の restStart()の MHD_start_daemon() の呼び出しで設定され、クライアント・リクエストの到着時に呼び出されます (ステップ2と3)
• MHD がクライアントからペイロードを受け取る限り、コールバック関数 (connectionTreat()) はペイロードの新しいチャンクで呼び出されます (ステップ4と5)
• 最後の connectionTreat() の呼び出しは、リクエスト全体が受信されたことをクライアント・コールバックに通知することです。これは、この最後のコールバック (ステップ6) でデータ長をゼロとして送信することによって行われます
• リクエスト全体が読み込まれ、リクエストにレスポンスするまで (ステップ7)、リクエストを処理するために orion::requestServe() が呼び出されます。 図 RQ-02 を参照してください
• 制御は MHD に戻されます (ステップ8)

着信リクエストの処理

RQ-02: リクエストの処理

• orion::requestServe() は restService() を呼び出します (ステップ1)。
• また、ペイロードが存在する場合は、restService() は、payloadParse() を呼び出してペイロードのパーシングします (ステップ2)。詳細は、図 PP-01 に記載されています
• リクエストのサービス機能が引き継ぎます (ステップ3)。サービス機能は、リクエストに使用された URL パス と HTTP メソッド に基づいて選択されます。すべてのサービス関数 (lib/serviceFunctions と lib/serviceFunctionV2 にあります) を確認するには、 src/app/contextBroker/orionRestServices.cpp の RestService ベクタを参照してください
• サービス機能は、より低いレベルのサービス機能を呼び出すことができます。詳細は、サービス・ルーチン・マッピングドのキュメントを参照してください (ステップ4)
• 最後に、mongoBackend ライブラリ の関数が呼び出されます (ステップ5)。 MB 図には、さまざまなケースの詳細な説明があります
• レスポンス文字列がサービス・ルーチンによって作成され、restService() に返されます (ステップ6)
• リクエストのデータベース処理の後、レスポンスがクライアントに返されます (ステップ7)。エラーが発生した場合、たとえば パース・エラー、サポートされていない URL などの場合、エラー・レスポンスが上位レイヤから返されるため、フローは mongoBackend に達するずっと前に終了します。 MHD 関数、特に MHD_queue_response() の助けを借りて、レスポンスは restReply() 関数によって送られます
• restReply() は、MHD_queue_response() を呼び出します (ステップ8)。これはクライアントに順番にレスポンスします (ステップ9)
• mongoBackend が準備完了し、レスポンスが送信されると、サービスルーチンは restService() に戻り、MHD に戻ってきます (ステップ10)

payloadParse()

Orion へのペイロードは3種類あります :

• V1 JSON,
• V2 JSON,
• Plain Text

残りのライブラリの lib/rest/RestService.cpp にある payloadParse() 関数は fork の役割を果たし、図に示すように、適切なパーシング関数を呼び出します :

JSON パース実装は専用ライブラリにありますが、テキスト・パースは非常に簡単なので、parse ライブラリの一部です。

トップ

src/lib/ngsi/

ngsi ライブラリは ngsi9 と ngsi10 プロトコルの共通部分を構成するさまざまなペイロードのためのクラスのコレクションが含まれています。ここでは、次のような基本的なクラスが見つかります :

• EntityId
• EntityIdVector
• ContextAttribute
• ContextAttributeVector
• Metadata
• MetadataVector

メソッドと階層

これらのクラスだけでなく、ライブラリ内のngsi9, ngsi10, convenience クラスのすべてのメソッドの標準セットを持っています :

• toJson(), JSON 文字列 (NGSIv2 用) にレンダリングします。このメソッドは、レンダリング・プロセスを単純化するために、JsonObjectHelper と JsonVectorHelper を優先します。この方法では、add*() メソッドを使ってプリントする必要がある要素を追加するだけで、開始/終了の大括弧、引用符、コンマの制御を気にする必要はありません
• toJsonV1(), JSON 文字列 (NGSIv1 用) にレンダリングします
• present(), デバッグ用。オブジェクトはログ・ファイルにテキストとしてダンプされます
• release(), オブジェクトのすべての割り当てられたリソースを解放します
• check(), オブジェクトがルールに従うこと、すなわち禁止されていない文字や必須フィールドがないことなどを確認します

クラスは階層に従います。たとえば、UpdateContextRequest (ngsi10 ライブラリにある最上位の階層クラス) には EntityVector が含まれます。もちろん、EntityVector は Entity のベクトルです。

EntityVector クラスと Entity クラスはこのライブラリに属していませんが、src/lib/apiTypesV2 に属することに注意してください。一般的に、NGSIv1 は非難されているので、可能な限り NGSIv2 クラスを使用して、src/lib/ngsi 内の等価クラスの数を減らそうとします。

toJson(), check(), release() などのメソッドはツリー構造で呼び出されます。たとえば、UpdateContextRequest :

• UpdateContextRequest::check() コール :
• EntityVector::check() calls (ベクトルの各アイテム) :
  • Entity::check() calls:
    • ContextAttributeVector::check() コール (ベクトルの各アイテム) :
      • ContextAttribute::check() コール :
        • MetadataVector::check() コール (ベクトルの各アイテム) :
          • Metadata::check()

各クラスはその基本クラスのメソッドを呼び出します。上記の例は check() メソッドで作られましたが、 release(), present() などにも同じことが当てはまります。

トップ

src/lib/ngsi10/

ngsi10 ライブラリは NGSI10 (NGSIv1) リクエスト、およびレスポンスのトップ階層のクラスが含まれています :

• UpdateContextRequest
• UpdateContextResponse
• QueryContextRequest
• QueryContextResponse
• SubscribeContextRequest
• SubscribeContextResponse
• UpdateContextSubscriptionRequest
• UpdateContextSubscriptionResponse
• UnsubscribeContextRequest
• UnsubscribeContextResponse
• NotifyContextRequest (Orion から送信された、発信者からの通知リクエスト)
• NotifyContextResponse (サブスクライバーからの着信レスポンス)

ngsi ライブラリのメソッドと階層の説明を参照してください。

トップ

src/lib/ngsi9/

ただ、ngsi10 ライブラリと同様、ngsi9 ライブラリが NGSI9(NGSIv1) リクエストのトップクラスのクラスが含まれています :

• RegisterContextRequest
• RegisterContextResponse
• DiscoverContextAvailabilityRequest
• DiscoverContextAvailabilityResponse

ngsi ライブラリのメソッドと階層の説明を参照してください。

トップ

src/lib/apiTypesV2/

apiTypesV2 ライブラリは、ngsi ライブラリと同様に、クラスを含んでいます。 改善された NGSI プロトコルの NGSIv2 のための、ngsi ライブラリのような基本クラスと、ngsi9 と ngsi10 ライブラリのようなトップ階層クラスの両方のクラスをサポートしています。

これらのクラスには、階層的メソッド release(), toJson(), check() などもあります。

トップ

src/lib/parse/

parse ライブラリは、ペイロード・パーシングのすべてのタイプに共通する型と関数が含まれています。このライブラリは、Broker が JSON とは別に 最近では削除されたXML をサポートしていた時代から連想され、その内容は別のライブラリに移動され、このライブラリは削除されました。

しかし、テキストのパーシングは非常に単純な作業なので、テキスト・パーシングは独自のディレクトリ/ライブラリを持たず、共通部分に存在します。

PP-02: テキストペイロードのパーシング

• payloadParse() は、リクエストのタイプに応じて適切な処理関数を呼び出すスイッチを含む textRequestTreat() (ステップ1)を呼び出します (ステップ2)。このドキュメントを書いている時点で、Orion は単一のタイプのリクエストに対してのみ TEXT ペイロードをサポートしています。したがって、選択する処理関数 (treat function) は1つだけです。または、リクエストタイプが 'EntityAttributeValueRequest` でない場合は ERRORです
• textParseAttributeValue() は、文字列を抽出し、true, false, null などの特殊文字列をチェックし、文字列が数値かどうかを調べます。 次に、この値とその値のタイプが、その関数のパラメータである属性に設定されます

トップ

src/lib/jsonParse/

このライブラリは、NGSIv1 リクエストに対するペイロードの JSON パーシングを処理します。これは、Boostライブラリの property_treeに依存し、SAX を使用して着信 JSON テキストを ngsi クラスに変換します

このライブラリには、JsonRequest タイプのベクトルが含まれています。このベクトルは、さまざまなリクエストをパースする方法を定義しています。jsonTreat() はパーシング・メソッドを選択し、jsonParse()はパーシングのために Boost property_tree ライブラリの助けを借りて処理します。

専用ドキュメントの V1 JSON パース実装の詳細な説明を参照してください。

トップ

src/lib/jsonParseV2/

これは DOM を使用して、新しい NGSIv2 リクエスト・ペイロードがパースされる場所です。JSON ペイロードをパースするために rapidjson ライブラリが使用されていますが、rapidjson の呼び出しは別として jsonParseV2 の目的は、JSON ペイロードを表すオブジェクトのツリーを構築することです。

基本的には、ペイロードのタイプに応じて異なるパーシング・ルーチンを呼び出すスイッチである関数 jsonRequestTreat() が特に重要です。

専用のドキュメントにある V2 JSON パーシング実装の詳細な説明を参照してください。

トップ

src/lib/serviceRoutines/

serviceRoutines ライブラリは着信リクエストを処理し、最終処理のために mongoBackend ライブラリ に送信する場所です。

他の多くのサービス・ルーチンがそれらを呼び出すため、2つのサービス・ルーチンが特に重要です。詳細はサービス・ルーチン・マッピングのドキュメント を参照してください :

• postUpdateContext()
• postQueryContext()

コンテキスト・プロバイダへのクエリ/更新の転送は、これらの2つのサービス・ルーチンで実装されています。

コンテキスト・プロバイダとフォワーディングについては、その専用ドキュメントを参照してください。

関数シグネチャは、すべてのサービス・ルーチンに共通です :

std::string serviceRoutineX
(
  ConnectionInfo*            ciP,
  int                        components,
  std::vector<std::string>&  compV,
  ParseData*                 parseDataP
);

これは、すべてのサービスルーチンが rest ライブラリの restService() 関数の中で、一意の場所から呼び出されるため、このようにする必要があります。また、サービス・ルーチンは構造体RestService (restライブラリの一部)のインスタンスとして格納されます：

typedef struct RestService
{
  RequestType   request;          // The type of the request
  int           components;       // Number of components in the URL path
  std::string   compV[10];        // Vector of URL path components. E.g. { "v2", "entities" }
  std::string   payloadWord;      // No longer used (RequestType request can replace it), so, to be removed ... !
  RestTreat     treat;            // service function pointer
} RestService;

構造体の最後のフィールドは、サービス・ルーチンへの実際のポインタです。そのタイプ RestTreat は、次のように定義されます。

typedef std::string (*RestTreat)(ConnectionInfo* ciP, int components, std::vector<std::string>& compV, ParseData* reqDataP);

したがって、残りのライブラリが入ってくるリクエストのサービス・ルーチンを見つけるためには、渡された RestService のベクトルを restInit() の最初の7つのパラメータとして渡します。これらのパラメータは動詞/メソッドに一致する項目まで検索され、URL パス と RestService 項目が見つかったときに、それは RestService 項目の一部であるため、サービス・ルーチンも見つかります。

トップ

src/lib/serviceRoutinesV2/

上記の serviceRoutines ライブラリと同様に、serviceRoutinesV2 ライブラリには、NGSIv2 リクエストのサービス・ルーチンが含まれています。

いくつかの NGSIv2 サービス・ルーチンは、 mongoBackend を直接呼び出すものがあります。他のものは、より低いレベルのサービス・ルーチンに頼っています。詳細については、サービス・ルーチン・マッピングのドキュメントtを参照してください。

トップ

src/lib/convenience/

convenience ライブラリは NGSIv1 コンビニエンス・オペレーションのトップ階層のクラスが含まれています。これらのリクエストの完全なリスト、およびそれが基づいているサービス・ルーチンについては、サービス・ルーチン・マッピングのドキュメントを参照してください。

このライブラリは、ngsi9 および ngsi10 ライブラリに似ています。

トップ

src/lib/mongoBackend/

Broker のすべてのライブラリの中で最も重要なのは、mongoBackend ライブラリです。("ラッピング" ライブラリ mongoDriver を介して) データベースのやりとりがすべて行われます。このライブラリは、別のドキュメントで詳しく説明されています。

トップ

src/lib/mongoDriver/

このライブラリは MongoDB とインターフェイスし、データベース操作をドライバ・レベルと BSON データ構造でラップします。これは Mongo C ドライバ に基づいていますが、このライブラリが提供する API に依存しているため、ドライバの内部をi 無視できるのは良いことです (新しい操作または BSON 情報構造でこのライブラリを拡張する必要がある場合を除きます)。

この API は、次のクラスによって提供されます:

• orion::DBConnection: データベースへの接続の実装
• orion::DBCursor: クエリおよび集計操作によって提供される DB カーソルの実装
• 異なる BSON データ構造を実装するいくつかのクラス:
  • orion::BSONObjBuilder (orion::BSONObj のビルダー・クラス)
  • orion::BSONArayBuilder (orion::BSONArray のビルダー・クラス)
  • orion::BSONElement
  • orion::BSONDate
  • orion::OID

および以下の追加モジュール:

• mongoConnectionPool: Orion の起動時に MongoDB 接続プールを初期化し、接続を取得/解放するための関数を提供します。 詳細については、以下のセクション をご覧ください
• connectionOperations: データベース操作 (挿入、検索、更新など) のラッパー、Orion 固有の側面の追加 (データベース接続プールでの 同時実行管理、エラー処理、ロギングなど)
• safeMongo: BSON オブジェクトからフィールドを取得するための安全なメソッド

接続プール管理

モジュール mongoConnectionPool は、データベース接続プールを管理します。プールがどのように機能するかは重要であり、説明に値します。 基本的に、Orion Context Broker は、データベースへの接続のリストを保持します (mongoConnectionPool.cpp で定義された connectionPool)。 リストのサイズは -dbPoolSize CLI パラメータ (デフォルトでは10) です。リスト内の各要素は、このタイプのオブジェクトです:

typedef struct MongoConnection
{
  orion::DBConnection  connection;
  bool                 free;
} MongoConnection;

ここで、connection は実際の接続 (orion::DBConnectionオブジェクト) であり、free は、接続が現在使用されているかどうかを知るための フラグです。orion::DBConnection オブジェクトはスレッド・セーフではないため、これは重要です。そのため、Context Broker ロジックは、 同じ接続が2つのスレッドによって同時に使用されないようにする必要があります。

これを考慮に入れると、mongoConnectionPool モジュール内の主な機能は次のとおりです (これ以上ありますが、残りはメトリック・ロジックに 関連するセカンダリ・モジュールです):

• mongoConnectionPoolInit(): ContextBroker ブートストラップ・ロジックから呼び出されるプールを初期化します
• mongoPoolConnectionGet(): プールからフリーの接続を取得します
• mongoPoolConnectionRelease(): 接続を解放するため、プールに戻り、次に mongoConnectionGet() を呼び出すことで再び選択できるようになります

セマフォ・システムは、接続の使用を保護するために使用されます。詳細については、この別のドキュメント を参照してください。

注: 接続を管理するこの方法は、ネイティブ・プール管理をサポートしていない古いバージョンのドライバからのレガシーです。現在のドライバでは、 ネイティブ・プール管理が可能であるため、将来的には、ドライバのネイティブ機能を使用してコード・ベースを簡素化するように実装を変更する可能性があります。 Issue 3789 はこれについてです。

トップ

src/lib/ngsiNotify/

ngsiNotify ライブラリは、サブスクリプションへの通知が実装される場所です。エンティティが作成または変更されたとき、またはサブスクリプションが作成または変更されたときに、アクティブなサブスクリプション/エンティティがある場合、サブスクライバに通知が送信され、そのことを確認するのはこのライブラリのタスクです。 mongoBackend はいつ通知するかを決定し、ngsiNotify は、場合に応じて、外部ライブラリの助けを借りて通知を実行します:

• HTTP 通知の場合、libcurl が使用されます。実際には、 restライブラリ の関数 httpRequestSend() が使用されます
• MQTT 通知には、mosquitto が使用されます。 実際には、mqtt ライブラリ の関数が使用されます: sendMqttNotification()

このライブラリのもう1つの重要な側面は、必要に応じてスレッド・プールを使用して、通知が個別のスレッドによって送信されることです。

Orionは、CLI パラメータ -notificationMode を使用して、Orion は、通知を送信するためのスレッド・プール (-notificationMode threadpool) で開始することができます。その場合、Orion の起動中にスレッド・プールが作成され、これらのスレッドは通知キュー内の新しいアイテムを待機し、アイテムが存在するとキューから取り出して処理し、問題の通知を送信します。スレッド・プールが使用されない場合、通知が送信されるたびにスレッドが作成されます。-notificationMode のデフォルト値は "transient" です。 通知モードの詳細については、Orion 管理マニュアルのこのセクション を参照してください。

このモジュールは、属性の更新/作成により、常に processNotification() から呼び出されます (図 MD-01 を参照)。

次の4つの図は、HTTP 通知とMQTT 通知の両方の場合に、スレッド・プールがある場合とない場合の コンテキスト・エンティティ通知のプログラム・フローを示しています。

NF-01: スレッド・プールなしのエンティティ属性更新/作成に関する HTTP 通知

• SenderThreadParams オブジェクトは、通知に対応するパラメータで構築されます (ステップ 1)
• pthread_create() は、通知を送信するための新しいスレッドを作成するために呼び出され、結果を待たずに、mongoBackend に戻ります (ステップ2)
• pthread_create()は、startSenderThread() を起点とする新しいスレッドを生成します (ステップ3)
• startSenderThread() は、SenderThreadParams オブジェクトに対応する通知を送信する doNotify() 関数を呼び出します (ステップ4,5および6)。通知の受信者からのレスポンスが待機されます (タイムアウトあり)。

NF-01b: スレッド・プールなしのエンティティ属性の更新/作成に関する MQTT 通知

• 手順1から4は、前の図と同じです。違いはステップ5と6にあり、MQTT ライブラリを使用して対応する MQTT broker に通知を公開します。MQTT broker への接続が 以前に存在しなかった場合は、通知プロセスの一部として作成されます (-mqttMaxAge CLI で構成されたキープ・アライブ時間が存在するため、アイドル状態の 接続は定期的にクリーンアップされます)

NF-03: スレッド・プールによるエンティティ属性の更新/作成に関する HTTP 通知

• SenderThreadParams オブジェクトは、通知に対応するパラメータで構築されます (ステップ 1)
• 通知に関連付けられているサービスに応じて、 ServiceQueue が選択されます。通知に関連付けられたサービスのキューが 存在しない場合は、デフォルトの ServiceQueue が使用されます。選択した ServiceQueue の try_push() メソッドを 使用して、通知を適切なキューに入れます (ステップ2)
• オブジェクトが通知メッセージ・キューにプッシュされます (ステップ3)。これは、通知キュー・セマフォを使用してキュー へのアクセスを同期する SyncQOverflow::try_push() を使用して行われます (詳細については、このドキュメント を参照してください)。 キューから受信したスレッドは、できるだけ早く通知を送信します
• スレッド・プール内のワーカー・スレッドの1つがメッセージ・キューから項目をポップします (ステップ4)。これは、 通知キュー・セマフォを使用してキューへのアクセスを同期する SyncQOverflow::pop() を使用して行われます。
• ワーカー・スレッドは doNotify() 関数を呼び出します。この関数は、ポップされたキュー・アイテムの SenderThreadParam オブジェクトを取得し、対応する通知を送信します (ステップ5, 6および7)。通知の受信者からのレスポンスが待機されます (タイムアウトあり)
• その後、ワーカー・スレッドはスリープして、キュー内の新しい項目を処理する必要があるときに起きるのを待っています

NF-03b: スレッド・プールを使用したエンティティ属性の更新/作成に関する MQTT 通知

• 手順1から5は、前の図と同じです。違いはステップ6と7にあり、MQTT ライブラリを使用して対応する MQTT broker に通知を公開します。MQTT broker への接続が 以前に存在しなかった場合は、通知プロセスの一部として作成されます (-mqttMaxAge CLI で構成されたキープ・アライブ時間が存在するため、アイドル状態の 接続は定期的にクリーンアップされます)

Top

src/lib/mqtt/

このライブラリは、mosquitto 外部ライブラリに基づいて MQTT 通知を処理します。 開いている MQTT 接続の制御を維持し (-maxMqttAge キープ・アライブに基づいてアイドル状態の接続をクリーンアップ)、ngsiNotify ライブラリ で使用される sendMqttNotification を提供する MqttConnectionManager クラスのシングルトンとして実装された接続マネージャがあります。

トップ

src/lib/alarmMgr/

アラームは、ログ・ファイルに挿入される特別なログ・メッセージです。ただし、同じタイプの連続したアラームの数を記録し、すでにアクティブなときにそれらを繰り返さないようにするなど、マネージャが実装されています。この Alarm Manager は、ライブラリ alarmMgr にあります。

トップ

src/lib/cache/

効率をあげるげるために、Orion はそのサブスクリプションを RAM に保持し、この目的のためにサブスクリプション・キャッシュ・マネージャが実装されています。サブスクリプション・キャッシュの詳細は、Orion 管理マニュアルのこのセクションを参照ください。

Broker が起動すると、csubs collection の内容がデータベースから抽出され、サブスクリプション・キャッシュにデータが格納されます。サブスクリプションが更新または作成されると、サブスクリプション・キャッシュが変更されますが、データベースも変更されます。この意味で、サブスクリプション・キャッシュは "ライト・スルー (write-through)" です。

NGSIv2 GET サブスクリプションのリクエストはサブスクリプション情報をサブスクリプション・キャッシュから取得するのではなく、データベースから直接取得することに注意してください。また、アベイラビリティ・サブスクリプション (NGSI9)、コンテキスト・サブスクリプション (NGSI10) のみのキャッシュがないことにも注意してください。

サブスクリプション・キャッシュに関する詳細なドキュメントは、専用のドキュメントを参照してください。

トップ

src/lib/logSummary/

logSummary ライブラリは、アラート・マネージャ によって管理されいる、アラームのサマリーを定期的に "吐き出す"スレッドを実装しています。

この機能はデフォルトではオフになっており、CLI パラメータ -logSummary <summary period in seconds> で、orion を起動すると有効になります。

基本的には、アラート・マネージャの現在の状態の要約をコンパイルし、その情報をログ・ファイルに記録することです。

トップ

src/lib/metricsMgr/

プラットフォーム全体で同様のメトリックを使用するには、一般的なメトリックが考案され、Orion の場合は、この目的のためにマネージャが実装されました。この メトリック・マネージャは、ライブラリ metricsMgr にあります。メトリックについては、このドキュメントを参照してください。

トップ

src/lib/expressions/

カスタム通知で使用されるマクロ置換ロジック のサポートを提供します。このライブラリは、式評価の抽象化を提供し、JEXL ベースと基本置換ベースの 2 つの実装を提供します (使用する実装は、cjex ライブラリの可用性に基づいて、ビルド時に選択されます)。

トップ