spring-framework / org.springframework.web.servlet.mvc.method.annotation / SseEmitter / send

send

open fun send(object: Any): Unit

Overrides ResponseBodyEmitter.send

Send the object formatted as a single SSE "data" line. It's equivalent to:

 // static import of SseEmitter.* SseEmitter emitter = new SseEmitter(); emitter.send(event().data(myObject)); 

Parameters

object - the object to write

Exceptions

IOException - raised when an I/O error occurs

java.lang.IllegalStateException - wraps any other errors

open fun send(object: Any, @Nullable mediaType: MediaType): Unit

Overrides ResponseBodyEmitter.send

Send the object formatted as a single SSE "data" line. It's equivalent to:

 // static import of SseEmitter.* SseEmitter emitter = new SseEmitter(); emitter.send(event().data(myObject, MediaType.APPLICATION_JSON)); 

Parameters

object - the object to write

mediaType - a MediaType hint for selecting an HttpMessageConverter

Exceptions

IOException - raised when an I/O error occurs

open fun send(builder: SseEventBuilder): Unit

Send an SSE event prepared with the given builder. For example:

 // static import of SseEmitter SseEmitter emitter = new SseEmitter(); emitter.send(event().name("update").id("1").data(myObject)); 

Parameters

builder - a builder for an SSE formatted event.

Exceptions

IOException - raised when an I/O error occurs