spring-framework / org.springframework.http.codec / ServerSentEventHttpMessageWriter

ServerSentEventHttpMessageWriter

open class ServerSentEventHttpMessageWriter : HttpMessageWriter<Any>

HttpMessageWriter for "text/event-stream" responses.

Author
Sebastien Deleuze

Author
Arjen Poutsma

Author
Rossen Stoyanchev

Since
5.0

Constructors

<init>

 ServerSentEventHttpMessageWriter()

Constructor without an Encoder. In this mode only String is supported for event data to be encoded.

ServerSentEventHttpMessageWriter(encoder: Encoder<*>)

Constructor with JSON Encoder for encoding objects. Support for String event data is built-in.

Functions

canWrite

 open fun canWrite(elementType: ResolvableType, mediaType: MediaType): Boolean

getEncoder

 open fun getEncoder(): Encoder<*>

Return the configured Encoder, if any.

getWritableMediaTypes

 open fun getWritableMediaTypes(): MutableList<MediaType>

write

 open fun write(input: Publisher<*>, elementType: ResolvableType, mediaType: MediaType, message: ReactiveHttpOutputMessage, hints: MutableMap<String, Any>): Mono<Void>
open fun write(input: Publisher<*>, actualType: ResolvableType, elementType: ResolvableType, mediaType: MediaType, request: ServerHttpRequest, response: ServerHttpResponse, hints: MutableMap<String, Any>): Mono<Void>