类 ServerSentEventHttpMessageReader
- java.lang.Object
- org.springframework.http.codec.ServerSentEventHttpMessageReader
- 所有已实现的接口:
HttpMessageReader<Object>
public class ServerSentEventHttpMessageReader extends Object implements HttpMessageReader<Object>
Reader that supports a stream ofServerSentEvents
and also plainObjects
which is the same as anServerSentEvent
with data only.- 从以下版本开始:
- 5.0
- 作者:
- Sebastien Deleuze, Rossen Stoyanchev
构造器概要
构造器 构造器 说明 ServerSentEventHttpMessageReader()
Constructor without aDecoder
.ServerSentEventHttpMessageReader(Decoder<?> decoder)
Constructor with JSONDecoder
for decoding to Objects.
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 boolean
canRead(ResolvableType elementType, MediaType mediaType)
Whether the given object type is supported by this reader.Decoder<?>
getDecoder()
Return the configuredDecoder
.int
getMaxInMemorySize()
Return theconfigured
byte count limit.List<MediaType>
getReadableMediaTypes()
Return theMediaType
's that this reader supports.reactor.core.publisher.Flux<Object>
read(ResolvableType elementType, ReactiveHttpInputMessage message, Map<String,Object> hints)
Read from the input message and encode to a stream of objects.reactor.core.publisher.Mono<Object>
readMono(ResolvableType elementType, ReactiveHttpInputMessage message, Map<String,Object> hints)
Read from the input message and encode to a single object.void
setMaxInMemorySize(int byteCount)
Configure a limit on the maximum number of bytes per SSE event which are buffered before the event is parsed.从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
从接口继承的方法 org.springframework.http.codec.HttpMessageReader
read, readMono
构造器详细资料
ServerSentEventHttpMessageReader
public ServerSentEventHttpMessageReader()
Constructor without aDecoder
. In this mode onlyString
is supported as the data of an event.
ServerSentEventHttpMessageReader
public ServerSentEventHttpMessageReader(@Nullable Decoder<?> decoder)
Constructor with JSONDecoder
for decoding to Objects. Support for decoding toString
event data is built-in.
方法详细资料
getDecoder
@Nullable public Decoder<?> getDecoder()
Return the configuredDecoder
.
setMaxInMemorySize
public void setMaxInMemorySize(int byteCount)
Configure a limit on the maximum number of bytes per SSE event which are buffered before the event is parsed.Note that the
data decoder
, if provided, must also be customized accordingly to raise the limit if necessary in order to be able to parse the data portion of the event.By default this is set to 256K.
- 参数:
byteCount
- the max number of bytes to buffer, or -1 for unlimited- 从以下版本开始:
- 5.1.13
getMaxInMemorySize
public int getMaxInMemorySize()
Return theconfigured
byte count limit.- 从以下版本开始:
- 5.1.13
getReadableMediaTypes
public List<MediaType> getReadableMediaTypes()
从接口复制的说明:HttpMessageReader
Return theMediaType
's that this reader supports.- 指定者:
getReadableMediaTypes
在接口中HttpMessageReader<Object>
canRead
public boolean canRead(ResolvableType elementType, @Nullable MediaType mediaType)
从接口复制的说明:HttpMessageReader
Whether the given object type is supported by this reader.- 指定者:
canRead
在接口中HttpMessageReader<Object>
- 参数:
elementType
- the type of object to checkmediaType
- the media type for the read (possiblynull
)- 返回:
true
if readable,false
otherwise
read
public reactor.core.publisher.Flux<Object> read(ResolvableType elementType, ReactiveHttpInputMessage message, Map<String,Object> hints)
从接口复制的说明:HttpMessageReader
Read from the input message and encode to a stream of objects.- 指定者:
read
在接口中HttpMessageReader<Object>
- 参数:
elementType
- the type of objects in the stream which must have been previously checked viaHttpMessageReader.canRead(ResolvableType, MediaType)
message
- the message to read fromhints
- additional information about how to read and decode the input- 返回:
- the decoded stream of elements
readMono
public reactor.core.publisher.Mono<Object> readMono(ResolvableType elementType, ReactiveHttpInputMessage message, Map<String,Object> hints)
从接口复制的说明:HttpMessageReader
Read from the input message and encode to a single object.- 指定者:
readMono
在接口中HttpMessageReader<Object>
- 参数:
elementType
- the type of objects in the stream which must have been previously checked viaHttpMessageReader.canRead(ResolvableType, MediaType)
message
- the message to read fromhints
- additional information about how to read and decode the input- 返回:
- the decoded object