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

2.22.3.3 CosNotifyComm::StructuredPullSupplier::try_pull_structured_event()

名前

  CosNotifyComm::StructuredPullSupplier::try_pull_structured_event

形式

　#include  <NotificationService_cplus.h>
　CosNotification::StructuredEvent *
　CosNotifyComm::StructuredPullSupplier::try_pull_structured_event (
              CORBA::Boolean&                   has_event,
              CORBA::Environment&               env );
              throw( CORBA::Exception );

機能説明

　サプライヤにStructuredEvent型のイベントデータを要求します。サプライヤからイベントデータを取り出せない場合は即座に復帰します。なお、イベントデータを取り出せるまでブロックしたい場合には、CosNotifyComm::StructuredPullSupplier::pull_structured_eventを使用してください。
　取り出したStructuredEvent型のイベントデータは、この領域が不要になった時点で、deleteを使用して領域を解放する必要があります。

パラメタ

　has_event（outパラメタ）

　イベントデータを取り出せた場合は、CORBA_TRUEが設定されます。
　イベントデータを取り出せなかった場合は、CORBA_FALSEが設定されます。

　env

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

復帰値

　正常終了した場合は、envのexceptionメンバにNULLオブジェクトリファレンスが設定されます。イベントデータを取り出せた場合は、has_eventにCORBA_TRUEが設定され、サプライヤからのイベントデータが復帰します。イベントデータを取り出せなかった場合には、has_eventにCORBA_FALSEが設定されます。この場合も空のStructuredEvent型のイベントデータの領域が獲得されるので、取り出したStructuredEvent型のイベントデータの領域は、deleteを使用して領域を解放する必要があります。
　異常終了した場合は、envのexceptionメンバにSystemExceptionオブジェクト、またはUserExceptionオブジェクトのオブジェクトリファレンスが設定されます。

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

　CosEventComm::Disconnected

　イベントチャネルに接続されていません。

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

　CORBA::StExcep::NO_RESOURCES

　以下のいずれかの可能性があります。
　−　イベントチャネルが閉塞終了中である。
　
　−　イベントチャネルが閉塞／自動閉塞されている。

　CORBA::StExcep::COMM_FAILURE

　タイムアウトが発生したか、切断処理が行われたためpull処理が中断された可能性があります。または、通信異常が発生しました。

　CORBA::StExcep::NO_IMPLEMENT

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