メインコンテンツまでスキップ

onDataMessage

onDataMessage

ソケットタイプのProvider Instanceへ通常の要求(requestData/requestNextData)を送ったとき、サーバーが応答を完了する前に送る中間状態のメッセージを受信すると呼び出されます。要求を終了させない付加的な通知チャネルです。

パラメータ

  • provInstNamestring): 要求を送ったProvider Instanceの名前
  • codestring): メッセージの状態コード
  • messagestring): メッセージの内容

戻り値: 戻り値なし — コールバック関数のため、戻り値は使用されません。

説明

このイベントはリアルタイム購読(subscribeData)とは無関係です。 ソケットタイプのProvider InstanceにrequestData/requestNextDataで通常の要求を送ったあと、サーバーが応答を完全に終える前に送る中間状態・通知メッセージを受信したときに呼び出されます。HTTP(OpenAPI)方式のProvider Instanceでは呼び出されません。要求を失敗として終了させるonReceiveErrorとは異なり、このイベントが呼び出されても要求は進行中で、その後onReceiveDoneへ続きます。

Example

function onDataMessage(provInstName, code, message) {
$log.i(provInstName + " notice " + code + ": " + message);
}

関連

  • ソケットタイプではない通常のHTTP(OpenAPI)Provider Instanceでは呼び出されません。
  • 要求を終了させないため、1回の要求サイクル中に複数回呼び出されることがあります。
  • 特定のアプリの取引(TR)処理フローに由来するイベントですが、エンジン自体は汎用的であるため、他のソケットベースのProviderでも同じように使用できます。