cniPropagate

この関数を使用して、指定したターミナル・オブジェクトにメッセージを伝搬します。 ターミナルがコネクターによって他のノードに付加されていない場合には、メッセージは伝搬されず、この関数は無視されます。

したがって、このシナリオでノードに異なるアクションを取らせたい場合を除いて、メッセージの伝搬の前にターミナルが付加されているかどうかを検査する必要はありません。 必要に応じて、この関数を呼び出す前に cniIsTerminalAttached を使用し、ターミナルが接続されているかを検査することができます。

構文

int cniPropagate(
  int*          returnCode,
  CciTerminal*  terminalObject,
  CciMessage*   localEnvironment,
  CciMessage*   exceptionList,
  CciMessage*   message);

パラメーター

returnCode
関数からの戻りコード (出力)。
考えられる戻りコードは以下のとおりです。
  • CCI_SUCCESS
  • CCI_EXCEPTION
  • CCI_INV_TERMINAL_OBJECT
  • CCI_INV_MESSAGE_OBJECT
terminalObject
メッセージを受け取る出力ターミナルのアドレス (入力)。 このアドレスは、cniCreateOutputTerminal によって戻されます。
localEnvironment
メッセージと共に送信されるローカル環境オブジェクトのアドレス (入力)。

このメッセージ・オブジェクトは、ブローカーによって提供されるパブリッシュ/サブスクライブ・ノードによって使用されます。

旧バージョンとの互換性のために、このパラメーターを destinationList として参照することができます。

exceptionList
メッセージの例外リストのアドレス (入力)。
message
送信するメッセージ・オブジェクトのアドレス (入力)。 送信されるメッセージが入力メッセージと同じ場合には、 このアドレスが、cniEvaluate インプリメンテーション関数に渡されるものになります。

戻り値

成功した場合、CCI_SUCCESS が戻されます。 失敗した場合、CCI_FAILURE が戻され、returnCode パラメーターがエラーの理由を示します。

例

  if (terminalObject) {
    if (cniIsTerminalAttached(&rc, terminalObject)) {
      if (rc == CCI_SUCCESS) {
        cniPropagate(&rc, terminalObject, destinationList, exceptionList, message);
特記事項 | 商標 | ダウンロード | ライブラリー | サポート | フィードバック

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

        
        最終更新
        
        最終更新 : 2013-02-27 19:21:39


参照トピック参照トピック | バージョン 8.0.0.2 | as07620_