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

2.16.1 CosEventCommクラス

2.16.1.1 CosEventComm::PushConsumer::push()

名前

  CosEventComm::PushConsumer::push

形式

  #include  <EventService_cplus.h>
  void  CosEventComm::PushConsumer::push(
                const CORBA::Any&       data,
                CORBA::Environment&     env )
                throw( CORBA::Exception );

機能説明

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

パラメタ

  data

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

  env

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

復帰値

  正常終了した場合は、envのexceptionメンバにNULLオブジェクトリファレンスが設定されます。
  異常終了した場合は、envのexceptionメンバにSystemExceptionオブジェクト、またはUserExceptionオブジェクトのオブジェクトリファレンスが設定されます。

  ユーザ例外の場合、以下の例外が発生します。

  CosEventComm::Disconnected

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

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

2.16.1.2 CosEventComm::PushConsumer::disconnect_push_consumer()

名前

  CosEventComm::PushConsumer::disconnect_push_consumer

形式

  #include  <EventService_cplus.h>
  void  CosEventComm::PushConsumer::disconnect_push_consumer(
                CORBA::Environment&     env )
                throw( CORBA::Exception );

機能説明

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

パラメタ

  env

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

復帰値

  正常終了した場合は、envのexceptionメンバにNULLオブジェクトリファレンスが設定されます。
  異常終了した場合は、envのexceptionメンバにSystemExceptionオブジェクトのオブジェクトリファレンスが設定されます。
  システム例外の場合、“メッセージ集”の“イベントサービスから通知される例外情報/マイナーコード”および“CORBAサービスから通知される例外情報/マイナーコード”を参照し、発生したシステム例外およびマイナーコードに対する対処を行ってください。

2.16.1.3 CosEventComm::PushSupplier::disconnect_push_supplier()

名前

  CosEventComm::PushSupplier::disconnect_push_supplier

形式

  #include  <EventService_cplus.h>
  void  CosEventComm::PushSupplier::disconnect_push_supplier(
                CORBA::Environment&     env )
                throw( CORBA::Exception );

機能説明

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

パラメタ

  env

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

復帰値

  正常終了した場合は、envのexceptionメンバにNULLオブジェクトリファレンスが設定されます。
  異常終了した場合は、envのexceptionメンバにSystemExceptionオブジェクトのオブジェクトリファレンスが設定されます。
  システム例外の場合、“メッセージ集”の“イベントサービスから通知される例外情報/マイナーコード”および“CORBAサービスから通知される例外情報/マイナーコード”を参照し、発生したシステム例外およびマイナーコードに対する対処を行ってください。

2.16.1.4 CosEventComm::PullSupplier::pull()

名前

  CosEventComm::PullSupplier::pull

形式

  #include  <EventService_cplus.h>
  CORBA::Any  *CosEventComm::PullSupplier::pull(
                CORBA::Environment&     env )
                throw( CORBA::Exception );

機能説明

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

パラメタ

  env

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

復帰値

  正常終了した場合は、envのexceptionメンバにNULLオブジェクトリファレンスが設定され、サプライヤからのイベントデータが通知されます。
  異常終了した場合は、envのexceptionメンバにSystemExceptionオブジェクト、またはUserExceptionオブジェクトのオブジェクトリファレンスが設定されます。

  ユーザ例外の場合、以下の例外が発生します。

  CosEventComm::Disconnected

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

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

2.16.1.5 CosEventComm::PullSupplier::try_pull()

名前

  CosEventComm::PullSupplier::try_pull

形式

  #include  <EventService_cplus.h>
  CORBA::Any  *CosEventComm::PullSupplier::try_pull(
                CORBA::Boolean&         has_event,
                CORBA::Environment&     env )
                throw( CORBA::Exception );

機能説明

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

パラメタ

  has_event（outパラメタ）

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

  env

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

復帰値

  正常終了した場合は、envのexceptionメンバにNULLオブジェクトリファレンスが設定され、サプライヤからのイベントデータが通知されます。イベントデータを取り出せた場合は、has_eventにCORBA_TRUEが設定されます。イベントデータを取り出せなかった場合には、has_eventにCORBA_FALSEが設定されます。この場合もany型の空のイベントデータの領域が獲得されるので、取り出したany型のイベントデータの領域は、deleteを使用して領域を解放する必要があります。
  異常終了した場合は、envのexceptionメンバにSystemExceptionオブジェクト、またはUserExceptionオブジェクトのオブジェクトリファレンスが設定されます。

  ユーザ例外の場合、以下の例外が発生します。

  CosEventComm::Disconnected

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

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

注意事項

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

2.16.1.6 CosEventComm::PullSupplier::disconnect_pull_supplier()

名前

  CosEventComm::PullSupplier::disconnect_pull_supplier

形式

  #include  <EventService_cplus.h>
  void  CosEventComm::PullSupplier::disconnect_pull_supplier(
                CORBA::Environment&     env )
                throw( CORBA::Exception );

機能説明

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

パラメタ

  env

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

復帰値

  正常終了した場合は、envのexceptionメンバにNULLオブジェクトリファレンスが設定されます。
  異常終了した場合は、envのexceptionメンバにSystemExceptionオブジェクトのオブジェクトリファレンスが設定されます。
  システム例外の場合、“メッセージ集”の“イベントサービスから通知される例外情報/マイナーコード”および“CORBAサービスから通知される例外情報/マイナーコード”を参照し、発生したシステム例外およびマイナーコードに対する対処を行ってください。

2.16.1.7 CosEventComm::PullConsumer::disconnect_pull_consumer()

名前

  CosEventComm::PullConsumer::disconnect_pull_consumer

形式

  #include  <EventService_cplus.h>
  void  CosEventComm::PullConsumer::disconnect_pull_consumer(
                CORBA::Environment&     env )
                throw( CORBA::Exception );

機能説明

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

パラメタ

  env

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

復帰値

  正常終了した場合は、envのexceptionメンバにNULLオブジェクトリファレンスが設定されます。
  異常終了した場合は、envのexceptionメンバにSystemExceptionオブジェクトのオブジェクトリファレンスが設定されます。
  システム例外の場合、“メッセージ集”の“イベントサービスから通知される例外情報/マイナーコード”および“CORBAサービスから通知される例外情報/マイナーコード”を参照し、発生したシステム例外およびマイナーコードに対する対処を行ってください。

前次
Copyright FUJITSU LIMITED 2009