程序包 cn.taketoday.http.codec

接口 ServerSentEvent.Builder<T>

类型参数:

T - the type of data that this event contains

所有已知实现类:

ServerSentEvent.BuilderImpl

封闭类:

ServerSentEvent<T>

public static interface ServerSentEvent.Builder<T>

A mutable builder for a SseEvent.

方法概要

修饰符和类型	方法	说明
ServerSentEvent<T>	build()	Builds the event.
ServerSentEvent.Builder<T>	comment(String comment)	Set SSE comment.
ServerSentEvent.Builder<T>	data(T data)	Set the value of the data field.
ServerSentEvent.Builder<T>	event(String event)	Set the value of the event field.
ServerSentEvent.Builder<T>	id(String id)	Set the value of the id field.
ServerSentEvent.Builder<T>	retry(Duration retry)	Set the value of the retry field.

方法详细资料

id

ServerSentEvent.Builder<T> id(String id)

Set the value of the id field.

参数:

id - the value of the id field

返回:

this builder

event

ServerSentEvent.Builder<T> event(String event)

Set the value of the event field.

参数:

event - the value of the event field

返回:

this builder

retry

ServerSentEvent.Builder<T> retry(Duration retry)

Set the value of the retry field.

参数:

retry - the value of the retry field

返回:

this builder

comment

ServerSentEvent.Builder<T> comment(String comment)

Set SSE comment. If a multi-line comment is provided, it will be turned into multiple SSE comment lines as defined in Server-Sent Events W3C recommendation.

参数:

comment - the comment to set

返回:

this builder

data

ServerSentEvent.Builder<T> data(@Nullable
 T data)

Set the value of the data field. If the data argument is a multi-line String, it will be turned into multiple data field lines as defined in the Server-Sent Events W3C recommendation. If data is not a String, it will be encoded into JSON.

参数:

data - the value of the data field

返回:

this builder

build

ServerSentEvent<T> build()

Builds the event.

返回:

the built event