Module io.helidon.webserver.sse

Package io.helidon.webserver.sse

Class SseSinkProvider

java.lang.Object

io.helidon.webserver.sse.SseSinkProvider

All Implemented Interfaces:

SinkProvider<SseEvent>

public class SseSinkProvider
extends Object
implements SinkProvider<SseEvent>

Sink provider for SSE type.

See Also:

• SinkProvider

Constructor Summary

Constructors

Constructor	Description
SseSinkProvider()

Method Summary

Modifier and Type	Method	Description
<X extends Sink<SseEvent>> X	create(ServerResponse response, BiConsumer<Object,MediaType> eventConsumer, Runnable closeRunnable)	Deprecated, for removal: This API element is subject to removal in a future version. replaced by create(SinkProviderContext)
<X extends Sink<SseEvent>> X	create(SinkProviderContext context)	Creates a Sink for SSE events.
boolean	supports(GenericType<? extends Sink<?>> type, ServerRequest request)	Checks if a provider supports the type.

Methods inherited from class java.lang.Object

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

Constructor Details

SseSinkProvider

public SseSinkProvider()

Method Details

supports

public boolean supports(GenericType<? extends Sink<?>> type,
 ServerRequest request)

Description copied from interface: SinkProvider

Checks if a provider supports the type.

Specified by:

supports in interface SinkProvider<SseEvent>

Parameters:

type - the type

request - the current request

Returns:

outcome of test

create

public <X extends Sink<SseEvent>> X create(SinkProviderContext context)

Creates a Sink for SSE events.

Specified by:

create in interface SinkProvider<SseEvent>

Type Parameters:

X - type of sink

Parameters:

context - the context

Returns:

newly created sink

create

@Deprecated(since="4.1.2",
            forRemoval=true)
public <X extends Sink<SseEvent>> X create(ServerResponse response,
 BiConsumer<Object,MediaType> eventConsumer,
 Runnable closeRunnable)

Deprecated, for removal: This API element is subject to removal in a future version.

replaced by create(SinkProviderContext)

Creates a Sink for SSE events.

Specified by:

create in interface SinkProvider<SseEvent>

Type Parameters:

X - type of sink

Parameters:

response - the HTTP response

eventConsumer - an event consumer

closeRunnable - a runnable to call on close

Returns:

newly created sink