C++ SDK RAII（Resource Management Is Initialization）

Related pages:

C/C++ SDK 参考資料

このページでは、C++ アプリケーションをインストゥルメント化するために C/C++ SDK で定義されている Resource Acquisition Is Initialization（RAII）関数について説明します。

C++ アプリケーションの場合、BT および ExitCall クラスを使用してインストゥルメンテーションを簡素化できます。これらのクラスでは、appd_bt_end() と appd_exitcall_end() を手動で呼び出す必要はありません。BT または ExitCall オブジェクトが有効範囲外になると、SDK がデストラクタを呼び出し、ビジネストランザクションまたは終了コールが自動で終了します。

次のコード例では、これらのクラスを使用しています。

{
   appd::sdk::BT bt("mybt");
   appd::sdk::ExitCall ec(bt, "auth");
   if (!make_auth_call())
   {
      bt.add_error(APPD_LEVEL_ERROR, "Authorization failed");
      return -1;
   }
   issue_api_call();
}

CPP

上記のコード例は、次と同等です。

{
    appd_bt_handle bt = appd_bt_begin("mybt", NULL);
    appd_exitcall_handle ec = appd_exitcall_begin(bt, "auth");
    if (!make_auth_call())
    {
       appd_bt_add_error(bt, APPD_LEVEL_ERROR, "Authorization failed", 0);
       appd_exitcall_end(ec);
       appd_bt_end(bt);
       return -1;
    }
    issue_apI_call();
    appd_exitcall_end(ec);
    appd_bt_end(bt);
}

CPP

BT の有効期間が他のオブジェクトの非決定的な有効期間に依存する場合、BT への共有ポインタを使用して BT の依存関係の有効期間を維持することができます。この例では、BT は最後の参照が完了すると終了します。

{
   //Initialize the BT with a shared pointer
   auto bt = std::make_shared<appd::sdk::BT>("compute");
   auto prod = createProducer(bt);
   auto consumers = createConsumers(bt, NUM_WORKERS);
   //Variable BT goes out of scope with no further references.
   //BT ends automatically.
}

CPP

複雑な存続期間を持つ終了コールを管理するには、スマートポインタ std::unique_ptr<appd::sdk::ExitCall> または std::shared_ptr<appd::sdk::ExitCall> の使用をご検討ください。

appd:sdk::BT

C++ アプリケーション用の RAII パターンコンストラクタ。新しいビジネストランザクションの場合、このコンストラクタはビジネストランザクションオブジェクトとそのオブジェクトへのハンドルを作成します。この関数は既存のトランザクションを継続し、相関ヘッダーが渡された場合はそれを追加します。

ビジネストランザクションオブジェクトが有効範囲外になると、SDK によって自動的にビジネストランザクションが終了します。ビジネストランザクションオブジェクトはコピーできません。

形式

appd::sdk::BT(const std::string& name) appd::sdk::BT(const std::string& name, const std::string& correlation_header) appd::sdk::BT(const char* name, const char* correlation_header=NULL)

パラメータ

name: ビジネストランザクション名。選択するコンストラクタに応じて、string& または char * として渡されます。有効な相関ヘッダーを含む現在のビジネスアプリケーションの継続トランザクションである場合は、ヘッダーの名前が SDK で使用されます。
correlation_header：オプションの相関ヘッダー。選択するコンストラクタに応じて、string& または char * として渡されます。

appd :: sdk :: Event

このクラスは、C++ でイベントを作成するために使用され、イベントを作成する便利な方法を提供します。「C/C++ SDK 参考資料」を参照してください。

形態

appd::sdk::Event::Event(const std::string& application_context, enum appd_event_severity severity, const std::string& even_sub_type, const std::string& summary, const std::map<std::string, std::string>& properties, const std::map<std::string, std::string>& details)

Parameters

application_context：この文字列は、マルチテナントモードで実行している複数のエージェントから 1 つのエージェントを選択します。この値が空の場合、デフォルトのエージェントが使用されます。
details：名前と値のペアのマップ。空のマップは有効な引数です。詳細に関連付けられた名前と値は空にできません。空にするとエラーになります。
event_sub_type：カスタムイベントのサブタイプを含む文字列。これは、特定のサブタイプに属するカスタムイベントをフィルタリングするためにコントローラで使用できます。
properties：名前と値のペアのマップ。空のマップは有効な引数です。プロパティに関連付けられた名前と値は空にできません。空にするとエラーになります。
severity：これは、イベントの重大度を表す列挙型です。有効な値は APPD_EVENT_SEVERITY_INFO、APPD_EVENT_SEVERITY_WARNING、および APPD_EVENT_SEVERITY_ERROR です。
summary：イベントの簡単な説明を含む文字列。

appd :: sdk :: Event :: report

Event クラスのこのメソッドは、appd_custom_event_end() と同等の機能です。詳細については、C/C++ SDK 参考資料を参照してください。

この関数は、イベントの定義が成功し、（コントローラに送信する）イベントのキューイングが成功した場合は、ブール値を true として返します。そうでない場合は、false を返します。

Format

appd::sdk::Event event(<arguments>);
bool status = event.report();

appd:sdk::ExitCall

C++ アプリケーション用の RAII パターンコンストラクタ。ExitCall オブジェクトが作成され、そのオブジェクトへのハンドルが作成されます。バックエンドを宣言して、それを使用して ExitCall オブジェクトをインスタンス化する前に、少なくとも 1 つの識別プロパティに割り当てる必要があります。

ExitCall オブジェクトが有効範囲外になると、SDK によって自動的に ExitCall が終了します。

ExitCallオブジェクトはコピーできません。

形式

appd::sdk::ExitCall(BT& bt, const char* backend) appd::sdk::ExitCall(BT& bt, const std::string& backend)

パラメータ

BT& bt：終了コールを行うビジネストランザクションへのハンドル。
backend：終了コールの宛先バックエンド。選択するコンストラクタに応じて、string& または char * として渡されます。

appd :: sdk :: Frame

フレームクラスを使用して、ご使用の C++ アプリケーションのコールグラフを有効にします。appd_frame_begin および appd_frame_end を呼び出す代わりに、このフレームクラスを使用して、追跡対象のメソッドをインストゥルメント化できます。次のパラメータをフレームクラスに渡す必要があります。

形式

Frame(BT& bt, appd_frame_type frame_type, const char* class_name, const char* method_name, const char* file, unsigned int line_number)

パラメータ

bt：この関数呼び出しを所有する BT オブジェクト。
frame_type：フレームのタイプ。C++ RAII コードで使用する場合は、APPD_FRAME_TYPE_CPP を使用します。
class_name：このメソッドがクラスのメンバーである場合はクラスの名前。それ以外の場合は NULL。
method_name：メソッド名。__FUNCTION__、__PRETTY_FUNCTION__、または任意の使用可能なコンパイラマクロを使用できます。
file：ソースファイルのパス。__FILE__ または任意の使用可能なコンパイラマクロを使用できます。
line_number：ソースファイルの行番号。__LINE__ または任意の使用可能なコンパイラマクロを使用できます。