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

4.18.1 ロードバランスオプションインタフェース

4.18.1.1 ISOD-LBO-CREATE-LBG

名前

  ISOD-LBO-CREATE-LBG

形式

ENVIRONMENT DIVISION.
   CONFIGURATION SECTION.
   SPECIAL-NAMES.
     SYMBOLIC CONSTANT
     COPY SYMBOL-CONST IN CORBA.
     .
   DATA DIVISION.
     COPY CONST IN CORBA.
     01 COPY ISOD-LBO REPLACING ISOD-LBO BY LBO. 
     01 COPY COSNAMING-CONTEXT IN CORBA REPLACING COSNAMING-CONTEXT BY NC.
     01 COPY COSNAMING-NAME IN CORBA REPLACING COSNAMING-NAME BY N.
     01 COPY ENUM IN CORBA REPLACING CORBA-NUM BY LOADBALANCETYPE.
     01 COPY OBJECT IN CORBA REPLACING CORBA-OBJECT BY DEFAULTOBJREF.
     01 COPY ENVIRONMENT IN CORBA REPLACING CORBA-ENVIRONMENT ENV.
     01 COPY OBJECT IN CORBA REPLACING CORBA-OBJECT BY RESULT.
     
   PROCEDURE DIVISION.
     CALL "ISOD-LBO-CREATE-LBG"  USING
          LBO
          NC
          N
          LOADBALANCETYPE
          DEFAULTOBJECTREF
          ENV
          RESULT.

機能説明

  本関数は、ロードバランスオブジェクトグループを作成し、ネーミングサービスに登録します。NCで指定されたネーミングコンテキスト配下にNで指定された名前で登録します。
  ロードバランスオブジェクトグループの生成に成功した場合、復帰値として生成したロードバランスオブジェクトグループのオブジェクトリファレンスが返却されます。
  LOADBALANCETYPEには、ISOD-LBG-ROUNDROBINを指定します。
  DEFAULTOBJECTREFには、ロードバランス機能が動作していない場合に、ネーミングサービスが返却するオブジェクトリファレンス(デフォルトオブジェクトリファレンス)を指定してください。指定しない場合は、ロードバランス機能が動作していない場合には、ネーミングサービスからはオブジェクトリファレンスが返却されません。このオブジェクトリファレンスは、ISOD-LBG BINDおよび ISOD-LBG UNBINDオペレーションでは、登録および削除はできません。指定した場合は、ロードバランスオブジェクトグループ作成後に、ISOD-LBG REBIND-DEFAULTオペレーションを使用して変更することができます。
  本関数はオブジェクトリファレンスを格納する領域を獲得するため、この領域が不要になった時点で、CORBA-OBJECT-RELEASE関数を使用して領域を解放する必要があります。

復帰値

  正常終了した場合は、生成したロードバランスオブジェクトグループのオブジェクトリファレンスが返され、ENV構造体のMAJORにCORBA-NO-EXCEPTIONが設定されます。
  異常終了した場合は、ENV構造体のMAJORにCORBA-SYSTEM-EXCEPTIONまたはCORBA-USER-EXCEPTIONが設定され、ENV構造体のIDに詳細情報が設定されます。
  ユーザ例外の場合は、以下の詳細情報が設定されます。

  IDL:ISOD/LBO/NotFound:1.0

  Nで指定されたネーミングコンテキストが見つかりません。

  IDL:ISOD/LBO/CannotProceed:1.0

  NCで指定されたネーミングコンテキストが存在しません。

  IDL:ISOD/LBO/InvalidName:1.0

  名前の指定に誤りがあります。

  IDL:ISOD/LBO/AlreadyExist:1.0

  指定された名前のバインディングがすでに存在します。

  IDL:ISOD/LBO/InvalidType:1.0

  ロードバランスタイプの指定に誤りがあります。

  IDL:ISOD/LBO/BadObject:1.0

  DEFAULTOBJECTREFで指定されたオブジェクトが不当です。

  IDL:ISOD/LBO/OperationBusy:1.0

  同時処理可能な要求の上限に達しました。リトライしてください。

  システム例外の場合は、“メッセージ集”の“CORBAサービスから通知される例外情報/マイナーコード”を参照してください。

4.18.1.2 ISOD-LBO-RESOLVE-LBG

名前

  ISOD-LBO-RESOLVE-LBG

形式

ENVIRONMENT DIVISION.
   CONFIGURATION SECTION.
   SPECIAL-NAMES.
     SYMBOLIC CONSTANT
     COPY SYMBOL-CONST IN CORBA.
     .
   DATA DIVISION.
     COPY CONST IN CORBA.
     01 COPY OBJECT IN CORBA REPLACING CORBA-OBJECT BY OBJ.
     01 COPY COSNAMING-CONTEXT IN CORBA REPLACING COSNAMING-CONTEXT BY NC.
     01 COPY COSNAMING-NAME IN CORBA REPLACING COSNAMING-NAME BY N.
     01 COPY ENVIRONMENT IN CORBA REPLACING CORBA-ENVIRONMENT ENV.
     01 COPY OBJECT IN CORBA REPLACING CORBA-OBJECT BY RESULT.
   PROCEDURE DIVISION.
     CALL "ISOD-LBO-RESOLVE-LBG"  USING
          OBJ
          NC
          N
          ENV
          RESULT.

機能説明

  本関数は、ロードバランスオブジェクトグループを検索します。
  NCで指定されるネーミングコンテキスト配下のNで指定された名前のロードバランスオブジェクトグループを検索します。
  ロードバランスオブジェクトグループの検索に成功した場合、復帰値として検出したロードバランスオブジェクトグループのオブジェクトリファレンスが返却されます。
  本関数はオブジェクトリファレンスを格納する領域を獲得するため、この領域が不要になった時点で、CORBA-OBJECT-RELEASE関数を使用して領域を解放する必要があります。

復帰値

  正常終了した場合は、検出したロードバランスオブジェクトグループのオブジェクトリファレンスが返され、ENV構造体のMAJORにCORBA-NO-EXCEPTIONが設定されます。
  異常終了した場合は、ENV構造体のMAJORにCORBA-SYSTEM-EXCEPTIONまたはCORBA-USER-EXCEPTIONが設定され、ENV構造体のIDに詳細情報が設定されます。
  ユーザ例外の場合は、以下の詳細情報が設定されます。

  IDL:ISOD/LBO/NotFound:1.0

  Nで指定された名前が見つかりません。

  IDL:ISOD/LBO/CannotProceed:1.0

  NCで指定されたネーミングコンテキストが存在しません。

  IDL:ISOD/LBO/InvalidName:1.0

  名前の指定に誤りがあります。

  IDL:ISOD/LBO/OperationBusy:1.0

  同時処理可能な要求の上限に達しました。リトライしてください。

  システム例外の場合は、“メッセージ集”の“CORBAサービスから通知される例外情報/マイナーコード”を参照してください。

4.18.1.3 ISOD-LBO-DELETE-LBG

名前

  ISOD-LBO-DELETE-LBG

形式

ENVIRONMENT DIVISION.
   CONFIGURATION SECTION.
   SPECIAL-NAMES.
     SYMBOLIC CONSTANT
     COPY SYMBOL-CONST IN CORBA.
     .
   DATA DIVISION.
     COPY CONST IN CORBA.
     01 COPY OBJECT IN CORBA REPLACING CORBA-OBJECT BY OBJ.
     01 COPY COSNAMING-CONTEXT IN CORBA REPLACING COSNAMING-CONTEXT BY NC.
     01 COPY COSNAMING-NAME IN CORBA REPLACING COSNAMING-NAME BY N.
     01 COPY ENVIRONMENT IN CORBA REPLACING CORBA-ENVIRONMENT ENV.
     01 COPY OBJECT IN CORBA REPLACING CORBA-OBJECT BY RESULT.
   PROCEDURE DIVISION.
     CALL "ISOD-LBO-DELETE-LBG"  USING
          OBJ
          NC
          N
          ENV
          RESULT.

機能説明

  本関数は、ロードバランスオブジェクトグループをネーミングサービスから削除します。NCで指定されたネーミングコンテキスト配下のNで指定された名前のロードバランスオブジェクトグループが削除されます。
  復帰値は、デフォルトオブジェクトが設定されていた場合に、デフォルトオブジェクトのオブジェクトリファレンスを返却します。削除対象のロードバランスオブジェクトグループに、デフォルトオブジェクト以外のオブジェクトが登録されている場合は、例外となります。
  本関数はオブジェクトリファレンスを格納する領域を獲得するため、この領域が不要になった時点で、CORBA-OBJECT-RELEASE関数を使用して領域を解放する必要があります。

復帰値

  正常終了した場合は、デフォルトオブジェクトのオブジェクトリファレンスが返され、ENV構造体のMAJORにCORBA-NO-EXCEPTIONが設定されます。
  異常終了した場合は、ENV構造体のMAJORにCORBA-SYSTEM-EXCEPTIONまたはCORBA-USER-EXCEPTIONが設定され、ENV構造体のIDに詳細情報が設定されます。
  ユーザ例外の場合は、以下の詳細情報が設定されます。

  IDL:ISOD/LBO/NotFound:1.0

  Nで指定された名前が見つかりません。

  IDL:ISOD/LBO/CannotProceed:1.0

  NCで指定されたネーミングコンテキストが存在しません。

  IDL:ISOD/LBO/InvalidName:1.0

  名前の指定に誤りがあります。

  IDL:ISOD/LBO/NotEmpty:1.0

  オブジェクトグループに1つ以上のオブジェクトが登録されています。

  IDL:ISOD/LBO/OperationBusy:1.0

  同時処理可能な要求の上限に達しました。リトライしてください。

  システム例外の場合は、“メッセージ集”の“CORBAサービスから通知される例外情報/マイナーコード”を参照してください。

4.18.1.4 ISOD-LBO-LIST-LBG

名前

  ISOD-LBO-LIST-LBG

形式

ENVIRONMENT DIVISION.
   CONFIGURATION SECTION.
   SPECIAL-NAMES.
     SYMBOLIC CONSTANT
     COPY SYMBOL-CONST IN CORBA.
     .

   DATA DIVISION.
     COPY CONST IN CORBA.
     01 COPY OBJECT IN CORBA REPLACING CORBA-OBJECT BY OBJ.
     01 COPY COSNAMING-CONTEXT IN CORBA REPLACING COSNAMING-CONTEXT BY NC.
     01 OBJECTGROUPLIST USAGE IS POINTER.
     01 COPY ENVIRONMENT IN CORBA REPLACING CORBA-ENVIRONMENT ENV.
     PROCEDURE DIVISION.
       CALL "ISOD-LBO-LIST-LBG"  USING
            OBJ
            NC
            OBJECTGROUPLIST
            ENV.

機能説明

  本関数は、ロードバランスオブジェクトグループのリストを返却します。
  NCで指定されたネーミングコンテキスト配下のロードバランスオブジェクトグループのリストを返却します。本関数では、ロードバランスオブジェクトグループの名前とロードバランスタイプの情報を持つ構造体(BINDINGOBJECTGROUP)のシーケンスを返却します。
  本関数で獲得できるロードバランスオブジェクトグループの数の上限は、256個です。
  本関数はロードバランスオブジェクトグループのリストを格納する領域を獲得するため、この領域が不要になった時点で、CORBA-FREE関数を使用して領域を解放する必要があります。

復帰値

  正常終了した場合は、ENV構造体のMAJORにCORBA-NO-EXCEPTIONが設定されます。
  異常終了した場合は、ENV構造体のMAJORにCORBA-SYSTEM-EXCEPTIONが設定され、IDとMINORに詳細情報が設定されます。IDとMINORの意味については、“メッセージ集”の“CORBAサービスから通知される例外情報/マイナーコード”を参照してください。

注意事項

  ロードバランスオブジェクトグループが257個以上登録されている場合は、すべてのオブジェクトグループの一覧を取得することができません。

4.18.1.5 ISOD-LBO-NOTIFY-DOWN

名前

  ISOD-LBO-NOTIFY-DOWN

形式

ENVIRONMENT DIVISION.
   CONFIGURATION SECTION.
   SPECIAL-NAMES.
     SYMBOLIC CONSTANT
     COPY SYMBOL-CONST IN CORBA.
     .

   DATA DIVISION.
     COPY CONST IN CORBA.
       01 COPY OBJECT IN CORBA REPLACING CORBA-OBJECT BY OBJ.
       01 COPY COSNAMING-CONTEXT IN CORBA REPLACING COSNAMING-CONTEXT BY NC.
       01 HOSTNAME USAGE IS POINTER.
       01 COPY ENVIRONMENT IN CORBA REPLACING CORBA-ENVIRONMENT ENV.
   PROCEDURE DIVISION.
     CALL "ISOD-LBO-NOTIFY-DOWN"  USING
          OBJ
          HOSTNAME
          ENV.

機能説明

  本関数は、ロードバランス機能にサーバがダウンしたことを通知します。
  本関数が呼び出されると、HOSTNAMEで指定されたアドレスのサーバのオブジェクトのオブジェクトリファレンスの返却を停止します。

復帰値

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

  IDL:ISOD/LBO/InvalidArgument:1.0

  HOSTNAMEの指定に誤りがあります。

  IDL:ISOD/LBO/CannotProceed2:1.0

  ロードバランス機能のDBの処理で異常が発生した。

  システム例外の場合は、“メッセージ集”の“CORBAサービスから通知される例外情報/マイナーコード”を参照してください。

4.18.1.6 ISOD-LBO-NOTIFY-RECOVER

名前

  ISOD-LBO-NOTIFY-RECOVER

形式

ENVIRONMENT DIVISION.
   CONFIGURATION SECTION.
   SPECIAL-NAMES.
     SYMBOLIC CONSTANT
     COPY SYMBOL-CONST IN CORBA.
     .

   DATA DIVISION.
     COPY CONST IN CORBA.
     01 COPY OBJECT IN CORBA REPLACING CORBA-OBJECT BY OBJ.
     01 COPY COSNAMING-CONTEXT IN CORBA REPLACING COSNAMING-CONTEXT BY NC.
     01 HOSTNAME USAGE IS POINTER.
     01 COPY ENVIRONMENT IN CORBA REPLACING CORBA-ENVIRONMENT ENV.

   PROCEDURE DIVISION.
     CALL "ISOD-LBO-NOTIFY-RECOVER"  USING
          OBJ
          HOSTNAME
          ENV.

機能説明

  本関数は、ロードバランス機能にサーバが起動または復旧したしたことを通知します。
  本関数が呼び出されると、HOSTNAMEで指定されたアドレスのサーバのオペジェクトのオブジェクトリファレンスの返却を開始します。

復帰値

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

  IDL:ISOD/LBO/InvalidArgument:1.0

  HOSTNAMEの指定に誤りがあります。

  IDL:ISOD/LBO/CannotProceed2:1.0

  ロードバランス機能のDBの処理で異常が発生した。

  システム例外の場合は、“メッセージ集”の“CORBAサービスから通知される例外情報/マイナーコード”を参照してください。