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

1.18.4 CosNotifyChannelAdminインタフェース

1.18.4.1 CosNotifyChannelAdmin_EventChannel__get_default_consumer_admin()

名前

CosNotifyChannelAdmin_EventChannel__get_default_consumer_admin

形式

#include  <NotificationService.h>
CosNotifyChannelAdmin_ConsumerAdmin
CosNotifyChannelAdmin_EventChannel__get_default_consumer_admin(
              CosNotifyChannelAdmin_EventChannel          obj,
              CORBA_Environment                           *env );

機能説明

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

パラメタ

obj

接続するイベントチャネルのオブジェクトリファレンス。

env

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

復帰値

正常終了した場合は、env構造体の_majorにCORBA_NO_EXCEPTIONが設定され、ConsumerAdminオブジェクトのオブジェクトリファレンスを返します。
異常終了した場合は、env構造体の_majorにCORBA_SYSTEM_EXCEPTIONが設定され、env構造体の_idに詳細情報が設定されます。

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

1.18.4.2 CosNotifyChannelAdmin_EventChannel__get_default_supplier_admin()

名前

CosNotifyChannelAdmin_EventChannel__get_default_supplier_admin

形式

#include  <NotificationService.h>
CosNotifyChannelAdmin_SupplierAdmin
CosNotifyChannelAdmin_EventChannel__get_default_supplier_admin(
              CosNotifyChannelAdmin_EventChannel  obj,
              CORBA_Environment                   *env );

機能説明

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

パラメタ

obj

接続するイベントチャネルのオブジェクトリファレンス。

env

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

復帰値

正常終了した場合は、env構造体の_majorにCORBA_NO_EXCEPTIONが設定され、SupplierAdminオブジェクトのオブジェクトリファレンスを返します。
異常終了した場合は、env構造体の_majorにCORBA_SYSTEM_EXCEPTIONが設定され、env構造体の_idに詳細情報が設定されます。

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

1.18.4.3 CosNotifyChannelAdmin_ConsumerAdmin_obtain_notification_pull_supplier()

名前

CosNotifyChannelAdmin_ConsumerAdmin_obtain_notification_pull_supplier

形式

#include  <NotificationService.h>
CosNotifyChannelAdmin_ProxySupplier
CosNotifyChannelAdmin_ConsumerAdmin_obtain_notification_pull_supplier(
              CosNotifyChannelAdmin_ConsumerAdmin  obj,
              CosNotifyChannelAdmin_ClientType     ctype,
              CosNotifyChannelAdmin_ProxyID        *proxy_id,
              CORBA_Environment                    *env );

機能説明

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

パラメタ

obj

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

ctype

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

CosNotifyChannelAdmin_ANY_EVENT

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

CosNotifyChannelAdmin_STRUCTURED_EVENT

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

proxy_id（outパラメタ）

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

env

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

復帰値

正常終了した場合は、env構造体の_majorにCORBA_NO_EXCEPTIONが設定され、ProxySupplierのオブジェクトリファレンスを返します。
異常終了した場合は、env構造体の_majorにCORBA_SYSTEM_EXCEPTIONまたはCORBA_USER_EXCEPTIONが設定され、env構造体の_idに詳細情報が設定されます。

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

ex_CosNotifyChannelAdmin_AdminLimitExceeded

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

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

1.18.4.4 CosNotifyChannelAdmin_SupplierAdmin_obtain_notification_push_consumer()

名前

CosNotifyChannelAdmin_SupplierAdmin_obtain_notification_push_consumer

形式

#include  <NotificationService.h>
CosNotifyChannelAdmin_ProxyConsumer
CosNotifyChannelAdmin_SupplierAdmin_obtain_notification_push_consumer(
              CosNotifyChannelAdmin_SupplierAdmin  obj,
              CosNotifyChannelAdmin_ClientType     ctype,
              CosNotifyChannelAdmin_ProxyID        *proxy_id,
              CORBA_Environment                    *env );

機能説明

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

パラメタ

obj

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

ctype

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

CosNotifyChannelAdmin_ANY_EVENT

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

CosNotifyChannelAdmin_STRUCTURED_EVENT

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

proxy_id（outパラメタ）

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

env

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

復帰値

正常終了した場合は、env構造体の_majorにCORBA_NO_EXCEPTIONが設定され、ProxyConsumerのオブジェクトリファレンスを返します。
異常終了した場合は、env構造体の_majorにCORBA_SYSTEM_EXCEPTIONまたはCORBA_USER_EXCEPTIONが設定され、env構造体の_idに詳細情報が設定されます。

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

ex_CosNotifyChannelAdmin_AdminLimitExceeded

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

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

1.18.4.5 CosNotifyChannelAdmin_ConsumerAdmin__get_MyChannel()

名前

CosNotifyChannelAdmin_ConsumerAdmin__get_MyChannel

形式

#include  <NotificationService.h>
CosNotifyChannelAdmin_EventChannel
CosNotifyChannelAdmin_ConsumerAdmin__get_MyChannel(
              CosNotifyChannelAdmin_ConsumerAdmin  obj,
              CORBA_Environment                    *env );

機能説明

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

パラメタ

obj

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

env

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

復帰値

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

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

1.18.4.6 CosNotifyChannelAdmin_SupplierAdmin__get_MyChannel()

名前

CosNotifyChannelAdmin_SupplierAdmin__get_MyChannel

形式

#include  <NotificationService.h>
CosNotifyChannelAdmin_EventChannel
CosNotifyChannelAdmin_SupplierAdmin__get_MyChannel(
              CosNotifyChannelAdmin_SupplierAdmin  obj,
              CORBA_Environment                    *env );

機能説明

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

パラメタ

obj

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

env

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

復帰値

正常終了した場合は、env構造体の_majorにCORBA_NO_EXCEPTIONが設定され、イベントチャネルのオブジェクトリファレンスを返します。
異常終了した場合は、env構造体の_majorにCORBA_SYSTEM_EXCEPTIONが設定され、env構造体の_idに詳細情報が設定されます。

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

1.18.4.7 CosNotifyChannelAdmin_ProxyPushConsumer_connect_any_push_supplier()

名前

CosNotifyChannelAdmin_ProxyPushConsumer_connect_any_push_supplier

形式

#include  <NotificationService.h>
void
CosNotifyChannelAdmin_ProxyPushConsumer_connect_any_push_supplier(
              CosNotifyChannelAdmin_ProxyPushConsumer  obj,
              CosEventComm_PushSupplier                push_supplier,
              CORBA_Environment                        *env );

機能説明

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

パラメタ

obj

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

push_supplier

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

env

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

復帰値

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

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

ex_CosEventChannelAdmin_AlreadyConnected

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

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

注意事項

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

1.18.4.8 CosNotifyChannelAdmin_ProxyPullSupplier_connect_any_pull_consumer()

名前

CosNotifyChannelAdmin_ProxyPullSupplier_connect_any_pull_consumer

形式

#include  <NotificationService.h>
void
CosNotifyChannelAdmin_ProxyPullSupplier_connect_any_pull_consumer(
              CosNotifyChannelAdmin_ProxyPullSupplier  obj,
              CosEventComm_PullConsumer                pull_consumer,
              CORBA_Environment                        *env );

機能説明

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

パラメタ

obj

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

pull_consumer

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

env

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

復帰値

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

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

ex_CosEventChannelAdmin_AlreadyConnected

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

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

注意事項

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

1.18.4.9 CosNotifyChannelAdmin_ProxyConsumer__get_MyType()

名前

CosNotifyChannelAdmin_ProxyConsumer__get_MyType

形式

#include  <NotificationService.h>
CosNotifyChannelAdmin_ProxyType
CosNotifyChannelAdmin_ProxyConsumer__get_MyType(
              CosNotifyChannelAdmin_ProxyConsumer  obj,
              CORBA_Environment                    *env );

機能説明

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

  CosNotifyChannelAdmin_PUSH_ANY...........any型のPushモデル
  CosNotifyChannelAdmin_PULL_ANY...........any型のPullモデル
  CosNotifyChannelAdmin_PUSH_STRUCTURED....StructuredEvent型のPushモデル
  CosNotifyChannelAdmin_PULL_STRUCTURED....StructuredEvent型のPullモデル

パラメタ

obj

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

env

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

復帰値

正常終了した場合は、env構造体の_majorにCORBA_NO_EXCEPTIONが設定され、Proxyオブジェクトの種別が復帰します。
異常終了した場合は、env構造体の_majorにCORBA_SYSTEM_EXCEPTIONが設定され、env構造体の_idに詳細情報が設定されます。

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

1.18.4.10 CosNotifyChannelAdmin_ProxySupplier__get_MyType()

名前

CosNotifyChannelAdmin_ProxySupplier__get_MyType

形式

#include  <NotificationService.h>
CosNotifyChannelAdmin_ProxyType
CosNotifyChannelAdmin_ProxySupplier__get_MyType(
              CosNotifyChannelAdmin_ProxySupplier  obj,
              CORBA_Environment                    *env );

機能説明

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

  CosNotifyChannelAdmin_PUSH_ANY...........any型のPushモデル
  CosNotifyChannelAdmin_PULL_ANY...........any型のPullモデル
  CosNotifyChannelAdmin_PUSH_STRUCTURED....StructuredEvent型のPushモデル
  CosNotifyChannelAdmin_PULL_STRUCTURED....StructuredEvent型のPullモデル

パラメタ

obj

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

env

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

復帰値

正常終了した場合は、env構造体の_majorにCORBA_NO_EXCEPTIONが設定され、Proxyオブジェクトの種別が復帰します。
異常終了した場合は、env構造体の_majorにCORBA_SYSTEM_EXCEPTIONが設定され、env構造体の_idに詳細情報が設定されます。

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

1.18.4.11 CosNotifyChannelAdmin_StructuredProxyPushConsumer_connect_structured_push_supplier()

名前

CosNotifyChannelAdmin_StructuredProxyPushConsumer_connect_structured_push_supplier

形式

#include  <NotificationService.h>
void
CosNotifyChannelAdmin_StructuredProxyPushConsumer_connect_structured_push_supplier(
              CosNotifyChannelAdmin_StructuredProxyPushConsumer  obj,
              CosNotifyComm_StructuredPushSupplier                push_supplier,
              CORBA_Environment                                   *env );

機能説明

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

パラメタ

obj

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

push_supplier

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

env

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

復帰値

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

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

ex_CosEventChannelAdmin_AlreadyConnected

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

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

注意事項

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

1.18.4.12 CosNotifyChannelAdmin_StructuredProxyPullSupplier_connect_structured_pull_consumer()

名前

CosNotifyChannelAdmin_StructuredProxyPullSupplier_connect_structured_pull_consumer

形式

#include  <NotificationService.h>
void
CosNotifyChannelAdmin_StructuredProxyPullSupplier_connect_structured_pull_consumer(
              CosNotifyChannelAdmin_StructuredProxyPullSupplier  obj,
              CosNotifyComm_StructuredPullConsumer                pull_consumer,
              CORBA_Environment                                   *env );

機能説明

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

パラメタ

obj

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

pull_consumer

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

env

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

復帰値

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

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

ex_CosEventChannelAdmin_AlreadyConnected

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

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

注意事項

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

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

以下のインタフェースを継承して使用することができます。詳細については、“1.18.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