名前空間

Hitachi.OpenTP1.Server

継承関係

System.Object
  +- Hitachi.OpenTP1.Server.Prf

説明

Prfクラスは，性能検証用トレース機能を提供するメソッドを提供します。

メソッドの一覧

名称	説明
GetTraceNum()	GetTraceNumメソッドを呼び出す前に取得した，最新の性能検証用トレース（prfトレース）のプロセス内取得通番を，メソッドの呼び出し元に通知します。
PutUTrace(System.Int32, System.Int32, System.Byte[])	ユーザ固有の性能検証用トレース（prfトレース）を取得します。

●GetTraceNum

説明

GetTraceNumメソッドを呼び出す前に取得した，最新の性能検証用トレース（prfトレース）のプロセス内取得通番を，メソッドの呼び出し元に通知します。

GetTraceNumメソッドを呼び出したプロセスで一度も性能検証用トレースを取得していない場合，プロセス内取得番号は0となります。

宣言

【C#の場合】

public static int GetTraceNum(
);

【Visual Basicの場合】

Public Shared Function GetTraceNum( _
) As Integer

【J#の場合】

public static int GetTraceNum(
);

パラメタ

なし

戻り値

• 0
  一度も性能検証用トレースを取得していません。
  
• 正の整数
  最新の性能検証用トレースのプロセス内取得通番。
  

例外

Hitachi.OpenTP1.Server.TP1ServerException

次の情報が出力されます。

• メッセージ
  例外の内容が出力されます。
  OpenTP1提供関数内でエラーが発生した場合は，次のように出力されます。
  "OpenTP1提供関数実行時にエラーが発生しました。"
  それ以外の場合は，各エラーに対応したメッセージが出力されます。
  
• クラス名
  例外が発生したクラス名が出力されます。
  
• メソッド名
  例外が発生したメソッド名が出力されます。
  
• エラーコード
  発生原因に応じ，次のエラーコードが出力されます。
  

  エラーコード	説明
  DCPRFER_PARAM	引数に指定した値が間違っています。

　

●PutUTrace

説明

ユーザ固有の性能検証用トレース（prfトレース）を取得します。

宣言

【C#の場合】

public static void PutUTrace(
  int eventId,
  int dataLength,
  byte[] traceBuffer
);

【Visual Basicの場合】

Public Shared Sub PutUTrace( _
  ByVal eventId As Integer, _
  ByVal dataLength As Integer, _
  ByVal traceBuffer() As Byte _
)

【J#の場合】

public static void PutUTrace(
  int eventId,
  int dataLength,
  ubyte[] traceBuffer
);

パラメタ

eventId

取得するイベントのイベントIDを設定します。

使用できるイベントIDの範囲は0x0001〜0x0040です。

dataLength

取得するトレースデータのデータ長を設定します。

設定できるデータ長は4バイト以上256バイト以下です。また，このデータ長は4バイトの倍数でなければなりません。

traceBuffer

取得するトレースデータの設定されているバイト配列を設定します。

戻り値

なし

例外

Hitachi.OpenTP1.Server.TP1ServerException

次の情報が出力されます。

• メッセージ
  例外の内容が出力されます。
  OpenTP1提供関数内でエラーが発生した場合は，次のように出力されます。
  "OpenTP1提供関数実行時にエラーが発生しました。"
  それ以外の場合は，各エラーに対応したメッセージが出力されます。
  
• クラス名
  例外が発生したクラス名が出力されます。
  
• メソッド名
  例外が発生したメソッド名が出力されます。
  
• 引数名（OpenTP1提供関数呼び出し前の引数チェックでエラーになった場合にだけ出力）
  例外が発生する原因となった引数名が出力されます。
  
• エラーコード
  発生原因に応じ，次のエラーコードが出力されます。
  

  エラーコード	説明
  DCPRFER_PARAM	引数に指定した値に誤りがあります。

注意事項

PutUTraceメソッドが正常終了してもトレースが正しく取得されているとは限りません。これは，トレースの取得処理で，排他を使用しないため複数のプロセスから同時に取得要求が出された場合，データを紛失してしまうことがあるためです。