cciInputMessageCallback

cciInputMessageCallback 関数は、コールバックとして登録することができ、メッセージが入力ノードによって読み取られるたびに、そのメッセージがメッセージ・フローに伝搬される前に呼び出されます。

cciInputMessageCallback 関数は、ユーザー出口の状態がアクティブの場合、コールバックが登録された実行グループ内で読み取られる入力メッセージごとに呼び出されます。コールバックを登録するには、この関数へのポインターを cciRegisterUserExit に渡される CCI_UE_VFT 構造の iFpInputMessageCallback フィールドに指定します。

構文

typedef void (*cciInputMessageCallback)     ( 
                                 CciDataContext*  userContext,
                                 CciMessage*      message,
                                 CciMessage*      localEnvironment,
                                 CciMessage*      exceptionList,
                                 CciMessage*      environment,
                                 CciMessageOrigin messageOrigin,
                                 CciNode*         inputNode);

パラメーター

userContext (入力)
cciRegisterUserExit 関数に渡された値。
message
メッセージ・オブジェクトへのハンドル。 ユーザー出口コードは、このツリー内のトランスポート・ヘッダーまたはプロパティー・エレメントを更新してはなりません。 メッセージを更新すると、それ以外の方法ではメッセージ・フロー内の入力メッセージが変更されない場合には特に、パフォーマンスに影響を与えることがあります。
localEnvironment
ローカル環境オブジェクトへのハンドル。
exceptionList
例外リスト・オブジェクトへのハンドル。
environment
現行メッセージ・フローの環境オブジェクトへのハンドル。
messageOrigin
入力ノードのタイプによって、メッセージの発信元はビット・ストリーム (CCI_MESSAGE_ORIGIN_BITSTREAM) またはツリー (CCI_MESSAGE_ORIGIN_TREE) です。 ユーザー出口は、パーサーで処理を行わずに、これらのソースのいずれかにアクセスできます。 例えば、MQInput ノードの場合はビット・ストリームに安全にアクセスできるのに対し、 JMSInput ノードの場合はツリーに安全にアクセスできます。 cniBufferPointer、cniBufferSize、または cniBufferByte を呼び出して、ビット・ストリームにアクセスできます。 cniRootElement を呼び出して、通常の構文エレメント・ナビゲーション関数 (例えば、cniFirstChild) を使用して、ツリーにアクセスできます。 このパラメーターを使用すると、パーサーによる処理を行わずに安全にアクセスできる対象についてユーザー出口に通知されますが、ユーザー出口コードは、この通知を無視して構文解析のタイミングを実質的に変更する可能性があります。
inputNode
この入力メッセージを読み取る入力ノードへのハンドル。 ハンドルを使用して、cciGetNodeName、cciGetNodeType、 および cniGetBrokerInfo などの関数への呼び出しを行うことができます。

戻り値

なし。

例

void myInputMessageCallback(
                      CciDataContext*  userContext,
                      CciMessage*      message,
                      CciMessage*      localEnvironment,
                      CciMessage*      exceptionList,
                      CciMessage*      environment,
                      CciMessageOrigin messageOrigin,
                      CciNode*         inputNode){
…
…
}
特記事項 | 商標 | ダウンロード | ライブラリー | サポート | フィードバック

Copyright IBM Corporation 1999, 2012Copyright IBM Corporation 1999, 2012.

        
最終更新

        最終更新 : 2012-07-13 15:44:07


参照トピック参照トピック | バージョン 8.0.0.1 | as35950_