名前
ES-CHANNELUTIL-GET-PROXYS
形式
ENVIRONMENT DIVISION. CONFIGURATION SECTION. SPECIAL-NAMES. SYMBOLIC CONSTANT COPY SYMBOL-CONST IN CORBA. . DATA DIVISION. WORKING-STORAGE SECTION. COPY CONST IN COSEVENTCOMM. COPY CONST IN CORBA. 01 COPY CHANNELUTIL IN COSEVENTCOMM REPLACING ES-CHANNELUTIL BY OBJ. 01 COPY PROXYKIND IN COSEVENTCOMM REPLACING ES-CHANNELUTIL-PROXYKIND BY PROXY-KIND. 01 COPY ENVIRONMENT IN CORBA REPLACING CORBA-ENVIRONMENT BY ENV. 01 PROXY-DATA-SEQ-PTR USAGE POINTER. PROCEDURE DIVISION. CALL "ES-CHANNELUTIL-GET-PROXYS" USING OBJ PROXY-KIND ENV PROXY-DATA-SEQ-PTR.
機能説明
イベントチャネルに接続しているコンシューマ/サプライヤの接続情報を取得します。
この関数はイベントチャネルに接続しているコンシューマ/サプライヤの接続情報を格納する領域を獲得するため、この領域が不要になった時点で、CORBA-FREE関数を使用して領域を解放する必要があります。
パラメタ
ES-CHANNELUTILのオブジェクトリファレンス。
取得するPROXYオブジェクトのタイプ。
本パラメタに指定する値に応じて、取得する接続情報が異なります。以下に本パラメタに指定する値と復帰値情報の対応を示します。
PROXY-KINDに指定可能な値 | 復帰値情報 |
---|---|
ES-CHANNELUTIL-ALL-PROXYS | すべての接続情報を取得 |
ES-CHANNELUTIL-PROXY-CONSUMER | すべてのPROXYCONSUMERの一覧を取得 |
ES-CHANNELUTIL-PROXY-SUPPLIER | すべてのPROXYSUPPLIERの一覧を取得 |
ES-CHANNELUTIL-PROXY-PULL-CONS | COSEVENTCHANNELADMINのPROXYPULLCONSUMERの一覧を取得 |
ES-CHANNELUTIL-PROXY-PULL-SUPP | COSEVENTCHANNELADMINのPROXYPULLSUPPLIERの一覧を取得 |
ES-CHANNELUTIL-PROXY-PUSH-CONS | COSEVENTCHANNELADMINのPROXYPUSHCONSUMERの一覧を取得 |
ES-CHANNELUTIL-PROXY-PUSH-SUPP | COSEVENTCHANNELADMINのPROXYPUSHSUPPLIERの一覧を取得 |
ES-CHANNELUTIL-PROXY-PULL-C001 | COSNOTIFYCHANNELADMINのPROXYPULLCONSUMERの一覧を取得 |
ES-CHANNELUTIL-PROXY-PULL-S001 | COSNOTIFYCHANNELADMINのPROXYPULLSUPPLIERの一覧を取得 |
ES-CHANNELUTIL-PROXY-PUSH-C001 | COSNOTIFYCHANNELADMINのPROXYPUSHCONSUMERの一覧を取得 |
ES-CHANNELUTIL-PROXY-PUSH-S001 | COSNOTIFYCHANNELADMINのPROXYPUSHSUPPLIERの一覧を取得 |
ES-CHANNELUTIL-STRUCTURED-PROX | COSNOTIFYCHANNELADMINのSTRUCTUREDPROXYPULLCONSUMERの一覧を取得 |
ES-CHANNELUTIL-STRUCTURED-P001 | COSNOTIFYCHANNELADMINのSTRUCTUREDPROXYPULLSUPPLIERの一覧を取得 |
ES-CHANNELUTIL-STRUCTURED-P002 | COSNOTIFYCHANNELADMINのSTRUCTUREDPROXYPUSHCONSUMERの一覧を取得 |
ES-CHANNELUTIL-STRUCTURED-P003 | COSNOTIFYCHANNELADMINのSTRUCTUREDPROXYPUSHSUPPLIERの一覧を取得 |
ES-CHANNELUTIL-PROXYDATA構造体の各メンバには、以下の値が設定されます。
メンバ | 設定値 |
---|---|
PROXY | イベントチャネルに接続しているコンシューマ/サプライヤのオブジェクトリファレンス |
TIME | イベントチャネルに接続された時間 |
IPADDRESS | イベントチャネルに接続しているコンシューマ/サプライヤのIPアドレス |
KIND | イベントチャネルに接続しているコンシューマ/サプライヤのプロキシ種別 |
例外情報が格納される構造体。
イベントチャネルに接続しているコンシューマ/サプライヤの接続情報。
復帰値
正常終了した場合は、ENV構造体のMAJORにCORBA-NO-EXCEPTIONが設定されます。
異常終了した場合は、ENV構造体のMAJORにCORBA-SYSTEM-EXCEPTIONが設定され、ENV構造体のIDに詳細情報が設定されます。
システム例外の場合は、“メッセージ集”の“イベントサービスから通知される例外情報/マイナーコード”および“CORBAサービスから通知される例外情報/マイナーコード”を参照し、設定されたシステム例外およびマイナーコードに対する対処を行ってください。
IPv6環境のIPアドレスで運用している場合、メンバ“IPADDRESS”には“0”が格納されます。
IPv6環境で使用する場合は、ES-CHANNELUTIL-GET-PROXYS6関数を使用してください。
名前
ES-CHANNELUTIL-GET-PROXYS6
形式
ENVIRONMENT DIVISION. CONFIGURATION SECTION. SPECIAL-NAMES. SYMBOLIC CONSTANT COPY SYMBOL-CONST IN CORBA. . DATA DIVISION. WORKING-STORAGE SECTION. COPY CONST IN COSEVENTCOMM. COPY CONST IN CORBA. 01 COPY CHANNELUTIL IN COSEVENTCOMM REPLACING ES-CHANNELUTIL BY OBJ. 01 COPY PROXYKIND IN COSEVENTCOMM REPLACING ES-CHANNELUTIL-PROXYKIND BY PROXY-KIND. 01 COPY ENVIRONMENT IN CORBA REPLACING CORBA-ENVIRONMENT BY ENV. 01 PROXY-DATA6-SEQ-PTR USAGE POINTER. PROCEDURE DIVISION. CALL "ES-CHANNELUTIL-GET-PROXYS6" USING OBJ PROXY-KIND ENV PROXY-DATA6-SEQ-PTR.
機能説明
イベントチャネルに接続しているコンシューマ/サプライヤの接続情報を取得します。
IP-FORMATには、IPADDRESSがIPv6形式で格納されている場合は“1”が、IPv4形式の場合は“0”が入力されます。
この関数はイベントチャネルに接続しているコンシューマ/サプライヤの接続情報を格納する領域を獲得するため、この領域が不要になった時点で、CORBA-FREE関数を使用して領域を解放する必要があります。
パラメタ
ES-CHANNELUTILのオブジェクトリファレンス。
取得するPROXYオブジェクトのタイプ。
本パラメタに設定する値に応じて、取得する接続情報が異なります。PROXY-KINDに指定した値と復帰値情報の対応については、ES-CHANNELUTIL-GET-PROXYS関数の“PROXY-KIND値と復帰値情報の対応”を参照してください。
例外情報が格納される構造体。
イベントチャネルに接続しているコンシューマ/サプライヤの接続情報。
復帰値
正常終了した場合は、ENV構造体のMAJORにCORBA-NO-EXCEPTIONが設定され、イベントチャネルに接続しているコンシューマ/サプライヤの接続情報を返します。
異常終了した場合は、ENV構造体のMAJORにCORBA-SYSTEM-EXCEPTIONが設定され、ENV構造体のIDに詳細情報が設定されます。
システム例外の場合は、“メッセージ集”の“イベントサービスから通知される例外情報/マイナーコード”および“CORBAサービスから通知される例外情報/マイナーコード”を参照し、設定されたシステム例外およびマイナーコードに対する対処を行ってください。
IPv6環境で運用している場合は、IPv4クライアントのメンバ“IPADDRESS”にはIPv4射影アドレスが格納されます。IPv6環境で運用する設定については、“チューニングガイド”の“Interstageのチューニング”-“IPv6環境での運用について”、および“CORBAサービスの動作環境ファイル”-“config”(IP-versionパラメタ)を参照してください。
名前
ES-CHANNELUTIL-GET-CONSUMER-COUNT
形式
ENVIRONMENT DIVISION. CONFIGURATION SECTION. SPECIAL-NAMES. SYMBOLIC CONSTANT COPY SYMBOL-CONST IN CORBA. . DATA DIVISION. WORKING-STORAGE SECTION. COPY CONST IN COSEVENTCOMM. COPY CONST IN CORBA. 01 COPY CHANNELUTIL IN COSEVENTCOMM REPLACING ES-CHANNELUTIL BY OBJ. 01 COPY ENVIRONMENT IN CORBA REPLACING CORBA-ENVIRONMENT BY ENV. 01 COPY ULONG IN CORBA REPLACING CORBA-UNSIGNED-LONG BY CON-COUNT. PROCEDURE DIVISION. CALL "ES-CHANNELUTIL-GET-CONSUMER-COUNT" USING OBJ ENV CON-COUNT.
機能説明
イベントチャネルに接続しているコンシューマ数を取得します。
パラメタ
ES-CHANNELUTILのオブジェクトリファレンス。
例外情報が格納される構造体。
イベントチャネルに接続しているコンシューマ数。
復帰値
正常終了した場合は、ENV構造体のMAJORにCORBA-NO-EXCEPTIONが設定されます。
異常終了した場合は、ENV構造体のMAJORにCORBA-SYSTEM-EXCEPTIONが設定され、ENV構造体のIDに詳細情報が設定されます。
システム例外の場合は、“メッセージ集”の“イベントサービスから通知される例外情報/マイナーコード”および“CORBAサービスから通知される例外情報/マイナーコード”を参照し、設定されたシステム例外およびマイナーコードに対する対処を行ってください。
名前
ES-CHANNELUTIL-GET-SUPPLIER-COUNT
形式
ENVIRONMENT DIVISION. CONFIGURATION SECTION. SPECIAL-NAMES. SYMBOLIC CONSTANT COPY SYMBOL-CONST IN CORBA. . DATA DIVISION. WORKING-STORAGE SECTION. COPY CONST IN COSEVENTCOMM. COPY CONST IN CORBA. 01 COPY CHANNELUTIL IN COSEVENTCOMM REPLACING ES-CHANNELUTIL BY OBJ. 01 COPY ENVIRONMENT IN CORBA REPLACING CORBA-ENVIRONMENT BY ENV. 01 COPY ULONG IN CORBA REPLACING CORBA-UNSIGNED-LONG BY SUP-COUNT. PROCEDURE DIVISION. CALL "ES-CHANNELUTIL-GET-SUPPLIER-COUNT" USING OBJ ENV SUP-COUNT.
機能説明
イベントチャネルに接続しているサプライヤ数を取得します。
パラメタ
ES-CHANNELUTILのオブジェクトリファレンス。
例外情報が格納される構造体。
イベントチャネルに接続しているサプライヤ数。
復帰値
正常終了した場合は、ENV構造体のMAJORにCORBA-NO-EXCEPTIONが設定されます。
異常終了した場合は、ENV構造体のMAJORにCORBA-SYSTEM-EXCEPTIONが設定され、ENV構造体のIDに詳細情報が設定されます。
システム例外の場合は、“メッセージ集”の“イベントサービスから通知される例外情報/マイナーコード”および“CORBAサービスから通知される例外情報/マイナーコード”を参照し、設定されたシステム例外およびマイナーコードに対する対処を行ってください。
名前
ES-CHANNELUTIL-GET-QUEUE-LENGTH
形式
ENVIRONMENT DIVISION. CONFIGURATION SECTION. SPECIAL-NAMES. SYMBOLIC CONSTANT COPY SYMBOL-CONST IN CORBA. . DATA DIVISION. WORKING-STORAGE SECTION. COPY CONST IN COSEVENTCOMM. COPY CONST IN CORBA. 01 COPY CHANNELUTIL IN COSEVENTCOMM REPLACING ES-CHANNELUTIL BY OBJ. 01 COPY ENVIRONMENT IN CORBA REPLACING CORBA-ENVIRONMENT BY ENV. 01 COPY ULONG IN CORBA REPLACING CORBA-UNSIGNED-LONG BY QUEUE-LENGTH. PROCEDURE DIVISION. CALL "ES-CHANNELUTIL-GET-QUEUE-LENGTH" USING OBJ ENV QUEUE-LENGTH.
機能説明
イベントチャネルにキューイングされているイベントデータ数を取得します。
パラメタ
ES-CHANNELUTILのオブジェクトリファレンス。
例外情報が格納される構造体。
イベントチャネルにキューイングされているイベントデータ数。
復帰値
正常終了した場合は、ENV構造体のMAJORにCORBA-NO-EXCEPTIONが設定されます。
異常終了した場合は、ENV構造体のMAJORにCORBA-SYSTEM-EXCEPTIONが設定され、ENV構造体のIDに詳細情報が設定されます。
システム例外の場合は、“メッセージ集”の“イベントサービスから通知される例外情報/マイナーコード”および“CORBAサービスから通知される例外情報/マイナーコード”を参照し、設定されたシステム例外およびマイナーコードに対する対処を行ってください。
名前
ES-CHANNELUTIL-LOCAL-BEGIN
形式
ENVIRONMENT DIVISION. CONFIGURATION SECTION. SPECIAL-NAMES. SYMBOLIC CONSTANT COPY SYMBOL-CONST IN CORBA. . DATA DIVISION. WORKING-STORAGE SECTION. COPY CONST IN COSEVENTCOMM. COPY CONST IN CORBA. 01 COPY CHANNELUTIL IN COSEVENTCOMM REPLACING ES-CHANNELUTIL BY OBJ. 01 COPY OBJECT IN CORBA REPLACING CORBA-OBJECT BY PROXY. 01 COPY ENVIRONMENT IN CORBA REPLACING CORBA-ENVIRONMENT BY ENV. PROCEDURE DIVISION. CALL "ES-CHANNELUTIL-LOCAL-BEGIN" USING OBJ PROXY ENV.
機能説明
チャネルに対して、ローカルトランザクションの開始を通知します。
コンシューマの場合、ES-CHANNELUTIL-LOCAL-COMMIT関数またはES-CHANNELUTIL-LOCAL-ROLLBACK関数までの間には、以下の関数を発行することができます。
サプライヤの場合、ES-CHANNELUTIL-LOCAL-COMMIT関数またはES-CHANNELUTIL-LOCAL-ROLLBACK関数までの間には、以下の関数を発行することができます。
また、本関数発行後、ES-CHANNELUTIL-LOCAL-COMMIT関数またはES-CHANNELUTIL-LOCAL-ROLLBACK関数が発行されない場合は、ローカルトランザクションタイムアウト時間が経過した時点で、ノーティフィケーションサービスにより自動的にROLLBACKされます。
なお、本関数は、同一PROXYに対して、2重に発行できません。
パラメタ
ES-CHANNELUTILのオブジェクトリファレンス。
COSNOTIFYCHANNELADMIN-CONSUMERADMIN-OBTAIN-NOTIFICATION-PULL-SUPPLIER関数、またはCOSNOTIFYCHANNELADMIN-SUPPLIERADMIN-OBTAIN-NOTIFICATION-PUSH-CONSUMER関数で取得したオブジェクトリファレンス。
例外情報が格納される構造体。
復帰値
正常終了した場合は、ENV構造体のMAJORにCORBA-NO-EXCEPTIONが設定されます。
異常終了した場合は、ENV構造体のMAJORにCORBA-SYSTEM-EXCEPTIONが設定され、ENV構造体のIDに詳細情報が設定されます。
システム例外の場合は、“メッセージ集”の“イベントサービスから通知される例外情報/マイナーコード”および“CORBAサービスから通知される例外情報/マイナーコード”を参照し、設定されたシステム例外およびマイナーコードに対する対処を行ってください。
名前
ES-CHANNELUTIL-LOCAL-COMMIT
形式
ENVIRONMENT DIVISION. CONFIGURATION SECTION. SPECIAL-NAMES. SYMBOLIC CONSTANT COPY SYMBOL-CONST IN CORBA. . DATA DIVISION. WORKING-STORAGE SECTION. COPY CONST IN COSEVENTCOMM. COPY CONST IN CORBA. 01 COPY CHANNELUTIL IN COSEVENTCOMM REPLACING ES-CHANNELUTIL BY OBJ. 01 COPY OBJECT IN CORBA REPLACING CORBA-OBJECT BY PROXY. 01 COPY ENVIRONMENT IN CORBA REPLACING CORBA-ENVIRONMENT BY ENV. PROCEDURE DIVISION. CALL "ES-CHANNELUTIL-LOCAL-COMMIT" USING OBJ PROXY ENV.
機能説明
チャネルに対して、ローカルトランザクションの完了を通知します。
コンシューマの場合、本関数の完了時点でイベントチャネルからメッセージの受信が完了します。
サプライヤの場合、本関数の完了時点でイベントチャネルからの配信が完了します。
パラメタ
ES-CHANNELUTILのオブジェクトリファレンス。
COSNOTIFYCHANNELADMIN-CONSUMERADMIN-OBTAIN-NOTIFICATION-PULL-SUPPLIER関数、またはCOSNOTIFYCHANNELADMIN-SUPPLIERADMIN-OBTAIN-NOTIFICATION-PUSH-CONSUMER関数で取得したオブジェクトリファレンス。
例外情報が格納される構造体。
復帰値
正常終了した場合は、ENV構造体のMAJORにCORBA-NO-EXCEPTIONが設定されます。
異常終了した場合は、ENV構造体のMAJORにCORBA-SYSTEM-EXCEPTIONが設定され、ENV構造体のIDに詳細情報が設定されます。
システム例外の場合は、“メッセージ集”の“イベントサービスから通知される例外情報/マイナーコード”および“CORBAサービスから通知される例外情報/マイナーコード”を参照し、設定されたシステム例外およびマイナーコードに対する対処を行ってください。
名前
ES-CHANNELUTIL-LOCAL-ROLLBACK
形式
ENVIRONMENT DIVISION. CONFIGURATION SECTION. SPECIAL-NAMES. SYMBOLIC CONSTANT COPY SYMBOL-CONST IN CORBA. . DATA DIVISION. WORKING-STORAGE SECTION. COPY CONST IN COSEVENTCOMM. COPY CONST IN CORBA. 01 COPY CHANNELUTIL IN COSEVENTCOMM REPLACING ES-CHANNELUTIL BY OBJ. 01 COPY OBJECT IN CORBA REPLACING CORBA-OBJECT BY PROXY. 01 COPY ENVIRONMENT IN CORBA REPLACING CORBA-ENVIRONMENT BY ENV. PROCEDURE DIVISION. CALL "ES-CHANNELUTIL-LOCAL-ROLLBACK" USING OBJ PROXY ENV.
機能説明
チャネルに対して、ローカルトランザクションのキャンセルを通知します。本関数を発行することにより、ノーティフィケーションサービスのイベントチャネルはES-CHANNELUTIL-LOCAL-BEGIN関数発行前の状態に戻ります。
パラメタ
ES-CHANNELUTILのオブジェクトリファレンス。
COSNOTIFYCHANNELADMIN-CONSUMERADMIN-OBTAIN-NOTIFICATION-PULL-SUPPLIER関数、またはCOSNOTIFYCHANNELADMIN-SUPPLIERADMIN-OBTAIN-NOTIFICATION-PUSH-CONSUMER関数で取得したオブジェクトリファレンス。
例外情報が格納される構造体。
復帰値
正常終了した場合は、ENV構造体のMAJORにCORBA-NO-EXCEPTIONが設定されます。
異常終了した場合は、ENV構造体のMAJORにCORBA-SYSTEM-EXCEPTIONが設定され、ENV構造体のIDに詳細情報が設定されます。
システム例外の場合は、“メッセージ集”の“イベントサービスから通知される例外情報/マイナーコード”および“CORBAサービスから通知される例外情報/マイナーコード”を参照し、設定されたシステム例外およびマイナーコードに対する対処を行ってください。
名前
ES-CHANNELUTIL-PULL-CANCEL
形式
ENVIRONMENT DIVISION. CONFIGURATION SECTION. SPECIAL-NAMES. SYMBOLIC CONSTANT COPY SYMBOL-CONST IN CORBA. . DATA DIVISION. WORKING-STORAGE SECTION. COPY CONST IN COSEVENTCOMM. COPY CONST IN CORBA. 01 COPY CHANNELUTIL IN COSEVENTCOMM REPLACING ES-CHANNELUTIL BY OBJ. 01 COPY OBJECT IN CORBA REPLACING CORBA-OBJECT BY PROXY. 01 COPY ENVIRONMENT IN CORBA REPLACING CORBA-ENVIRONMENT BY ENV. PROCEDURE DIVISION. CALL "ES-CHANNELUTIL-PULL-CANCEL" USING OBJ PROXY ENV.
機能説明
本関数は、対象PROXYのpull待ち状態(pullおよびES-CHANNELUTIL-PULL-WAIT関数発行による待ち合わせ状態)をキャンセルします。
パラメタ
ES-CHANNELUTILのオブジェクトリファレンス。
COSNOTIFYCHANNELADMIN-CONSUMERADMIN-OBTAIN-NOTIFICATION-PULL-SUPPLIER関数で取得したオブジェクトリファレンス。
注)pullおよびES-CHANNELUTIL-PULL-WAIT関数で指定したオブジェクトリファレンスと同一のオブジェクトリファレンスを指定してください。
例外情報が格納される構造体。
復帰値
正常終了した場合は、ENV構造体のMAJORにCORBA-NO-EXCEPTIONが設定されます。
異常終了した場合は、ENV構造体のMAJORにCORBA-SYSTEM-EXCEPTIONが設定され、ENV構造体のIDに詳細情報が設定されます。
システム例外の場合は、“メッセージ集”の“イベントサービスから通知される例外情報/マイナーコード”および“CORBAサービスから通知される例外情報/マイナーコード”を参照し、設定されたシステム例外およびマイナーコードに対する対処を行ってください。
名前
ES-CHANNELUTIL-PULL-WAIT
形式
ENVIRONMENT DIVISION. CONFIGURATION SECTION. SPECIAL-NAMES. SYMBOLIC CONSTANT COPY SYMBOL-CONST IN CORBA. . DATA DIVISION. WORKING-STORAGE SECTION. COPY CONST IN COSEVENTCOMM. COPY CONST IN CORBA. 01 COPY CHANNELUTIL IN COSEVENTCOMM REPLACING ES-CHANNELUTIL BY OBJ. 01 COPY OBJECT IN CORBA REPLACING CORBA-OBJECT BY PROXY. 01 COPY ENVIRONMENT IN CORBA REPLACING CORBA-ENVIRONMENT BY ENV. PROCEDURE DIVISION. CALL "ES-CHANNELUTIL-PULL-WAIT" USING OBJ PROXY ENV.
機能説明
本関数は、対象PROXYがPULLまたはTRY-PULLでデータ取得が可能な状態となるまで待ち合わせます。関数実行後、データ取得が可能な状態となった時点で呼び出し元に復帰します。
対象PROXYがすでにPULLでデータ取得可能な状態である場合は、即時復帰します。PULLと同様、待ち合わせ時間内にデータが取得可能状態にならない場合は、タイムアウトで復帰します。
パラメタ
ES-CHANNELUTILのオブジェクトリファレンス。
COSNOTIFYCHANNELADMIN-CONSUMERADMIN-OBTAIN-NOTIFICATION-PULL-SUPPLIER関数で取得したオブジェクトリファレンス。
例外情報が格納される構造体。
復帰値
正常終了した場合は、ENV構造体のMAJORにCORBA-NO-EXCEPTIONが設定されます。
異常終了した場合は、ENV構造体のMAJORにCORBA-SYSTEM-EXCEPTIONまたはCORBA-USER-EXCEPTIONが設定され、ENV構造体のIDに詳細情報が設定されます。
ユーザ例外の場合は、以下の詳細情報が設定されます。
イベントチャネルに接続されていません。
イベントチャネル生成時にコネクション情報を自動回収する処理を有効とした場合(esmkchnlコマンド実行時に-autodisconオプションを指定した場合)は、CORBAサービスのクライアント側無通信監視時間超過によりコネクションが切断された可能性があります。継続して通信する場合は、イベントチャネルへの接続から行ってください。
システム例外の場合は、“メッセージ集”の“イベントサービスから通知される例外情報/マイナーコード”および“CORBAサービスから通知される例外情報/マイナーコード”を参照し、設定されたシステム例外およびマイナーコードに対する対処を行ってください。