Module io.inverno.mod.web.server

Package io.inverno.mod.web.server

Interface WebResponseBody.SseEncoder.Event<A>

Type Parameters:

A - the type of data to encode

All Superinterfaces:

OutboundData<A>, OutboundDataEncoder<A>, ResponseBody.Sse.Event<A>

Enclosing interface:

WebResponseBody.SseEncoder<A>

public static interface WebResponseBody.SseEncoder.Event<A>
extends ResponseBody.Sse.Event<A>, OutboundDataEncoder<A>

A server-sent event with data encoding support.

Since:

1.0

Author:

Jeremy Kuhn

Method Summary

Modifier and Type	Method	Description
WebResponseBody.SseEncoder.Event<A>	comment(String comment)	Sets the event comment.
WebResponseBody.SseEncoder.Event<A>	event(String event)	Sets the type of event.
WebResponseBody.SseEncoder.Event<A>	id(String id)	Sets the event id.

Methods inherited from interface io.inverno.mod.http.base.OutboundData

stream, value

Methods inherited from interface io.inverno.mod.web.base.OutboundDataEncoder

many, many, one, one

Method Details

id

WebResponseBody.SseEncoder.Event<A> id(String id)

Description copied from interface: ResponseBody.Sse.Event

Sets the event id.

Specified by:

id in interface ResponseBody.Sse.Event<A>

Parameters:

id - an id

Returns:

the event

comment

WebResponseBody.SseEncoder.Event<A> comment(String comment)

Description copied from interface: ResponseBody.Sse.Event

Sets the event comment.

Specified by:

comment in interface ResponseBody.Sse.Event<A>

Parameters:

comment - a comment

Returns:

the event

event

WebResponseBody.SseEncoder.Event<A> event(String event)

Description copied from interface: ResponseBody.Sse.Event

Sets the type of event.

Specified by:

event in interface ResponseBody.Sse.Event<A>

Parameters:

event - an event type

Returns:

the event