パッケージ jakarta.ws.rs.sse

インターフェース SseEvent

  • すべての既知のサブインターフェース:
    InboundSseEvent, OutboundSseEvent
    public interface SseEvent
    ベースサーバー送信イベント定義。

    このインターフェースは、サーバー送信イベントの基本的なプロパティ、つまり ID、名前、コメントを提供します。また、Reconnectdelay プロパティへのアクセスも提供します。

    SseEvent は、InboundSseEvent と OutboundSseEvent という別の 2 つのインターフェースによって拡張されます。主な違いは、インスタンスの作成メソッドと、保存されたデータへのアクセス（または提供）のメソッドにあります。

    導入:
    2.1
    作成者:
    Marek Potociar

    • フィールドのサマリー

      フィールド  
      修飾子と型 フィールド 説明
      static longRECONNECT_NOT_SET
      SSE イベント retry フィールドを介して設定された SSE 再接続遅延の「再接続が設定されていません」値。

    • メソッドのサマリー

      すべてのメソッド   インスタンスメソッド   抽象メソッド  
      修飾子と型 メソッド 説明
      StringSEgetComment()
      イベントに付随するコメント文字列を取得します。
      StringSEgetId()
      イベント識別子を取得します。
      StringSEgetName()
      イベント名を取得します。
      longgetReconnectDelay()
      SSE イベントソースへの接続が失われた後、イベントレシーバーが再接続を試行する前に待機する必要がある新しい接続再試行時間をミリ秒単位で取得します。
      booleanisReconnectDelaySet()
      イベントで接続再試行時間が設定されているか確認してください。

    • フィールドの詳細

      • RECONNECT_NOT_SET

        static final long RECONNECT_NOT_SET
        SSE イベント retry フィールドを介して設定された SSE 再接続遅延の「再接続が設定されていません」値。
        関連事項:
        定数フィールド値

    • メソッドの詳細

      • getId

        StringSE getId()
        イベント識別子を取得します。

        SSE "id" フィールドの値が含まれます。このフィールドはオプションです。イベント識別子が指定されていない場合、メソッドは null を返す場合があります。

        戻り値:
        イベント ID。

      • getName

        StringSE getName()
        イベント名を取得します。

        SSE "event" フィールドの値が含まれます。このフィールドはオプションです。イベント名が指定されていない場合、メソッドは null を返す場合があります。

        戻り値:
        イベント名、または設定されていない場合は null。

      • getComment

        StringSE getComment()
        イベントに付随するコメント文字列を取得します。

        SSE イベントに関連付けられたコメントの値が含まれます。このフィールドはオプションです。イベントコメントが指定されていない場合、メソッドは null を返す場合があります。

        戻り値:
        イベントに関連するコメント。

      • getReconnectDelay

        long getReconnectDelay()
        SSE イベントソースへの接続が失われた後、イベントレシーバーが再接続を試行する前に待機する必要がある新しい接続再試行時間をミリ秒単位で取得します。

        SSE "retry" フィールドの値が含まれます。このフィールドはオプションです。値が設定されていない場合、メソッドは RECONNECT_NOT_SET を返します。

        戻り値:
        ミリ秒単位の再接続遅延、または値が設定されていない場合は RECONNECT_NOT_SET。

      • isReconnectDelaySet

        boolean isReconnectDelaySet()
        イベントで接続再試行時間が設定されているか確認してください。
        戻り値:
        イベントで新しい再接続遅延が設定されている場合は true、それ以外の場合は false。