Package org.apache.juneau.marshall.sse

package org.apache.juneau.marshall.sse

Server-Sent Events (SSE) marshalling support — text/event-stream.

Provides SseSerializer and SseParser for the WHATWG Server-Sent Events wire format. The serializer accepts a single SseEvent, an Iterable, a Stream, or an SseEvent[] array and emits one event per element with a flush() after each one — that is what makes server push actually work behind SerializedPojoProcessor.

SSE streams are typically long-lived. For true line-driven streaming over a Reader that the caller owns, use the SseEventReader iterator.

See Also:

• WHATWG HTML §9.2 — Server-sent events
• SSE

Related Packages

Package	Description
org.apache.juneau.marshall	Marshalling API

Classes

Class	Description
SseEvent	Represents a single Server-Sent Event (SSE) frame on the wire.
SseEventReader	Line-driven Iterator over the events in a text/event-stream.
SseParser	Parses text/event-stream input (WHATWG Server-Sent Events) into Java objects.
SseParser.Builder	Builder class.
SseParserSession	Session object that lives for the duration of a single use of SseParser.
SseParserSession.Builder	Builder class.
SseSerializer	Serializes SseEvent objects to the text/event-stream wire format defined by the WHATWG Server-Sent Events spec.
SseSerializer.Builder	Builder class.
SseSerializerSession	Session object that lives for the duration of a single use of SseSerializer.
SseSerializerSession.Builder	Builder class.