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

2.23.2.1 ES::ChannelUtil::get_proxys()

名前

  ES::ChannelUtil::get_proxys

形式

  #include  <EventService_cplus.h>
  ES::ChannelUtil::ProxyDataSeq  ES::ChannelUtil::get_proxys (
                                    ES::ChannelUtil::ProxyType       kind,
                                    CORBA::Environment&              env )
                                   throw( CORBA::Exception );
  typedef struct {
        CORBA::Object_var          proxy;
        CORBA::Long                time;
        CORBA::Long                ipaddress;
        ES::ChannelUtil::ProxyKind kind;
  } ES::ChannelUtil::ProxyData;
  typedef sequence< ES::ChannelUtil::ProxyData> ES::ChannelUtil::ProxyDataSeq;

機能説明

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

パラメタ

　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のexceptionメンバにNULLオブジェクトリファレンスが設定され、イベントチャネルに接続しているコンシューマ/サプライヤの接続情報を返します。
　異常終了した場合は、envのexceptionメンバにSystemExceptionオブジェクト、またはUserExceptionオブジェクトのオブジェクトリファレンスが設定されます。

　システム例外の場合、以下の例外が発生します。

　CORBA::StExcep::COMM_FAILURE

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

　CORBA::StExcep::NO_IMPLEMENT

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

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