ページの先頭行へ戻る
Interstage Application Server リファレンスマニュアル(API編)
第1章 C言語インタフェース > 1.16 イベントサービスインタフェース > 1.16.1 CosEventCommインタフェース
前次

1.16.1 CosEventCommインタフェース

1.16.1.1 CosEventComm_PushConsumer_push()

名前

  CosEventComm_PushConsumer_push

形式

  #include  <EventService.h>
  void  CosEventComm_PushConsumer_push(
                CosEventComm_PushConsumer  obj, 
                CORBA_any                 *data, 
                CORBA_Environment         *env );

機能説明

  dataで指定されたイベントデータをコンシューマに送信します。

パラメタ

  obj

  CosEventChannelAdmin_SupplierAdmin_obtain_push_consumer()が返すオブジェクトリファレンス。

  data

  コンシューマに送信するイベントデータ。

  env

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

復帰値

  正常終了した場合は、env構造体の_majorにCORBA_NO_EXCEPTIONが設定されます。
  異常終了した場合は、env構造体の_majorにCORBA_SYSTEM_EXCEPTIONまたはCORBA_USER_EXCEPTIONが設定され、env構造体の_idに詳細情報が設定されます。

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

  ex_CosEventComm_Disconnected

  イベントチャネルに接続されていません。
  イベントチャネル生成時にコネクション情報を自動回収する処理を有効とした場合（esmkchnlコマンド実行時に-autodisconオプションを指定した場合）は、CORBAサービスのクライアント側無通信監視時間超過によりコネクションが切断された可能性があります。継続して通信する場合は、イベントチャネルへの接続から行ってください。

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

1.16.1.2 CosEventComm_PushConsumer_disconnect_push_consumer()

名前

  CosEventComm_PushConsumer_disconnect_push_consumer

形式

  #include  <EventService.h> 
  void  CosEventComm_PushConsumer_disconnect_push_consumer(
                CosEventComm_PushConsumer  obj, 
                CORBA_Environment          *env );

機能説明

  サプライヤからイベント通信の終了を宣言します。

パラメタ

  obj

  CosEventChannelAdmin_SupplierAdmin_obtain_push_consumer()が返すオブジェクトリファレンス。

  env

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

復帰値

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

1.16.1.3 CosEventComm_PushSupplier_disconnect_push_supplier()

名前

  CosEventComm_PushSupplier_disconnect_push_supplier

形式

  #include  <EventService.h> 
  void  CosEventComm_PushSupplier_disconnect_push_supplier(
                CosEventComm_PushSupplier  obj, 
                CORBA_Environment          *env );

機能説明

  コンシューマからイベント通信の終了を宣言します。

パラメタ

  obj

  CosEventChannelAdmin_ConsumerAdmin_obtain_push_supplier()が返すオブジェクトリファレンス。

  env

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

復帰値

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

1.16.1.4 CosEventComm_PullSupplier_pull()

名前

  CosEventComm_PullSupplier_pull

形式

  #include  <EventService.h> 
  CORBA_any  *CosEventComm_PullSupplier_pull(
                CosEventComm_PullSupplier  obj, 
                CORBA_Environment          *env );

機能説明

  サプライヤにイベントデータを要求します。イベントデータの取り出しが可能になるか、または例外が発生するまでブロックされます。なお、イベントデータを取り出せない場合に即時復帰したい場合は、CosEventComm_PullSupplier_try_pull()を使用してください。
  取り出したany型のイベントデータは、この領域が不要になった時点で、CORBA_free()を使用して領域を解放する必要があります。

パラメタ

  obj

  CosEventChannelAdmin_ConsumerAdmin_obtain_pull_supplier()が返すオブジェクトリファレンス。

  env

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

復帰値

  正常終了した場合は、env構造体の_majorにCORBA_NO_EXCEPTIONが設定され、サプライヤからのイベントデータが復帰します。
  異常終了した場合は、env構造体の_majorにCORBA_SYSTEM_EXCEPTIONまたはCORBA_USER_EXCEPTIONが設定され、env構造体の_idに詳細情報が設定されます。

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

  ex_CosEventComm_Disconnected

  イベントチャネルに接続されていません。
  イベントチャネル生成時にコネクション情報を自動回収する処理を有効とした場合（esmkchnlコマンド実行時に-autodisconオプションを指定した場合）は、CORBAサービスのクライアント側無通信監視時間超過によりコネクションが切断された可能性があります。継続して通信する場合は、イベントチャネルへの接続から行ってください。

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

1.16.1.5 CosEventComm_PullSupplier_try_pull()

名前

  CosEventComm_PullSupplier_try_pull

形式

  #include  <EventService.h> 
  CORBA_any  *CosEventComm_PullSupplier_try_pull(
                CosEventComm_PullSupplier  obj, 
                CORBA_boolean              *has_event, 
                CORBA_Environment          *env );

機能説明

  サプライヤにイベントデータを要求します。サプライヤからイベントデータを取り出せない場合は即座に復帰します。なお、イベントデータを取り出せるまでブロックしたい場合には、CosEventComm_PullSupplier_pull()を使用してください。
  取り出したany型のイベントデータは、この領域が不要になった時点で、CORBA_free()を使用して領域を解放する必要があります。

パラメタ

  obj

  CosEventChannelAdmin_ConsumerAdmin_obtain_pull_supplier()が返すオブジェクトリファレンス。

  has_event（outパラメタ）

  イベントデータを取り出せた場合は、CORBA_TRUEが設定されます。
  イベントデータを取り出せなかった場合は、CORBA_FALSEが設定されます。

  env

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

復帰値

  正常終了した場合は、env構造体の_majorにCORBA_NO_EXCEPTIONが設定されます。イベントデータを取り出せた場合は、has_eventにCORBA_TRUEが設定され、サプライヤからのイベントデータが復帰します。イベントデータを取り出せなかった場合には、has_eventにCORBA_FALSEが設定されます。この場合も空のany型のイベントデータの領域が獲得されるので、取り出したany型のイベントデータの領域は、CORBA_free()を使用して領域を解放する必要があります。
  異常終了した場合は、env構造体の_majorにCORBA_SYSTEM_EXCEPTIONまたはCORBA_USER_EXCEPTIONが設定され、env構造体の_idに詳細情報が設定されます。

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

  ex_CosEventComm_Disconnected

  イベントチャネルに接続されていません。
  イベントチャネル生成時にコネクション情報を自動回収する処理を有効とした場合（esmkchnlコマンド実行時に-autodisconオプションを指定した場合）は、CORBAサービスのクライアント側無通信監視時間超過によりコネクションが切断された可能性があります。継続して通信する場合は、イベントチャネルへの接続から行ってください。

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

注意事項

  ローカルトランザクション運用中に、has_eventにCORBA_FALSEが設定された場合は、ES_ChannelUtil_local_rollback()によりキャンセルを通知する必要はありません。ES_ChannelUtil_local_commit()により完了を通知してください。
  グローバルトランザクション運用中に、has_eventにCORBA_FALSEが設定された場合は、CosTransactions_Current_rollback()によりキャンセルを通知する必要はありません。CosTransactions_Current_commit()により完了を通知してください。

1.16.1.6 CosEventComm_PullSupplier_disconnect_pull_supplier()

名前

  CosEventComm_PullSupplier_disconnect_pull_supplier

形式

  #include  <EventService.h> 
  void  CosEventComm_PullSupplier_disconnect_pull_supplier(
                CosEventComm_PullSupplier  obj, 
                CORBA_Environment          *env );

機能説明

  コンシューマからイベント通信の終了を宣言します。

パラメタ

  obj

  CosEventChannelAdmin_ConsumerAdmin_obtain_pull_supplier()が返すオブジェクトリファレンス。

  env

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

復帰値

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

1.16.1.7 CosEventComm_PullConsumer_disconnect_pull_consumer()

名前

  CosEventComm_PullConsumer_disconnect_pull_consumer

形式

  #include  <EventService.h> 
  void  CosEventComm_PullConsumer_disconnect_pull_consumer(
                CosEventComm_PullConsumer  obj, 
                CORBA_Environment          *env );

機能説明

  コンシューマからイベント通信の終了を宣言します。

パラメタ

  obj

  CosEventChannelAdmin_SupplierAdmin_obtain_pull_consumer()が返すオブジェクトリファレンス。

  env

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

復帰値

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

前次
Copyright FUJITSU LIMITED 2009