程序包 cn.taketoday.web.handler.function

类 SseServerResponse.DefaultSseBuilder

java.lang.Object

cn.taketoday.web.handler.function.SseServerResponse.DefaultSseBuilder

所有已实现的接口:

ServerResponse.SseBuilder

封闭类:

SseServerResponse

private static final class SseServerResponse.DefaultSseBuilder
extends Object
implements ServerResponse.SseBuilder

字段概要

字段

修饰符和类型	字段	说明
private final StringBuilder	builder
private final DeferredResult<?>	deferredResult
private final List<HttpMessageConverter<?>>	messageConverters
private static final byte[]	NL_NL
private final RequestContext	request
private boolean	sendFailed

构造器概要

构造器

构造器	说明
DefaultSseBuilder(RequestContext request, ServerResponse.Context context, DeferredResult<?> deferredResult)

方法概要

修饰符和类型	方法	说明
private byte[]	builderBytes()
ServerResponse.SseBuilder	comment(String comment)	Add an SSE comment.
void	complete()	Completes the event stream.
void	data(Object object)	Add an SSE "data" line for the given object and sends the built server-sent event to the client.
void	data(Object object, MediaType mediaType)	Add an SSE "data" line for the given object and sends the built server-sent event to the client.
void	error(Throwable t)	Completes the event stream with the given error.
ServerResponse.SseBuilder	event(String eventName)	Add an SSE "event" line.
private ServerResponse.SseBuilder	field(String name, String value)
ServerResponse.SseBuilder	id(String id)	Add an SSE "id" line.
ServerResponse.SseBuilder	onComplete(Runnable onCompletion)	Register a callback to be invoked when the SSE request completes.
ServerResponse.SseBuilder	onError(Consumer<Throwable> onError)	Register a callback to be invoked when an error occurs during SSE processing.
ServerResponse.SseBuilder	onTimeout(Runnable onTimeout)	Register a callback to be invoked when an SSE request times out.
ServerResponse.SseBuilder	retry(Duration duration)	Add an SSE "retry" line.
void	send(Object object)	Sends the given object as a server-sent event.
private void	writeObject(Object data, MediaType mediaType)
private void	writeString(String string)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

NL_NL

private static final byte[] NL_NL

deferredResult

private final DeferredResult<?> deferredResult

messageConverters

private final List<HttpMessageConverter<?>> messageConverters

builder

private final StringBuilder builder

request

private final RequestContext request

sendFailed

private boolean sendFailed

构造器详细资料

DefaultSseBuilder

public DefaultSseBuilder(RequestContext request,
 ServerResponse.Context context,
 DeferredResult<?> deferredResult)

方法详细资料

send

public void send(Object object)
          throws IOException

从接口复制的说明: ServerResponse.SseBuilder

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 ServerResponse.SseBuilder.data(Object).

指定者:

send 在接口中 ServerResponse.SseBuilder

参数:

object - the object to send

抛出:

IOException - in case of I/O errors

id

public ServerResponse.SseBuilder id(String id)

从接口复制的说明: ServerResponse.SseBuilder

Add an SSE "id" line.

指定者:

id 在接口中 ServerResponse.SseBuilder

参数:

id - the event identifier

返回:

this builder

event

public ServerResponse.SseBuilder event(String eventName)

从接口复制的说明: ServerResponse.SseBuilder

Add an SSE "event" line.

指定者:

event 在接口中 ServerResponse.SseBuilder

参数:

eventName - the event name

返回:

this builder

retry

public ServerResponse.SseBuilder retry(Duration duration)

从接口复制的说明: ServerResponse.SseBuilder

Add an SSE "retry" line.

指定者:

retry 在接口中 ServerResponse.SseBuilder

参数:

duration - the duration to convert into millis

返回:

this builder

comment

public ServerResponse.SseBuilder comment(String comment)

从接口复制的说明: ServerResponse.SseBuilder

Add an SSE comment.

指定者:

comment 在接口中 ServerResponse.SseBuilder

参数:

comment - the comment

返回:

this builder

field

private ServerResponse.SseBuilder field(String name,
 String value)

data

public void data(Object object)
          throws IOException

从接口复制的说明: ServerResponse.SseBuilder

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.

指定者:

data 在接口中 ServerResponse.SseBuilder

参数:

object - the object to send as data

抛出:

IOException - in case of I/O errors

data

public void data(Object object,
 @Nullable
 MediaType mediaType)
          throws IOException

从接口复制的说明: ServerResponse.SseBuilder

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 your provided mediaType from message converters.

指定者:

data 在接口中 ServerResponse.SseBuilder

参数:

object - the object to send as data

抛出:

IOException - in case of I/O errors

writeString

private void writeString(String string)
                  throws IOException

抛出:

IOException

writeObject

private void writeObject(Object data,
 @Nullable
 MediaType mediaType)
                  throws IOException

抛出:

IOException

builderBytes

private byte[] builderBytes()

error

public void error(Throwable t)

从接口复制的说明: ServerResponse.SseBuilder

Completes the event stream with the given error.

The throwable is dispatched back into Web MVC, and passed to its exception handling mechanism. Since the response has been committed by this point, the response status can not change.

指定者:

error 在接口中 ServerResponse.SseBuilder

参数:

t - the throwable to dispatch

complete

public void complete()

从接口复制的说明: ServerResponse.SseBuilder

Completes the event stream.

指定者:

complete 在接口中 ServerResponse.SseBuilder

onTimeout

public ServerResponse.SseBuilder onTimeout(Runnable onTimeout)

从接口复制的说明: ServerResponse.SseBuilder

Register a callback to be invoked when an SSE request times out.

指定者:

onTimeout 在接口中 ServerResponse.SseBuilder

参数:

onTimeout - the callback to invoke on timeout

返回:

this builder

onError

public ServerResponse.SseBuilder onError(Consumer<Throwable> onError)

从接口复制的说明: ServerResponse.SseBuilder

Register a callback to be invoked when an error occurs during SSE processing.

指定者:

onError 在接口中 ServerResponse.SseBuilder

参数:

onError - the callback to invoke on error

返回:

this builder

onComplete

public ServerResponse.SseBuilder onComplete(Runnable onCompletion)

从接口复制的说明: ServerResponse.SseBuilder

Register a callback to be invoked when the SSE request completes.

指定者:

onComplete 在接口中 ServerResponse.SseBuilder

参数:

onCompletion - the callback to invoked on completion

返回:

this builder