ストリームデータ処理基盤 uCosminexus Stream Data Platform - Application Framework アプリケーション開発ガイド

[目次][索引][前へ][次へ]

8.8 StreamOutputインタフェース(共通API)

説明

カスタムアダプターがSDPサーバからタプルを受信するために使用するインタフェースです。

タプルを受信するためのAPIには,次の2種類があります。

ポーリング用メソッドは,カスタムアダプターがSDPサーバから能動的にタプルを取得するためのメソッドです。getメソッドとgetAllメソッドがあります。getメソッドは,単一のタプルを受信するメソッドです。getAllメソッドは,複数のタプルをまとめて受信するメソッドです。

コールバック用メソッドは,SDPサーバ上でタプルが生成されたときに呼び出され,受動的にタプルを取得するためのメソッドです。コールバック方式でデータを受信するには,SDPサーバ上でタプルが生成されたときにSDPサーバから呼び出されるメソッドを持つオブジェクト(リスナーオブジェクト)をSDPサーバに登録しておく必要があります。

リスナーオブジェクトは,StreamEventListenerインタフェースを実装したオブジェクトです。StreamOutputインタフェースには,このリスナーオブジェクトをSDPサーバに登録するためのメソッドとして,registerForNotificationメソッドがあります。また,リスナーオブジェクトのSDPサーバへの登録を解除するためのメソッドとして,unregisterForNotificationメソッドがあります。

メソッド

StreamOutputインタフェースのメソッド一覧を次の表に示します。

戻り値 メソッド名 機能
void close() 出力ストリームとの接続を閉じます。
StreamTuple get() SDPサーバに登録されているタプルを一つだけ取得します。
ArrayList<StreamTuple> get(int count) SDPサーバに登録されているデータをcountパラメーターに指定した数だけ取得します。
ArrayList<StreamTuple> get(int count, long timeout) SDPサーバに登録されているデータをcountパラメーターに指定した数だけ取得します。SDPサーバに結果データがない場合,結果データが到着するか,またはtimeoutパラメーターに指定した時間が経過するまで待機します。
ArrayList<StreamTuple> getAll() SDPサーバに登録されているすべてのタプルを取得します。
ArrayList<StreamTuple> getAll(long timeout) SDPサーバに登録されているすべてのタプルを取得します。SDPサーバに結果データがない場合,結果データが到着するか,またはtimeoutパラメーターに指定した時間が経過するまで待機します。
int getFreeQueueSize() 出力ストリームキューの空きサイズを取得します。
int getMaxQueueSize() 出力ストリームキューの最大サイズを取得します。
void registerForNotification(StreamEventListener n) コールバック用リスナーオブジェクトを登録します。
void unregisterForNotification(StreamEventListener n) 登録したリスナーオブジェクトを解除して,以降のコールバック処理の実行を解除します。

注意事項

なし。

<この節の構成>
close()メソッド
get()メソッド
get(int count)メソッド
get(int count, long timeout)メソッド
getAll()メソッド
getAll(long timeout)メソッド
getFreeQueueSize()メソッド
getMaxQueueSize()メソッド
registerForNotification(StreamEventListener n)メソッド
unregisterForNotification(StreamEventListener n)メソッド