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

インターフェース OutboundSseEvent

すべてのスーパーインターフェース:
SseEvent

public interface OutboundSseEvent extends SseEvent
単一の送信サーバー送信イベントの表現。

サーバー側で、イベントを作成してクライアントに送信するとき、またはブロードキャストするときに使用されます。

導入:
2.1
作成者:
Marek Potociar
  • 方法の詳細

    • getType

      ClassSE<?> getType()
      データ型を取得します。

      この情報は、event data の直列化に使用する適切な MessageBodyWriter を選択するために使用されます。

      戻り値:
      データ・型。イベントにデータが含まれていない場合、null を返す可能性があります。
    • getGenericType

      TypeSE getGenericType()
      ジェネリクスデータ型を取得します。

      この情報は、event data の直列化に使用する適切な MessageBodyWriter を選択するために使用されます。

      戻り値:
      ジェネリクスデータ型。イベントにデータが含まれていない場合、null を返す可能性があります。
    • getMediaType

      MediaType getMediaType()
      イベントデータの media type を取得します。

      この情報は、event data の直列化に使用される適切な MessageBodyWriter を選択するために使用されます。

      戻り値:
      データ MediaType
    • getData

      ObjectSE getData()
      イベントデータを取得します。

      イベントデータは、指定されている場合、直列化され、1 つ以上の SSE イベント "data" フィールドとして送信されます(実際の直列化されたデータコンテンツの改行によって異なります)。データは、イベント typegetGenericType() 汎用型 } および getMediaType() メディア型 } に基づいて選択された使用可能な MessageBodyWriter を使用して直列化されます。

      戻り値:
      イベントデータ。イベントにデータが含まれていない場合、null を返す可能性があります。