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

2.23.2.5 ES::ChannelUtil::get_queue_length()

名前

  ES::ChannelUtil::get_queue_length

形式

  #include  <EventService_cplus.h>
  CORBA::ULong ES::ChannelUtil::get_queue_length(
                                    CORBA::Environment&              env )
                                   throw( CORBA::Exception );

機能説明

　イベントチャネルにキューイングされているイベントデータ数を取得します。

パラメタ

　env

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

復帰値

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

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

　CORBA::StExcep::COMM_FAILURE

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

　CORBA::StExcep::NO_IMPLEMENT

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