类 ServerSentEventHttpMessageWriter

构造器详细资料

• ServerSentEventHttpMessageWriter

  public ServerSentEventHttpMessageWriter()

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

• ServerSentEventHttpMessageWriter

  public ServerSentEventHttpMessageWriter​(@Nullable
                                          Encoder<?> encoder)

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

  参数:

  encoder - the Encoder to use (may be null)

方法详细资料

• getEncoder

  @Nullable
  public Encoder<?> getEncoder()

  Return the configured Encoder, if any.

• getWritableMediaTypes

  public List<MediaType> getWritableMediaTypes()

  从接口复制的说明: HttpMessageWriter
  Return the MediaType's that this writer supports.

  指定者:

  getWritableMediaTypes 在接口中 HttpMessageWriter<Object>

• canWrite

  public boolean canWrite​(ResolvableType elementType,
                          @Nullable
                          MediaType mediaType)

  从接口复制的说明: HttpMessageWriter
  Whether the given object type is supported by this writer.

  指定者:

  canWrite 在接口中 HttpMessageWriter<Object>

  参数:

  elementType - the type of object to check

  mediaType - the media type for the write (possibly null)

  返回:

  true if writable, false otherwise

• write

  public reactor.core.publisher.Mono<Void> write​(org.reactivestreams.Publisher<?> input,
                                                 ResolvableType elementType,
                                                 @Nullable
                                                 MediaType mediaType,
                                                 ReactiveHttpOutputMessage message,
                                                 Map<String,​Object> hints)

  从接口复制的说明: HttpMessageWriter
  Write an given stream of object to the output message.

  指定者:

  write 在接口中 HttpMessageWriter<Object>

  参数:

  input - the objects to write

  elementType - the type of objects in the stream which must have been previously checked via HttpMessageWriter.canWrite(ResolvableType, MediaType)

  mediaType - the content type for the write (possibly null to indicate that the default content type of the writer must be used)

  message - the message to write to

  hints - additional information about how to encode and write

  返回:

  indicates completion or error

• write

  public reactor.core.publisher.Mono<Void> write​(org.reactivestreams.Publisher<?> input,
                                                 ResolvableType actualType,
                                                 ResolvableType elementType,
                                                 @Nullable
                                                 MediaType mediaType,
                                                 ServerHttpRequest request,
                                                 ServerHttpResponse response,
                                                 Map<String,​Object> hints)

  从接口复制的说明: HttpMessageWriter
  Server-side only alternative to HttpMessageWriter.write(Publisher, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map) with additional context available.

  指定者:

  write 在接口中 HttpMessageWriter<Object>

  actualType - the actual return type of the method that returned the value; for annotated controllers, the MethodParameter can be accessed via ResolvableType.getSource().

  elementType - the type of Objects in the input stream

  mediaType - the content type to use (possibly null indicating the default content type of the writer should be used)

  request - the current request

  response - the current response

  返回:

  a Mono that indicates completion of writing or error