ページの先頭行へ戻る
Interstage Application Server リファレンスマニュアル(API編)
Interstage
第2章 C++言語インタフェース > 2.22 ノーティフィケーションサービスインタフェース > 2.22.4 CosNotifyChannelAdminモジュール
前次

2.22.4 CosNotifyChannelAdminモジュール

2.22.4.1 CosNotifyChannelAdmin::ConsumerAdmin::obtain_notification_pull_supplier()

名前

CosNotifyChannelAdmin::ConsumerAdmin::obtain_notification_pull_supplier

形式

#include  <NotificationService_cplus.h>
CosNotifyChannelAdmin::ProxySupplier_ptr
CosNotifyChannelAdmin::ConsumerAdmin::obtain_notification_pull_supplier(
                      CosNotifyChannelAdmin::ClientType            ctype,
                      CosNotifyChannelAdmin::ProxyID&              proxy_id,
                        CORBA::Environment&                          env );
                        throw( CORBA::Exception );

機能説明

ctypeで指定されたクライアント種別を持つ、ProxySupplierのオブジェクトを作成します。
このメソッドはオブジェクトリファレンスを格納する領域を獲得するため、この領域が不要になった時点で、CORBA::release()を使用して領域を解放する必要があります。

パラメタ

ctype

ProxySupplierのオブジェクトを作成するクライアント種別を、以下から指定します。

CosNotifyChannelAdmin::ANY_EVENT

any型イベントを扱います。

CosNotifyChannelAdmin::STRUCTURED_EVENT

StructuredEvent型イベントを扱います。

proxy_id（outパラメタ）

作成したProxySupplierの識別IDが設定されます。

env

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

復帰値

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

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

CosNotifyChannelAdmin::AdminLimitExceeded

ProxySupplierの作成数の上限に達したため、これ以上は作成できません。

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

2.22.4.2 CosNotifyChannelAdmin::SupplierAdmin::obtain_notification_push_consumer()

名前

CosNotifyChannelAdmin::SupplierAdmin::obtain_notification_push_consumer

形式

#include  <NotificationService_cplus.h>
CosNotifyChannelAdmin::ProxyConsumer_ptr
CosNotifyChannelAdmin::SupplierAdmin::obtain_notification_push_consumer(
                      CosNotifyChannelAdmin::ClientType            ctype,
                      CosNotifyChannelAdmin::ProxyID&              proxy_id,
                        CORBA::Environment&                          env );
                        throw( CORBA::Exception );

機能説明

ctypeで指定されたクライアント種別を持つ、ProxyConsumerのオブジェクトを作成します。
このメソッドはオブジェクトリファレンスを格納する領域を獲得するため、この領域が不要になった時点で、CORBA::release()を使用して領域を解放する必要があります。

パラメタ

ctype

ProxyConsumerのオブジェクトを作成するクライアント種別を、以下から指定します。

CosNotifyChannelAdmin::ANY_EVENT

any型イベントを扱います。

CosNotifyChannelAdmin::STRUCTURED_EVENT

StructuredEvent型イベントを扱います。

proxy_id（outパラメタ）

作成したProxyConsumerの識別IDが設定されます。

env

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

復帰値

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

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

CosNotifyChannelAdmin::AdminLimitExceeded

ProxyConsumerの作成数の上限に達したため、これ以上は作成できません。

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

2.22.4.3 CosNotifyChannelAdmin::ConsumerAdmin::MyChannel()

名前

CosNotifyChannelAdmin::ConsumerAdmin::MyChannel

形式

#include  <NotificationService_cplus.h>
CosNotifyChannelAdmin::EventChannel_ptr
CosNotifyChannelAdmin::ConsumerAdmin::MyChannel(
                        CORBA::Environment&              env );
                          throw( CORBA::Exception );

機能説明

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

パラメタ

env

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

復帰値

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

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

2.22.4.4 CosNotifyChannelAdmin::SupplierAdmin::MyChannel()

名前

CosNotifyChannelAdmin::SupplierAdmin::MyChannel

形式

#include  <NotificationService_cplus.h>
CosNotifyChannelAdmin::EventChannel_ptr
CosNotifyChannelAdmin::SupplierAdmin::MyChannel(
                        CORBA::Environment&                env );
                        throw( CORBA::Exception );

機能説明

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

パラメタ

env

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

復帰値

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

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

2.22.4.5 CosNotifyChannelAdmin::EventChannel::default_consumer_admin()

名前

CosNotifyChannelAdmin::EventChannel::default_consumer_admin

形式

#include  <NotificationService_cplus.h>
CosNotifyChannelAdmin::ConsumerAdmin_ptr
CosNotifyChannelAdmin::EventChannel::default_consumer_admin(
                        CORBA::Environment&               env );
                    throw( CORBA::Exception );

機能説明

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

パラメタ

env

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

復帰値

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

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

2.22.4.6 CosNotifyChannelAdmin::EventChannel::default_supplier_admin()

名前

CosNotifyChannelAdmin::EventChannel::default_supplier_admin

形式

#include  <NotificationService_cplus.h>
CosNotifyChannelAdmin::SupplierAdmin_ptr
CosNotifyChannelAdmin::EventChannel::default_supplier_admin(
                        CORBA::Environment&               env );
                      throw( CORBA::Exception );

機能説明

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

パラメタ

env

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

復帰値

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

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

2.22.4.7 CosNotifyChannelAdmin::ProxyPushConsumer::connect_any_push_supplier()

名前

CosNotifyChannelAdmin::ProxyPushConsumer::connect_any_push_supplier

形式

#include  <NotificationService_cplus.h>
void
CosNotifyChannelAdmin::ProxyPushConsumer::connect_any_push_supplier(
                    CosEventComm::PushSupplier_ptr               push_supplier,
                    CORBA::Environment&                          env );
                    throw( CORBA::Exception );

機能説明

イベントチャネルにany型のサプライヤとして接続します。

パラメタ

push_supplier

自身のオブジェクトリファレンス。
イベントチャネルが終了した場合の切断通知が不要な場合は、CosEventComm::PushSupplier::_nil()を指定します。

env

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

復帰値

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

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

CosEventChannelAdmin::AlreadyConnected

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

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

注意事項

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

2.22.4.8 CosNotifyChannelAdmin::ProxyPullSupplier::connect_any_pull_consumer()

名前

CosNotifyChannelAdmin::ProxyPullSupplier::connect_any_pull_consumer

形式

#include  <NotificationService_cplus.h>
void
CosNotifyChannelAdmin::ProxyPullSupplier::connect_any_pull_consumer(
                    CosEventComm::PullConsumer_ptr               pull_consumer,
                    CORBA::Environment&                          env );
                    throw( CORBA::Exception );

機能説明

イベントチャネルにany型のコンシューマとして接続します。

パラメタ

pull_consumer

自身のオブジェクトリファレンス。
イベントチャネルが終了した場合に切断通知が不要な場合は、CosEventComm::PullConsumer::_nil()を指定します。

env

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

復帰値

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

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

CosEventChannelAdmin::AlreadyConnected

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

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

注意事項

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

2.22.4.9 CosNotifyChannelAdmin::ProxyConsumer::MyType()

名前

CosNotifyChannelAdmin::ProxyConsumer::MyType

形式

#include  <NotificationService_cplus.h>
CosNotifyChannelAdmin::ProxyType
CosNotifyChannelAdmin::ProxyConsumer::MyType(
                    CORBA::Environment&                           env );
                      throw( CORBA::Exception );

機能説明

Proxyオブジェクトの種別として以下の値を返します。

  CosNotifyChannelAdmin::PUSH_ANY...........any型のPushモデル
  CosNotifyChannelAdmin::PULL_ANY...........any型のPullモデル
  CosNotifyChannelAdmin::PUSH_STRUCTURED....StructuredEvent型のPushモデル
  CosNotifyChannelAdmin::PULL_STRUCTURED....StructuredEvent型のPullモデル

パラメタ

env

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

復帰値

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

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

2.22.4.10 CosNotifyChannelAdmin::ProxySupplier::MyType()

名前

CosNotifyChannelAdmin::ProxySupplier::MyType

形式

#include  <NotificationService_cplus.h>
CosNotifyChannelAdmin::ProxyType
CosNotifyChannelAdmin::ProxySupplier::MyType(
                    CORBA::Environment&                          env );
                    throw( CORBA::Exception );

機能説明

Proxyオブジェクトの種別として以下の値を返します。

  CosNotifyChannelAdmin::PUSH_ANY...........any型のPushモデル
  CosNotifyChannelAdmin::PULL_ANY...........any型のPullモデル
  CosNotifyChannelAdmin::PUSH_STRUCTURED....StructuredEvent型のPushモデル
  CosNotifyChannelAdmin::PULL_STRUCTURED....StructuredEvent型のPullモデル

パラメタ

env

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

復帰値

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

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

2.22.4.11 CosNotifyChannelAdmin::StructuredProxyPushConsumer::connect_structured_push_supplier()

名前

CosNotifyChannelAdmin::StructuredProxyPushConsumer::connect_structured_push_supplier

形式

#include  <NotificationService_cplus.h>
void
CosNotifyChannelAdmin::StructuredProxyPushConsumer::connect_structured_push_supplier(
            CosNotifyComm::StructuredPushSupplier_ptr               push_supplier,
            CORBA::Environment&                                     env );
            throw( CORBA::Exception );

機能説明

イベントチャネルにStructuredEvent型のサプライヤとして接続します。

パラメタ

push_supplier

自身のオブジェクトリファレンス。
イベントチャネルが終了した場合の切断通知が不要な場合は、CosNotifyComm::StructuredPushSupplier::_nil()を指定します。

env

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

復帰値

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

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

CosEventChannelAdmin::AlreadyConnected

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

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

注意事項

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

2.22.4.12 CosNotifyChannelAdmin::StructuredProxyPullSupplier::connect_structured_pull_consumer()

名前

CosNotifyChannelAdmin::StructuredProxyPullSupplier::connect_structured_pull_consumer

形式

#include  <NotificationService_cplus.h>
void
CosNotifyChannelAdmin::StructuredProxyPullSupplier::connect_structured_pull_consumer(
            CosNotifyComm::StructuredPullConsumer_ptr               pull_consumer,
            CORBA::Environment&                                     env );
            throw( CORBA::Exception );

機能説明

イベントチャネルにStructuredEvent型のコンシューマとして接続します。

パラメタ

pull_consumer

自身のオブジェクトリファレンス。
イベントチャネルが終了した場合の切断通知が不要な場合は、CosNotifyComm::StructuredPullConsumer::_nil()を指定します。

env

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

復帰値

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

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

CosEventChannelAdmin::AlreadyConnected

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

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

注意事項

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

2.22.4.13 継承されて使用できるインタフェース

以下のインタフェースを継承して使用することができます。詳細については、“2.22.3 CosNotifyCommモジュール”を参照してください。

  1. CosNotifyChannelAdmin::StructuredProxyPushConsumer::push_structured_event

  2. CosNotifyChannelAdmin::StructuredProxyPullSupplier::pull_structured_event

  3. CosNotifyChannelAdmin::StructuredProxyPullSupplier::try_pull_structured_event

  4. CosNotifyChannelAdmin::StructuredProxyPushConsumer::disconnect_structured_push_consumer

  5. CosNotifyChannelAdmin::StructuredProxyPullSupplier::disconnect_structured_pull_supplier

  6. CosNotifyChannelAdmin::ProxyPushConsumer::push

  7. CosNotifyChannelAdmin::ProxyPullSupplier::pull

  8. CosNotifyChannelAdmin::ProxyPullSupplier::try_pull

  9. CosNotifyChannelAdmin::ProxyPushConsumer::disconnect_push_consumer

  10. CosNotifyChannelAdmin::ProxyPullSupplier::disconnect_pull_supplier

前次
Copyright 2011-2012 FUJITSU LIMITED