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

2.16.2 CosEventChannelAdminクラス

2.16.2.1 CosEventChannelAdmin::EventChannel::for_consumers()

名前

  CosEventChannelAdmin::EventChannel::for_consumers

形式

  #include  <EventService_cplus.h>
  CosEventChannelAdmin::ConsumerAdmin_ptr
  CosEventChannelAdmin::EventChannel::for_consumers(
                CORBA::Environment&     env )
                throw( CORBA::Exception );

機能説明

  コンシューマがイベントチャネルに接続するための、イベントチャネルのオブジェクトリファレンスを獲得します。
  このメソッドはオブジェクトリファレンスを格納する領域を獲得するため、この領域が不要になった時点で、CORBA::release()を使用して領域を解放する必要があります。

パラメタ

  env

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

復帰値

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

2.16.2.2 CosEventChannelAdmin::EventChannel::for_suppliers()

名前

  CosEventChannelAdmin::EventChannel::for_suppliers

形式

  #include  <EventService_cplus.h>
  CosEventChannelAdmin::SupplierAdmin_ptr
  CosEventChannelAdmin::EventChannel::for_suppliers(
                CORBA::Environment&     env )
                throw( CORBA::Exception );

機能説明

  サプライヤがイベントチャネルに接続するための、イベントチャネルのオブジェクトリファレンスを獲得します。
  このメソッドはオブジェクトリファレンスを格納する領域を獲得するため、この領域が不要になった時点で、CORBA::release()を使用して領域を解放する必要があります。

パラメタ

  env

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

復帰値

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

2.16.2.3 CosEventChannelAdmin::EventChannel::destroy()

名前

  CosEventChannelAdmin::EventChannel::destroy

形式

  #include  <EventService_cplus.h>
  void  CosEventChannelAdmin::EventChannel::destroy(
                CORBA::Environment&     env )
                throw( CORBA::Exception );

機能説明

  指定されたイベントチャネルを破壊します。

パラメタ

  env

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

復帰値

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

2.16.2.4 CosEventChannelAdmin::ConsumerAdmin::obtain_push_supplier()

名前

  CosEventChannelAdmin::ConsumerAdmin::obtain_push_supplier

形式

  #include  <EventService_cplus.h>
  CosEventChannelAdmin::ProxyPushSupplier_ptr
  CosEventChannelAdmin::ConsumerAdmin::obtain_push_supplier(
                CORBA::Environment&     env )
                throw( CORBA::Exception );

機能説明

  イベントチャネルにPushモデルのコンシューマを接続するための、イベントチャネルへのオブジェクトリファレンスを獲得します。
  このメソッドはオブジェクトリファレンスを格納する領域を獲得するため、この領域が不要になった時点で、CORBA::release()を使用して領域を解放する必要があります。

パラメタ

  env

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

復帰値

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

2.16.2.5 CosEventChannelAdmin::ConsumerAdmin::obtain_pull_supplier()

名前

  CosEventChannelAdmin::ConsumerAdmin::obtain_pull_supplier

形式

  #include  <EventService_cplus.h>
  CosEventChannelAdmin::ProxyPullSupplier_ptr
  CosEventChannelAdmin::ConsumerAdmin::obtain_pull_supplier(
                CORBA::Environment&     env )
                throw( CORBA::Exception );

機能説明

  イベントチャネルにPullモデルのコンシューマを接続するための、イベントチャネルへのオブジェクトリファレンスを獲得します。
  このメソッドはオブジェクトリファレンスを格納する領域を獲得するため、この領域が不要になった時点で、CORBA::release()を使用して領域を解放する必要があります。

パラメタ

  env

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

復帰値

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

2.16.2.6 CosEventChannelAdmin::SupplierAdmin::obtain_push_consumer()

名前

  CosEventChannelAdmin::SupplierAdmin::obtain_push_consumer

形式

  #include  <EventService_cplus.h>
  CosEventChannelAdmin::ProxyPushConsumer_ptr
  CosEventChannelAdmin::SupplierAdmin::obtain_push_consumer(
                CORBA::Environment&     env )
                throw( CORBA::Exception );

機能説明

  イベントチャネルにPushモデルのサプライヤを接続するための、イベントチャネルへのオブジェクトリファレンスを獲得します。
  このメソッドはオブジェクトリファレンスを格納する領域を獲得するため、この領域が不要になった時点で、CORBA::release()を使用して領域を解放する必要があります。

パラメタ

  env

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

復帰値

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

2.16.2.7 CosEventChannelAdmin::SupplierAdmin::obtain_pull_consumer()

名前

  CosEventChannelAdmin::SupplierAdmin::obtain_pull_consumer

形式

  #include  <EventService_cplus.h>
  CosEventChannelAdmin::ProxyPullConsumer_ptr
  CosEventChannelAdmin::SupplierAdmin::obtain_pull_consumer(
                CORBA::Environment&     env )
                throw( CORBA::Exception );

機能説明

  イベントチャネルにPullモデルのサプライヤを接続するための、イベントチャネルへのオブジェクトリファレンスを獲得します。
  このメソッドはオブジェクトリファレンスを格納する領域を獲得するため、この領域が不要になった時点で、CORBA::release()を使用して領域を解放する必要があります。

パラメタ

  env

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

復帰値

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

2.16.2.8 CosEventChannelAdmin::ProxyPushConsumer::connect_push_supplier()

名前

  CosEventChannelAdmin::ProxyPushConsumer::connect_push_supplier

形式

  #include  <EventService_cplus.h>
  void  CosEventChannelAdmin::ProxyPushConsumer::connect_push_supplier(
                CosEventComm::PushSupplier_ptr     push_supplier,
                CORBA::Environment&                env )
                throw( CORBA::Exception );

機能説明

  イベントチャネルにPushモデルのサプライヤを接続します。

パラメタ

  push_supplier

  サプライヤ自身のオブジェクトリファレンス。
  イベントチャネルが終了した場合の切断通知が不要な場合は、CORBA_OBJECT_NILを指定します。

  env

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

復帰値

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

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

  CosEventChannelAdmin::AlreadyConnected

  イベントチャネルがすでに接続されています。

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

注意事項

  イベントチャネルと再接続する場合は、再度CosEventChannelAdmin::SupplierAdmin::obtain_push_consumer()から行ってください。

2.16.2.9 CosEventChannelAdmin::ProxyPullSupplier::connect_pull_consumer()

名前

  CosEventChannelAdmin::ProxyPullSupplier::connect_pull_consumer

形式

  #include  <EventService_cplus.h>
  void  CosEventChannelAdmin::ProxyPullSupplier::connect_pull_consumer(
                CosEventComm::PullConsumer_ptr     pull_consumer,
                CORBA::Environment&                env )
                throw( CORBA::Exception );

機能説明

  イベントチャネルにPullモデルのコンシューマを接続します。

パラメタ

  pull_consumer

  コンシューマ自身のオブジェクトリファレンス。
  イベントチャネルが終了した場合の切断通知が不要な場合は、CORBA_OBJECT_NILを指定します。

  env

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

復帰値

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

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

  CosEventChannelAdmin::AlreadyConnected

  イベントチャネルがすでに接続されています。

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

注意事項

  イベントチャネルと再接続する場合は、再度CosEventChannelAdmin::ConsumerAdmin::obtain_pull_supplier()から行ってください。

2.16.2.10 CosEventChannelAdmin::ProxyPullConsumer::connect_pull_supplier()

名前

  CosEventChannelAdmin::ProxyPullConsumer::connect_pull_supplier

形式

  #include  <EventService_cplus.h>
  void  CosEventChannelAdmin::ProxyPullConsumer::connect_pull_supplier(
                CosEventComm::PullSupplier_ptr     pull_supplier,
                CORBA::Environment&                env )
                throw( CORBA::Exception );

機能説明

  イベントチャネルにPullモデルのサプライヤを接続します。

パラメタ

  pull_supplier

  サプライヤ自身のオブジェクトリファレンス。

  env

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

復帰値

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

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

  CosEventChannelAdmin::AlreadyConnected

  イベントチャネルがすでに接続されています。

  CosEventChannelAdmin::TypeError

  指定したオブジェクトの型に誤りがあります。

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

注意事項

  イベントチャネルと再接続する場合は、再度CosEventChannelAdmin::SupplierAdmin::obtain_pull_consumer()から行ってください。

2.16.2.11 CosEventChannelAdmin::ProxyPushSupplier::connect_push_consumer()

名前

  CosEventChannelAdmin::ProxyPushSupplier::connect_push_consumer

形式

  #include  <EventService_cplus.h>
  void  CosEventChannelAdmin::ProxyPushSupplier::connect_push_consumer(
                CosEventComm::PushConsumer_ptr     push_consumer,
                CORBA::Environment&                env )
                throw( CORBA::Exception );

機能説明

  イベントチャネルにPushモデルのコンシューマを接続します。

パラメタ

  push_consumer

  コンシューマ自身のオブジェクトリファレンス

  env

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

復帰値

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

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

  CosEventChannelAdmin::AlreadyConnected

  イベントチャネルがすでに接続されています。

  CosEventChannelAdmin::TypeError

  指定したオブジェクトの型に誤りがあります。

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

注意事項

  イベントチャネルと再接続する場合は、再度CosEventChannelAdmin::ConsumerAdmin::obtain_push_supplier()から行ってください。

2.16.2.12 継承されて使用できるクラス

  以下のクラスを継承して使用することができます。詳細については“2.16.1 CosEventCommクラス”を参照してください。

  1. CosEventChannelAdmin::ProxyPushConsumer::push

  2. CosEventChannelAdmin::ProxyPushConsumer::disconnect_push_consumer

  3. CosEventChannelAdmin::ProxyPushSupplier::disconnect_push_supplier

  4. CosEventChannelAdmin::ProxyPullSupplier::pull

  5. CosEventChannelAdmin::ProxyPullSupplier::try_pull

  6. CosEventChannelAdmin::ProxyPullSupplier::disconnect_pull_supplier

  7. CosEventChannelAdmin::ProxyPullConsumer::disconnect_pull_consumer

前次
Copyright FUJITSU LIMITED 2009