ページの先頭行へ戻る
Interstage Application Server リファレンスマニュアル(API編)

4.14.3 EVENTFACTORYインタフェース

4.14.3.1 EVENTFACTORY-CREATE

名前

  EVENTFACTORY-CREATE

形式

  ENVIRONMENT DIVISION.
  CONFIGURATION SECTION.
  SPECIAL-NAMES.
  SYMBOLIC CONSTANT
  COPY SYMBOL-CONST IN CORBA.
  .
  
  DATA DIVISION.
  WORKING-STORAGE SECTION.
  COPY CONST IN COSEVENTCOMM.
  01 COPY EVENTFACTORY IN COSEVENTCOMM REPLACING EVENTFACTORY BY OBJ.
  01 COPY EVENTFACTORY-OPTION IN COSEVENTCOMM REPLACING EVENTFACTORY-OPTION BY EVDATA.
  COPY CONST IN CORBA.
  01 COPY OBJECT IN CORBA REPLACING CORBA-OBJECT BY RESULT.
  01 COPY STRING IN CORBA REPLACING CORBA-STRING BY CHKEY.
  01 COPY ENVIRONMENT IN CORBA REPLACING CORBA-ENVIRONMENT BY ENV.
  
  PROCEDURE DIVISION.
  CALL "EVENTFACTORY-CREATE" USING
                OBJ
                CHKEY
                EVDATA
                ENV
                RESULT.

  EVENTFACTORY-OPTION.
    02 MAX-QUEUING    PIC 9(9) COMP-5.
    02 LIFE-TIME      PIC 9(9) COMP-5.
    02 MODEL PIC 9(9) COMP-5.
      88 EVENTFACTORY-MODELANY VALUE 0.
      88 EVENTFACTORY-MODELPUSH VALUE 1.
      88 EVENTFACTORY-MODELPULL VALUE 2.
      88 EVENTFACTORY-MODELMIXED VALUE 3.

機能説明

  イベントチャネルを生成し、生成したイベントチャネルのオブジェクトリファレンスを返します。
  この関数はオブジェクトリファレンスを格納する領域を獲得するため、この領域が不要になった時点で、CORBA-OBJECT-RELEASE関数を使用して領域を解放する必要があります。

パラメタ

  OBJ

  CORBA-ORB-RESOLVE-INITIAL-REFERENCES関数のIDENTIFIERパラメタに“EVENTFACTORY-OBJECTID-FACTORY”を指定して獲得したオブジェクトリファレンス。

  CHKEY

  コンシューマ/サプライヤで共通のキーワードを、64バイト以内の文字列で指定します。
  共通のキーワードを指定することにより同じイベントチャネルのオブジェクトリファレンスが返されます。

  EVDATA

  EVENTFACTORY-OPTION構造体を指定します。
  EVENTFACTORY-OPTION構造体の各メンバには、以下の値を設定します。

メンバ

設定値

MAX-QUEUING

最大データ蓄積数。EVENTFACTORY-ES-DEFAULT-VALUEを指定した場合、イベントサービスの構成情報の設定で指定した“イベントチャネルに蓄積できるイベントデータ数の最大値”の値を使用します。

LIFE-TIME

データ保持時間(秒)。EVENTFACTORY-ES-DEFAULT-VALUEを指定した場合、イベントサービスの構成情報の設定で指定した“蓄積したイベントデータの生存時間(秒)”の値を使用します。0を指定した場合、タイムアウト監視は行いません。

MODEL

接続モデルとして以下の値を指定します。

  • EVENTFACTORY-MODELANY:接続時に決定

  • EVENTFACTORY-MODELPUSH:Pushモデル

  • EVENTFACTPRY-MODELPULL:Pullモデル

  • EVENTFACTORY-MODELMIXED:Mixedモデル

  ENV

  例外情報が格納される構造体。

  RESULT

  生成したイベントチャネルのオブジェクトリファレンスが設定されます。

復帰値

  正常終了した場合は、ENV構造体のMAJORにCORBA-NO-EXCEPTIONが設定されます。異常終了した場合は、ENV構造体のMAJORにCORBA-SYSTEM-EXCEPTIONが設定され、ENV構造体のIDに詳細情報が設定されます。
  システム例外の場合は、“メッセージ集”の“イベントサービスから通知される例外情報/マイナーコード”および“CORBAサービスから通知される例外情報/マイナーコード”を参照し、設定されたシステム例外およびマイナーコードに対する対処を行ってください。

4.14.3.2 EVENTFACTORY-CREATE-CHANNEL

名前

  EVENTFACTORY-CREATE-CHANNEL

形式

  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 EVENTFACTORY IN CORBA REPLACING EVENTFACTORY BY OBJ.
  01 COPY STRING IN CORBA REPLACING CORBA-STRING BY KEY.
  01 COPY EVENTFACTORY-OPTION IN COSEVENTCOMM REPLACING EVENTFACTORY-OPTION BY DATA.
  01 COPY EVENTFACTORY-EVENTPROPERTY IN COSEVENTCOMM REPLACING EVENTFACTORY-EVENTPROPERTY  BY PROPERTY.
  01 COPY BOOLEAN IN CORBA REPLACING CORBA-BOOLEAN CREATE.
  01 COPY ENVIRONMENT IN CORBA REPLACING CORBA-ENVIRONMENT BY ENV.
  01 COPY OBJECT IN CORBA REPLACING CORBA-OBJECT BY EVENTCHNL.

  PROCEDURE DIVISION.
  CALL "EVENTFACTORY-CREATE-CHANNEL" USING
            OBJ
            KEY
            DATA
            PROPERTY
            CREATE
            ENV
            EVENTCHNL.

  EVENTFACTORY-OPTION.
    02 MAX-QUEUING    PIC 9(9) COMP-5.
    02 LIFE-TIME         PIC 9(9) COMP-5.
    02 MODEL PIC 9(9) COMP-5.
      88 EVENTFACTORY-MODELANY VALUE 0.
      88 EVENTFACTORY-MODELPUSH VALUE 1.
      88 EVENTFACTORY-MODELPULL VALUE 2.
      88 EVENTFACTORY-MODELMIXED VALUE 3.

機能説明

  イベントチャネルを生成し、生成したイベントチャネルのオブジェクトリファレンスを返します。本関数は、生成するチャネルに対してホスト名、ポート番号を変更する場合に使用します。
  本関数は、オブジェクトリファレンスを格納する領域を獲得するため、この領域が不要になった時点で、CORBA-OBJECT-RELEASE関数を使用して領域を解放する必要があります。

パラメタ

  OBJ

  CORBA-ORB-RESOLVE-INITIAL-REFERENCES関数のIDENTIFIERパラメタに“EVENTFACTORY-OBJECTID-FACTORY”を指定して獲得したオブジェクトリファレンス。

  KEY

  コンシューマ/サプライヤで共通のキーワードを、64バイト以内の文字列で指定します。
  共通のキーワードを指定することにより同じイベントチャネルのオブジェクトリファレンスが返されます。

  DATA

  EVENTFACTORY-OPTION構造体を指定します。
  EVENTFACTORY-OPTION構造体の各メンバには、以下の値を設定します。
  なお、イベントチャネルがすでに生成されている場合、本パラメタの値は無視されます。

メンバ

設定値

MAX-QUEUING

最大データ蓄積数。EVENTFACTORY-ES-DEFAULT-VALUEを指定した場合、イベントサービスの構成情報の設定で指定した“イベントチャネルに蓄積できるイベントデータ数の最大値”の値を使用します。

LIFE-TIME

データ保持時間(秒)。EVENTFACTORY-ES-DEFAULT-VALUEを指定した場合、イベントサービスの構成情報の設定で指定した“蓄積したイベントデータの生存時間(秒)”の値を使用します。0を指定した場合、タイムアウト監視は行いません。

MODEL

接続モデルとして以下の値を指定します。

  • EVENTFACTORY-MODELANY:接続時に決定

  • EVENTFACTORY-MODELPUSH:Pushモデル

  • EVENTFACTPRY-MODELPULL:Pullモデル

  • EVENTFACTORY-MODELMIXED:Mixedモデル

  PROPERTY

  以下の値を指定します。無効なnameが指定された場合、該当レコードは無効となります。また、HOSTNAMEとPORTNUMBERのどちらか一方が設定されている場合、指定されたレコードは無効となります。
  なお、イベントチャネルがすでに生成されている場合、本パラメタの値は無視されます。

メンバ(NAME)

データ型(VALUE)

設定値

HOSTNAME

CORBA-STRING

ホスト名(64文字以内)、またはIPアドレスを指定します。

PORTNUMBER

CORBA-UNSIGNED-SHORT

ポート番号を指定します。

  CREATE

  イベントチャネルが生成された場合は、CORBA-TRUEが設定されます。
  すでに存在した場合は、CORBA-FALSEが設定されます。

  ENV

  例外情報が格納される構造体。

  EVENTCHNL

  生成されたイベントチャネルのオブジェクトリファレンス。

復帰値

  正常終了した場合は、ENV構造体のMAJORにCORBA-NO-EXCEPTIONが設定されます。
  異常終了した場合は、ENV構造体のMAJORにCORBA-SYSTEM-EXCEPTIONが設定され、ENV構造体のIDに詳細情報が設定されます。
  システム例外の場合は、“メッセージ集”の“イベントサービスから通知される例外情報/マイナーコード”および“CORBAサービスから通知される例外情報/マイナーコード”を参照し、設定されたシステム例外およびマイナーコードに対する対処を行ってください。

注意事項

4.14.3.3 EVENTFACTORY-GET-EVENT-CHANNEL

名前

  EVENTFACTORY-GET-EVENT-CHANNEL

形式

  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 EVENTFACTORY IN COSEVENTCOMM REPLACING EVENTFACTORY BY OBJ. 
  01 COPY STRING IN CORBA REPLACING CORBA-STRING BY KEY. 
  01 COPY ENVIRONMENT IN CORBA REPLACING CORBA-ENVIRONMENT BY ENV. 
  01 COPY OBJECT IN CORBA REPLACING CORBA-OBJECT BY EVENTCHNL. 

  PROCEDURE DIVISION. 
  CALL "EVENTFACTORY-GET-EVENT-CHANNEL" USING
            OBJ
            KEY
            ENV
            EVENTCHNL.

機能説明

  KEYで指定されたイベントチャネルのオブジェクトリファレンスを獲得します。

パラメタ

  OBJ

  CORBA-ORB-RESOLVE-INITIAL-REFERENCES関数のIDENTIFIERパラメタに“EVENTFACTORY-OBJECTID-FACTORY”を指定して獲得したオブジェクトリファレンス。

  KEY

  獲得するイベントチャネル名。

  ENV

  例外情報が格納される構造体。

  EVENTCHNL

  KEYで指定されたイベントチャネルのオブジェクトリファレンス。

復帰値

  正常終了した場合は、ENV構造体のMAJORにCORBA-NO-EXCEPTIONが設定されます。
  異常終了した場合は、ENV構造体のMAJORにCORBA-SYSTEM-EXCEPTIONまたはCORBA-USER-EXCEPTIONが設定され、ENV構造体のIDに詳細情報が設定されます。

  ユーザ例外の場合は、以下の詳細情報が設定されます。

  EX-EVENTFACTORY-CHANNELNOTFOUN

  指定したチャネルは存在しません。

  システム例外の場合は、“メッセージ集”の“イベントサービスから通知される例外情報/マイナーコード”および“CORBAサービスから通知される例外情報/マイナーコード”を参照し、設定されたシステム例外およびマイナーコードに対する対処を行ってください。