Interstage Application Server リファレンスマニュアル（API編）

1.19.2.1 ES_ChannelUtil_get_proxys()

名前

  ES_ChannelUtil_get_proxys

形式

  #include  <EventService.h>
  ES_ChannelUtil_ProxyDataSeq *
  ES_ChannelUtil_get_proxys (
                ES_ChannelUtil              obj, 
                ES_ChannelUtil_ProxyKind    kind, 
                CORBA_Environment           *env );
  typedef struct {
        CORBA_Object              proxy; 
        CORBA_long                time; 
        CORBA_long                ipaddress; 
        ES_ChannelUtil_ProxyKind  kind; 
  } ES_ChannelUtil_ProxyData;
  typedef sequence<ES_ChannelUtil_ProxyData> ES_ChannelUtil_ProxyDataSeq;

機能説明

　イベントチャネルに接続しているコンシューマ/プライヤの接続情報を取得します。
　このメソッドはイベントチャネルに接続しているコンシューマ/サプライヤの接続情報を格納する領域を獲得するため、この領域が不要になった時点で、CORBA_free()を使用して領域を解放する必要があります。

パラメタ

　obj

　ES_ChannelUtilのオブジェクトリファレンス。

　kind

　取得するProxyオブジェクトのタイプ。
　本パラメタに指定する値に応じて、取得する接続情報が異なります。以下に本パラメタに指定する値と復帰値情報の対応を示します。

　kind値と復帰値情報の対応

kindに指定可能な値	復帰値情報
ES_ChannelUtil_ALL_PROXYS	すべての接続情報を取得
ES_ChannelUtil_PROXY_CONSUMER	すべてのProxyConsumerの一覧を取得
ES_ChannelUtil_PROXY_SUPPLIER	すべてのProxySupplierの一覧を取得
ES_ChannelUtil_PROXY_PULL_CONSUMER_EVENT	CosEventChannelAdminのProxyPullConsumerの一覧を取得
ES_ChannelUtil_PROXY_PULL_SUPPLIER_EVENT	CosEventChannelAdminのProxyPullSupplierの一覧を取得
ES_ChannelUtil_PROXY_PUSH_CONSUMER_EVENT	CosEventChannelAdminのProxyPushConsumerの一覧を取得
ES_ChannelUtil_PROXY_PUSH_SUPPLIER_EVENT	CosEventChannelAdminのProxyPushSupplierの一覧を取得
ES_ChannelUtil_PROXY_PULL_CONSUMER_NOTIFY	CosNotifyChannelAdminのProxyPullConsumerの一覧を取得
ES_ChannelUtil_PROXY_PULL_SUPPLIER_NOTIFY	CosNotifyChannelAdminのProxyPullSupplierの一覧を取得
ES_ChannelUtil_PROXY_PUSH_CONSUMER_NOTIFY	CosNotifyChannelAdminのProxyPushConsumerの一覧を取得
ES_ChannelUtil_PROXY_PUSH_SUPPLIER_NOTIFY	CosNotifyChannelAdminのProxyPushSupplierの一覧を取得
ES_ChannelUtil_STRUCTURED_PROXY_PULL_CONSUMER	CosNotifyChannelAdminのStructuredProxyPullConsumerの一覧を取得
ES_ChannelUtil_STRUCTURED_PROXY_PULL_SUPPLIER	CosNotifyChannelAdminのStructuredProxyPullSupplierの一覧を取得
ES_ChannelUtil_STRUCTURED_PROXY_PUSH_CONSUMER	CosNotifyChannelAdminのStructuredProxyPushConsumerの一覧を取得
ES_ChannelUtil_STRUCTURED_PROXY_PUSH_SUPPLIER	CosNotifyChannelAdminのStructuredProxyPushSupplierの一覧を取得

　ES_ChannelUtil_ProxyData構造体の各メンバには以下の値が設定されます。

　ES_ChannelUtil_ProxyData構造体のメンバと設定値

メンバ	設定値
Proxy	イベントチャネルに接続しているコンシューマ/サプライヤのオブジェクトリファレンス
time	イベントチャネルに接続された時間
ipaddress	イベントチャネルに接続しているコンシューマ/サプライヤのIPアドレス
kind	イベントチャネルに接続しているコンシューマ/サプライヤのプロキシ種別 　ES_ChannelUtil_PROXY_PULL_CONSUMER_EVENT 　ES_ChannelUtil_PROXY_PULL_SUPPLIER_EVENT 　ES_ChannelUtil_PROXY_PUSH_CONSUMER_EVENT 　ES_ChannelUtil_PROXY_PUSH_SUPPLIER_EVENT 　ES_ChannelUtil_PROXY_PULL_CONSUMER_NOTIFY 　ES_ChannelUtil_PROXY_PULL_SUPPLIER_NOTIFY 　ES_ChannelUtil_PROXY_PUSH_CONSUMER_NOTIFY 　ES_ChannelUtil_PROXY_PUSH_SUPPLIER_NOTIFY 　ES_ChannelUtil_STRUCTURED_PROXY_PULL_CONSUMER 　ES_ChannelUtil_STRUCTURED_PROXY_PULL_SUPPLIER 　ES_ChannelUtil_STRUCTURED_PROXY_PUSH_CONSUMER 　ES_ChannelUtil_STRUCTURED_PROXY_PUSH_SUPPLIER

　env

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

復帰値

　正常終了した場合は、env構造体の_majorにCORBA_NO_EXCEPTIONが設定され、イベントチャネルに接続しているコンシューマ/サプライヤの接続情報を返します。
　異常終了した場合は、env構造体の_majorにCORBA_SYSTEM_EXCEPTIONまたはCORBA_USER_EXCEPTIONが設定され、env構造体の_idに詳細情報が設定されます。

　システム例外の場合、以下の詳細情報が設定されます。

　ex_CORBA_StExcep_COMM_FAILURE

　通信異常が発生しました。

　ex_CORBA_StExcep_NO_IMPLEMENT

　イベントチャネルが起動されていません。

　IPv6環境のIPアドレスで運用している場合、メンバ“ipaddress”には“0”が格納されます。
　IPv6環境で使用する場合は、ES_ChannelUtil_get_proxys6()を使用してください。