.NETInput ノードのメソッド

.NETInput ノードで実装できるメソッドは、ポーリングとイベントのどちらのスタイルのメッセージ・フローを使用するかによって決まります。

.NETInput ノードの API は コネクター API と呼ばれます。この API は IBM.Broker.Plugin.Connector ネーム・スペースにあります。

Initialize
Initialize メソッドは、.NETInput ノードを含むメッセージ・フローが統合サーバー (実行グループ)にデプロイされたときに呼び出されます。 例外が Initialize からスローされた場合は、フローのデプロイメントがロールバックされます。

開始
.NETInput ノードによるデータの取得元である終端システムへの必要な接続を作成する場合は、Start メソッドを使用します。 このメソッドは、.NETInput ノードを含むメッセージ・フローが正常にデプロイされたときに、Initialize メソッドの後に呼び出されます。

Start メソッドが例外をスローした場合は、メッセージ・フローのデプロイメント結果には影響はありません。このような例外ではシステム・ログにエラーが報告され、しばらく待つと、Start メソッドが再度呼び出されます。

イベント・コネクター

MSMQ アプリケーションから .NETInput ノードまでの入力のダイアグラム

イベント・ドリブン・スタイルの .NETInput ノードを使用する場合は、.NETInput ノードを起動する、イベントのソースであるアプリケーションにユーザー定義の代行者を登録する必要があります。イベント・ドリブン・スタイルを使用する場合に Start メソッドで代行者を登録しないと、.NETInput ノードはデータを メッセージ・フロー スレッドに伝搬できません。User Delegate メソッドは、NBEvent オブジェクトを作成し、それらを NBEventConnector クラスで提供される DeliverEvent メソッドに渡すためのものです。DeliverEvent メソッドはデータをメモリー内のキューに入れ、メッセージ・フロー・スレッドはこのキューにアクセスし、NBEvent オブジェクトのデータを渡します。

ReadData

ポーリング・ドリブン・コネクター

.NETInput ノードが MSMQ キューに ReadData() を送り返す場合の MSMQ 構成例のダイアグラム。

ポーリング・スタイルの .NETInput ノードを使用する場合は、NBPollingConnector 基本クラスの ReadData メソッドを実装する必要があります。ReadData メソッドはブローカーの内部コードによって呼び出されるため、.NETInput ノードのデベロッパーはメソッドを実装するだけであり、メソッドを実際に呼び出すコードを提供する必要はありません。したがって、.NETInput は再帰的ポーリング・ロジックを実装するためのものではないため、ループをコード化したり、Sleep メソッドを ReadData の一部として使用したりする必要はなく、またそれに適してもいません。

Start メソッドが例外を返さずに戻ったら、メッセージ・フローがデプロイを終了した後で、ブローカーによって ReadData メソッドが自動的に実行されます。

ReadData メソッドは、データ・ソースからデータ (使用可能な場合) を取得するためのものであり、NBPollingResult オブジェクトのインスタンスを返します。 データが使用可能な場合は、返される NBPollingResult オブジェクトは組み込み NBByteArrayPollingResult (バイト配列から直接出力メッセージを作成) またはユーザー定義サブクラス (このサブクラスからメッセージ・ツリーを手動で作成可能) です。

ReadData メソッドでのポーリングの使用例については、以下のダイアグラムを参照してください。

待機間隔を含む、ポーリング・スタイルの .NETInput ノードのフロー・スレッド・ダイアグラム。

使用可能なデータがない場合は、ノードのデベロッパーが NBTimeoutPollingResult を返します。 ReadData メソッドによるタイムアウト期間 (T1) の経過の待機が終了したら、NBTimeoutPollingResult の単一引数コンストラクターを使用します。データ・ソースで時間待ちが許可されない場合は、2 つの引数のコンストラクターを使用して、ブローカーにタイムアウト値を戻します。この場合、ブローカーはこのタイムアウト間隔 (T2) を待機してから、ReadData を再度呼び出します。 このようにメソッドを使用することで、.NETInput ノードのデベロッパーはポーリング間の間隔 (T2) を制御できます。

例えば、ReadData メソッドを 1 時間に 1 回、または 1 日に 1 回だけ呼び出すことを要求する、バッチ・スタイルの操作を実装することができます。

Finish
Finish メソッドは、コネクターを使用している .NETInput ノードがデータの受信を停止する必要がある場合に呼び出されます。統合サーバー にデプロイされた .NETInput ノードを含むメッセージ・フローを削除すると、Terminate メソッドの前に Finish メソッドが呼び出されます。Finish メソッドが例外をスローすると、エラーがシステム・ログに報告され、コネクターが停止状態になります。このメソッドは、接続やハンドルなどを閉じるのに適切なものです。

Terminate
Terminate メソッドは、.NETInput ノードを含むメッセージ・フローが統合サーバーから削除されたときに呼び出されます。.NETInput ノードを含むデプロイ済みのメッセージ・フローを削除する前に何らかのアクションを実行する場合、このメソッドではコードを完全に終了する方法が常に提供されます。

特記事項 | 商標 | ダウンロード | ライブラリー | サポート | フィードバック

Copyright IBM Corporation 1999, 2013Copyright IBM Corporation 1999, 2013.

        
        最終更新:
        
        最終更新: 2013-07-17 15:20:32


参照トピック参照トピック | IBM Integration Bus バージョン 9.0.0.0 | bc34237_