Package org.springframework.web.servlet.function

Interface ServerResponse.SseBuilder

All Superinterfaces:
ServerResponse.AsyncBuilder<ServerResponse.SseBuilder>
Enclosing interface:
ServerResponse
public static interface ServerResponse.SseBuilder extends ServerResponse.AsyncBuilder<ServerResponse.SseBuilder>
Defines a builder for a body that sends server-sent events.
Since:
5.3.2

  • Method Details

    • send

      void send(Object object) throws IOException
      Sends the given object as a server-sent event. Strings will be sent as UTF-8 encoded bytes, and other objects will be converted into JSON using message converters.

      This convenience method has the same effect as data(Object).

      Parameters:
      object - the object to send
      Throws:
      IOException - in case of I/O errors

    • send

      void send() throws IOException
      Sends the buffered content as a server-sent event, without data. Only the events and comments will be sent.
      Throws:
      IOException - in case of I/O errors
      Since:
      6.1.4

    • id

      ServerResponse.SseBuilder id(String id)
      Add an SSE "id" line.
      Parameters:
      id - the event identifier
      Returns:
      this builder

    • event

      ServerResponse.SseBuilder event(String eventName)
      Add an SSE "event" line.
      Parameters:
      eventName - the event name
      Returns:
      this builder

    • retry

      ServerResponse.SseBuilder retry(Duration duration)
      Add an SSE "retry" line.
      Parameters:
      duration - the duration to convert into millis
      Returns:
      this builder

    • comment

      ServerResponse.SseBuilder comment(String comment)
      Add an SSE comment.
      Parameters:
      comment - the comment
      Returns:
      this builder

    • data

      void data(Object object) throws IOException
      Add an SSE "data" line for the given object and sends the built server-sent event to the client. Strings will be sent as UTF-8 encoded bytes, and other objects will be converted into JSON using message converters.
      Parameters:
      object - the object to send as data
      Throws:
      IOException - in case of I/O errors